-
Name Type Description projection
ProjectionLike (defaults to 'EPSG:3857') Optional projection.
tileGrid
TileGrid | undefined Tile grid.
wrapX
boolean (defaults to true) Whether to wrap the world horizontally.
zDirection
number | NearestDirectionFunction (defaults to 0) Set to
1
when debuggingVectorTile
sources with a default configuration. Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. SeegetZForResolution
.template
string (defaults to 'z:{z} x:{x} y:{y}') Template for labeling the tiles. Should include
{x}
,{y}
or{-y}
, and{z}
placeholders.Fires:
-
change
(BaseEvent) - Generic change event. Triggered when the revision counter is increased. -
error
(BaseEvent) - Generic error event. Triggered when an error occurs. -
propertychange
(ObjectEvent) - Triggered when a property is changed. -
tileloadend
(TileSourceEvent) - Triggered when a tile finishes loading, either when its data is loaded, or when loading was aborted because the tile is no longer needed. -
tileloaderror
(TileSourceEvent) - Triggered if tile loading results in an error. Note that this is not the right place to re-fetch tiles. Seeload
for details. -
tileloadstart
(TileSourceEvent) - Triggered when a tile starts loading.
-
Extends
Methods
-
Increases the revision counter and dispatches a 'change' event.
-
Remove all cached tiles from the source. The next render cycle will fetch new tiles.
-
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.
-
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
Get the attribution function for the source.
Returns:
Attribution function.
-
Returns:
Attributions are collapsible.
-
Get a list of object property names.
Returns:
List of property names.
-
Get the projection of the source.
Returns:
Projection.
-
Get an object of all property names and values.
Returns:
Object.
-
Get the version number for this object. Each time the object is modified, its version number will be incremented.
Returns:
Revision.
-
Get the state of the source, see
State
for possible states.Returns:
State.
-
Return the tile grid of the tile source.
Returns:
Tile grid.
-
Return the tile load function of the source.
Returns:
TileLoadFunction
-
Return the tile URL function of the source.
Returns:
TileUrlFunction
-
Return the URLs used for this source. When a tileUrlFunction is used instead of url or urls, null will be returned.
Returns:
URLs.
-
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.
-
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.
-
Refreshes the source. The source will be cleared, and data from the server will be reloaded.
-
Sets a value.
Name Type Description key
string Key name.
value
* Value.
silent
boolean | undefined Update without triggering an event.
-
Set the attributions of the source.
Name Type Description attributions
AttributionLike | undefined Attributions. Can be passed as
string
,Array<string>
,Attribution
, orundefined
. -
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.
-
Sets whether to render reprojection edges or not (usually for debugging).
Name Type Description render
boolean Render the edges.
-
Sets the tile grid to use when reprojecting the tiles to the given projection instead of the default tile grid for the projection.
This can be useful when the default tile grid cannot be created (e.g. projection has no extent defined) or for optimization reasons (custom tile size, resolutions, ...).
Name Type Description projection
ProjectionLike Projection.
tilegrid
TileGrid Tile grid to use for the projection.
-
Set the tile load function of the source.
Name Type Description tileLoadFunction
LoadFunction Tile load function.
-
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.
-
Set the URL to use for requests.
Name Type Description url
string URL.
-
Set the URLs to use for requests.
Name Type Description urls
Array.<string> URLs.
-
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.
-
Unsets a property.
Name Type Description key
string Key name.
silent
boolean | undefined Unset without triggering an event.