Class: TileUTFGrid

ol.source.TileUTFGrid

Layer source for UTFGrid interaction data loaded from TileJSON format.

new ol.source.TileUTFGrid(options) experimental

Name Type Description
options

Source options.

Name Type Description
preemptive boolean | undefined experimental

If true the TileUTFGrid source loads the tiles based on their "visibility". This improves the speed of response, but increases traffic. Note that if set to false, you need to pass true as opt_request to the forDataAtCoordinateAndResolution method otherwise no data will ever be loaded. Default is true.

url string experimental
Fires:
  • change experimental - Triggered when the revision counter is increased.
  • propertychange (ol.ObjectEvent) - Triggered when a property is changed.

Extends

Methods

changed() inherited experimental

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

forDataAtCoordinateAndResolution(coordinate, resolution, callback, opt_this, opt_request) experimental

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.

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

Get the attributions of the source.

Returns:
Attributions.

getKeys(){Array.<string>} inherited

Get a list of object property names.

Returns:
List of property names.

Get the logo of the source.

Returns:
Logo.

Get the projection of the source.

Returns:
Projection.

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

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

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 ol.source.State for possible states.

Returns:
State.

getTemplate(){string|undefined} experimental

Return the template from TileJSON.

Returns:
The template from TileJSON.

Return the tile grid of the tile source.

Returns:
Tile grid.

on(type, listener, opt_this){goog.events.Key} inherited

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 in listener.

Returns:
Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited

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 in listener.

Returns:
Unique key for the listener.

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

setAttributions(attributions) inherited experimental

Set the attributions of the source.

Name Type Description
attributions Array.<ol.Attribution>

Attributions.

setProperties(values) inherited

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.

un(type, listener, opt_this) inherited

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 the listener.

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name Type Description
key goog.events.Key

The key returned by on() or once().

Unsets a property.

Name Type Description
key string

Key name.