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 state of the source changes.

Extends

Methods

changed() inherited experimental

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

Fires:
  • change experimental

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.

Returns:
Attributions.
Returns:
Logo.
Returns:
Projection.

getRevision(){number} inherited experimental

Returns:
Revision.
Returns:
State.

getTemplate(){string|undefined} experimental

Returns:
The template from TileJSON.
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.

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().