new ol.source.VectorTile(options) experimental
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Vector tile options.
|
Fires:
-
change
(ol.events.Event) experimental - Generic change event. Triggered when the revision counter is increased. -
propertychange
(ol.ObjectEvent) - Triggered when a property is changed. -
tileloadend
(ol.source.Tile.Event) - Triggered when a tile finishes loading. -
tileloaderror
(ol.source.Tile.Event) - Triggered if tile loading results in an error. -
tileloadstart
(ol.source.Tile.Event) - Triggered when a tile starts loading.
Extends
Methods
-
changed() inherited experimental
src/ol/observable.js, line 58 -
Increases the revision counter and dispatches a 'change' event.
-
dispatchEvent(event) inherited experimental
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 148 -
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
getAttributions(){Array.<ol.Attribution>} inherited
src/ol/source/source.js, line 111 -
Get the attributions of the source.
Returns:
Attributions.
-
getKeys(){Array.<string>} inherited
src/ol/object.js, line 162 -
Get a list of object property names.
Returns:
List of property names.
-
getLogo(){string|olx.LogoOptions|undefined} inherited
src/ol/source/source.js, line 121 -
Get the logo of the source.
Returns:
Logo.
-
getProjection(){ol.proj.Projection} inherited experimental
src/ol/source/source.js, line 131 -
Get the projection of the source.
Returns:
Projection.
-
getProperties(){Object.<string, *>} inherited
src/ol/object.js, line 172 -
Get an object of all property names and values.
Returns:
Object.
-
getRevision(){number} inherited experimental
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} inherited experimental
src/ol/source/source.js, line 148 -
Get the state of the source, see
ol.source.State
for possible states.Returns:
State.
-
getTileGrid(){ol.tilegrid.TileGrid} inherited
src/ol/source/tile.js, line 210 -
Return the tile grid of the tile source.
Returns:
Tile grid.
-
getTileLoadFunction(){ol.TileLoadFunctionType} inherited experimental
src/ol/source/urltile.js, line 77 -
Return the tile load function of the source.
Returns:
TileLoadFunction
-
getTileUrlFunction(){ol.TileUrlFunctionType} inherited experimental
src/ol/source/urltile.js, line 87 -
Return the tile URL function of the source.
Returns:
TileUrlFunction
-
getUrls(){!Array.<string>|null} inherited experimental
src/ol/source/urltile.js, line 99 -
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, 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
inlistener
.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
inlistener
.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 experimental
src/ol/source/source.js, line 165 -
Refreshes the source and finally dispatches a 'change' event.
-
set(key, value, opt_silent) inherited
src/ol/object.js, line 197 -
Sets a value.
Name Type Description key
string Key name.
value
* Value.
silent
boolean Update without triggering an event.
-
setAttributions(attributions) inherited experimental
src/ol/source/source.js, line 177 -
Set the attributions of the source.
Name Type Description attributions
ol.AttributionLike | undefined Attributions. Can be passed as
string
,Array<string>
,
,ol.Attribution
Array<
orol.Attribution
>undefined
. -
setProperties(values, opt_silent) inherited
src/ol/object.js, line 217 -
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) inherited experimental
src/ol/source/urltile.js, line 135 -
Set the tile load function of the source.
Name Type Description tileLoadFunction
ol.TileLoadFunctionType Tile load function.
-
setTileUrlFunction(tileUrlFunction, opt_key) inherited experimental
src/ol/source/urltile.js, line 148 -
Set the tile URL function of the source.
Name Type Description tileUrlFunction
ol.TileUrlFunctionType Tile URL function.
key
string Optional new tile key for the source.
-
setUrl(url) inherited
src/ol/source/urltile.js, line 163 -
Set the URL to use for requests.
Name Type Description url
string URL.
-
setUrls(urls) inherited
src/ol/source/urltile.js, line 176 -
Set the URLs to use for requests.
Name Type Description urls
Array.<string> URLs.
-
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 thelistener
. -
unByKey(key) inherited
src/ol/observable.js, line 168 -
Removes an event listener using the key returned by
on()
oronce()
. Note that using theol.Observable.unByKey
static function is to be preferred.Name Type Description key
ol.EventsKey | Array.<ol.EventsKey> The key returned by
on()
oronce()
(or an array of keys). -
unset(key, opt_silent) inherited
src/ol/object.js, line 231 -
Unsets a property.
Name Type Description key
string Key name.
silent
boolean Unset without triggering an event.