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)

Name Type Description
preemptive boolean (defaults to 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 (lazy loading), you need to pass true as request to the forDataAtCoordinateAndResolution method otherwise no data will ever be loaded.

jsonp boolean (defaults to false)

Use JSONP with callback to load the TileJSON. Useful when the server does not support CORS..

tileJSON Config | undefined

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

url string | undefined

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

zDirection number | NearestDirectionFunction (defaults to 0)

Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See getZForResolution.

Fires:

Extends

Methods

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

Remove all cached tiles from the source. The next render cycle will fetch new tiles.

dispatchEvent(event){boolean | undefined} inherited

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 BaseEvent | 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, request)

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 Coordinate

Coordinate.

resolution number

Resolution.

callback function

Callback.

request boolean | undefined

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 attribution function for the source.

Returns:
Attribution function.

getAttributionsCollapsible(){boolean} inherited

Returns:
Attributions are collapsible.

getKeys(){Array.<string>} inherited

Get a list of object property names.

Returns:
List of property names.

getProjection(){Projection | null} inherited

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

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

Returns:
State.

getTemplate(){string | undefined}

Return the template from TileJSON.

Returns:
The template from TileJSON.

getTileGrid(){TileGrid | null} inherited

Return the tile grid of the tile source.

Returns:
Tile grid.

on(type, listener){EventsKey | Array<EventsKey>} 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.

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){EventsKey | Array<EventsKey>} 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.

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.

Refreshes the source. The source will be cleared, and data from the server will be reloaded.

set(key, value, silent) inherited

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

silent boolean | undefined

Update without triggering an event.

setAttributions(attributions) inherited

Set the attributions of the source.

Name Type Description
attributions AttributionLike | undefined

Attributions. Can be passed as string, Array<string>, Attribution, or undefined.

setProperties(values, silent) 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.

silent boolean | undefined

Update without triggering an event.

un(type, listener) 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.

unset(key, silent) inherited

Unsets a property.

Name Type Description
key string

Key name.

silent boolean | undefined

Unset without triggering an event.