Class: Source

Subclasses

• ol.source.Image
• ol.source.Tile
• ol.source.Vector

Extends

• ol.Object

Methods

changed() inherited

src/ol/observable.js, line 58

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event) inherited

src/ol/observable.js, line 75

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name	Type	Description
event	Object | ol.events.Event | string	Event object.

get(key){*} inherited

src/ol/object.js, line 101

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getAttributions(){Array.<ol.Attribution>}

src/ol/source/source.js, line 144

Get the attributions of the source.

Returns:

Attributions.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 115

Get a list of object property names.

Returns:

List of property names.

getLogo(){string|olx.LogoOptions|undefined}

src/ol/source/source.js, line 163

Get the logo of the source.

Returns:

Logo.

getProjection(){ol.proj.Projection}

src/ol/source/source.js, line 173

Get the projection of the source.

Returns:

Projection.

getProperties(){Object.<string, *>} inherited

src/ol/object.js, line 125

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited

src/ol/observable.js, line 84

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

getState(){ol.source.State}

src/ol/source/source.js, line 190

Get the state of the source, see ol.source.State for possible states.

Returns:

State.

on(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 99

Listen for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.
this	Object	The object to use as this in listener.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 124

Listen once for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.
this	Object	The object to use as this in listener.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

refresh()

src/ol/source/source.js, line 207

Refreshes the source and finally dispatches a 'change' event.

set(key, value, opt_silent) inherited

src/ol/object.js, line 150

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.
silent	boolean	Update without triggering an event.

setAttributions(attributions)

src/ol/source/source.js, line 219

Set the attributions of the source.

Name	Type	Description
attributions	ol.AttributionLike | undefined	Attributions. Can be passed as string, Array<string>, ol.Attribution2, or undefined.

setProperties(values, opt_silent) inherited

src/ol/object.js, line 170

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name	Type	Description
values	Object.<string, *>	Values.
silent	boolean	Update without triggering an event.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 147

Unlisten for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.
this	Object	The object which was used as this by the listener.

unset(key, opt_silent) inherited

src/ol/object.js, line 184

Unsets a property.

Name	Type	Description
key	string	Key name.
silent	boolean	Unset without triggering an event.