Class: UrlTile

Subclasses

• module:ol/source/TileImage~TileImage
• module:ol/source/VectorTile~VectorTile

Extends

• module:ol/source/Tile~TileSource

Methods

changed() inherited

Observable.js, line 70

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

clear() inherited

source/Tile.js, line 336

Remove all cached tiles from the source. The next render cycle will fetch new tiles.

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 85

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	module:ol/events/Event~BaseEvent | string	Event object.

Returns:

false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited

Object.js, line 135

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getAttributions(){module:ol/source/Source~Attribution} inherited

source/Source.js, line 100

Get the attribution function for the source.

Returns:

Attribution function.

getAttributionsCollapsible(){boolean} inherited

source/Source.js, line 108

Returns:

Attributions are collapsible.

getKeys(){Array.<string>} inherited

Object.js, line 148

Get a list of object property names.

Returns:

List of property names.

getProjection(){module:ol/proj/Projection~Projection} inherited

source/Source.js, line 117

Get the projection of the source.

Returns:

Projection.

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

Object.js, line 157

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited

Observable.js, line 81

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

Returns:

Revision.

getState(){module:ol/source/State} inherited

source/Source.js, line 134

Get the state of the source, see module:ol/source/State~State for possible states.

Returns:

State.

getTileGrid(){module:ol/tilegrid/TileGrid~TileGrid} inherited

source/Tile.js, line 256

Return the tile grid of the tile source.

Returns:

Tile grid.

getTileLoadFunction(){module:ol/Tile~LoadFunction}

source/UrlTile.js, line 98

Return the tile load function of the source.

Returns:

TileLoadFunction

getTileUrlFunction(){module:ol/Tile~UrlFunction}

source/UrlTile.js, line 107

Return the tile URL function of the source.

Returns:

TileUrlFunction

getUrls(){!Array.<string>|null}

source/UrlTile.js, line 120

Return the URLs used for this source. When a tileUrlFunction is used instead of url or urls, null will be returned.

Returns:

URLs.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 155

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.

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){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 167

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.

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() inherited

source/Source.js, line 156

Refreshes the source. The source will be cleared, and data from the server will be reloaded.

set(key, value, opt_silent) inherited

Object.js, line 203

Sets a value.

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

setAttributions(attributions) inherited

source/Source.js, line 167

Set the attributions of the source.

Name	Type	Description
attributions	module:ol/source/Source~AttributionLike | undefined	Attributions. Can be passed as string, Array<string>, module:ol/source/Source~Attribution, or undefined.

setProperties(values, opt_silent) inherited

Object.js, line 223

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.

setTileLoadFunction(tileLoadFunction)

source/UrlTile.js, line 156

Set the tile load function of the source.

Name	Type	Description
tileLoadFunction	module:ol/Tile~LoadFunction	Tile load function.

setTileUrlFunction(tileUrlFunction, key)

source/UrlTile.js, line 168

Set the tile URL function of the source.

Name	Type	Description
tileUrlFunction	module:ol/Tile~UrlFunction	Tile URL function.
key	string	Optional new tile key for the source.

setUrl(url)

source/UrlTile.js, line 183

Set the URL to use for requests.

Name	Type	Description
url	string	URL.

setUrls(urls)

source/UrlTile.js, line 194

Set the URLs to use for requests.

Name	Type	Description
urls	Array.<string>	URLs.

un(type, listener) inherited

Observable.js, line 176

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.

unset(key, opt_silent) inherited

Object.js, line 247

Unsets a property.

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