Class: UTFGrid

ol/source/UTFGrid~UTFGrid 


import UTFGrid from 'ol/source/UTFGrid';

Layer source for UTFGrid interaction data loaded from TileJSON format.

new UTFGrid(options)

source/UTFGrid.js, line 280
Name Type Description
options

Source options.

Name Type Default Description
preemptive boolean true

If true the UTFGrid 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.
jsonp boolean false

Use JSONP with callback to load the TileJSON. Useful when the server does not support CORS..
tileJSON module:ol/source/TileJSON~Config

TileJSON configuration for this source. If not provided, url must be configured.
url string

TileJSON endpoint that provides the configuration for this source. Request will be made through JSONP. If not provided, tileJSON must be configured.
Fires:

Extends

Methods

changed() inherited

Observable.js, line 36

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

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 82

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 | module:ol/events/Event~Event | string

Event object.
Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

forDataAtCoordinateAndResolution(coordinate, resolution, callback, opt_request)

source/UTFGrid.js, line 387

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 module:ol/coordinate~Coordinate

Coordinate.
resolution number

Resolution.
callback function

Callback.
request boolean

If true the callback is always async. The tile data is requested if not yet loaded.

get(key){*} inherited

Object.js, line 119

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getKeys(){Array.<string>} inherited

Object.js, line 132

Get a list of object property names.

Returns:
List of property names.

getProjection(){module:ol/proj/Projection~Projection} inherited

source/Source.js, line 119

Get the projection of the source.

Returns:
Projection.

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

Object.js, line 141

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 47

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

getState(){module:ol/source/State} inherited

source/Source.js, line 136

Get the state of the source, see module:ol/source/State~State for possible states.

Returns:
State.

getTemplate(){string|undefined}

source/UTFGrid.js, line 371

Return the template from TileJSON.

Returns:
The template from TileJSON.

getTileGrid(){module:ol/tilegrid/TileGrid~TileGrid} inherited

source/Tile.js, line 213

Return the tile grid of the tile source.

Returns:
Tile grid.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 60

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.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 82

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.

refresh() inherited

source/Source.js, line 151

Refreshes the source and finally dispatches a 'change' event.

set(key, value, opt_silent) inherited

Object.js, line 164

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setAttributions(attributions) inherited

source/Source.js, line 162

Set the attributions of the source.

Name Type Description
attributions module:ol/source/Source~AttributionLike | undefined

Attributions. Can be passed as string, Array<string>, module:ol/source/Source&tilde;Attribution, or undefined.

setProperties(values, opt_silent) inherited

Object.js, line 183

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) inherited

Observable.js, line 101

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.

unset(key, opt_silent) inherited

Object.js, line 195

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.