Class: UrlTile

Subclasses

• TileImage
• VectorTile

Extends

• TileSource

Methods

changed() inherited

Observable.js, line 68

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

clear() inherited

source/Tile.js, line 344

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	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(){Attribution} inherited

source/Source.js, line 132

Get the attribution function for the source.

Returns:

Attribution function.

getAttributionsCollapsible(){boolean} inherited

source/Source.js, line 140

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(){Projection | null} inherited

source/Source.js, line 149

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 79

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

Returns:

Revision.

getState(){State} inherited

source/Source.js, line 173

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

Returns:

State.

getTileGrid(){TileGrid | null} inherited

source/Tile.js, line 266

Return the tile grid of the tile source.

Returns:

Tile grid.

getTileLoadFunction(){LoadFunction}

source/UrlTile.js, line 101

Return the tile load function of the source.

Returns:

TileLoadFunction

getTileUrlFunction(){UrlFunction}

source/UrlTile.js, line 110

Return the tile URL function of the source.

Returns:

TileUrlFunction

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

source/UrlTile.js, line 123

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){EventsKey | Array<EventsKey>} inherited

Observable.js, line 152

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){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

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 195

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

set(key, value, silent) inherited

Object.js, line 207

Sets a value.

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

setAttributions(attributions) inherited

source/Source.js, line 206

Set the attributions of the source.

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

setProperties(values, silent) inherited

Object.js, line 227

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 | undefined	Update without triggering an event.

setTileLoadFunction(tileLoadFunction)

source/UrlTile.js, line 159

Set the tile load function of the source.

Name	Type	Description
tileLoadFunction	LoadFunction	Tile load function.

setTileUrlFunction(tileUrlFunction, key)

source/UrlTile.js, line 171

Set the tile URL function of the source.

Name	Type	Description
tileUrlFunction	UrlFunction	Tile URL function.
key	string | undefined	Optional new tile key for the source.

setUrl(url)

source/UrlTile.js, line 186

Set the URL to use for requests.

Name	Type	Description
url	string	URL.

setUrls(urls)

source/UrlTile.js, line 197

Set the URLs to use for requests.

Name	Type	Description
urls	Array.<string>	URLs.

un(type, listener) inherited

Observable.js, line 173

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, silent) inherited

Object.js, line 251

Unsets a property.

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