new ol.source.TileUTFGrid(options) experimental
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Source options.
|
Fires:
-
change
experimental - Triggered when the revision counter is increased. -
propertychange
(ol.ObjectEvent) - Triggered when a property is changed.
Extends
Methods
-
changed() inherited experimental
src/ol/observable.js, line 57 -
Increases the revision counter and dispatches a 'change' event.
-
dispatchEvent(event) inherited experimental
src/ol/observable.js, line 81 -
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.
-
forDataAtCoordinateAndResolution(coordinate, resolution, callback, opt_this, opt_request) experimental
src/ol/source/tileutfgridsource.js, line 86 -
Calls the callback (synchronously by default) with the available data for given coordinate and resolution (or
null
if not yet loaded or in case of an error).Name Type Description coordinate
ol.Coordinate Coordinate.
resolution
number Resolution.
callback
function Callback.
this
T The object to use as
this
in the callback.request
boolean If
true
the callback is always async. The tile data is requested if not yet loaded. -
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 134 -
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 144 -
Get the logo of the source.
Returns:
Logo.
-
getProjection(){ol.proj.Projection} inherited experimental
src/ol/source/source.js, line 154 -
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 90 -
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 170 -
Get the state of the source, see
ol.source.State
for possible states.Returns:
State.
-
getTemplate(){string|undefined} experimental
src/ol/source/tileutfgridsource.js, line 68 -
Return the template from TileJSON.
Returns:
The template from TileJSON.
-
getTileGrid(){ol.tilegrid.TileGrid} inherited
src/ol/source/tilesource.js, line 211 -
Return the tile grid of the tile source.
Returns:
Tile grid.
-
on(type, listener, opt_this){ol.events.Key|Array.<ol.events.Key>} inherited
src/ol/observable.js, line 105 -
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.events.Key|Array.<ol.events.Key>} inherited
src/ol/observable.js, line 130 -
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 187 -
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 199 -
Set the attributions of the source.
Name Type Description attributions
Attributions. Can be passed as
string
,Array<string>
,
,ol.Attribution
Array<
orol.Attribution
>undefined
.Type Description -
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.
-
un(type, listener, opt_this) inherited
src/ol/observable.js, line 153 -
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 174 -
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.events.Key | Array.<ol.events.Key> 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.