Class TileUTFGrid

Classdesc

Layer source for UTFGrid interaction data loaded from TileJSON format.

Param: options

Source options.

Api

Hierarchy

Constructors

constructor

Methods

changed dispatchEvent forDataAtCoordinateAndResolution get getAttributions getKeys getLogo getProjection getProperties getRevision getState getTemplate getTileGrid on once refresh set setAttributions setProperties un unByKey unset unByKey

Constructors

constructor

Methods

changed

  • changed(): void

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

    Returns void

    Api

dispatchEvent

  • dispatchEvent(event): void

  • 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.

    Parameters

    Returns void

    Function

    Api

forDataAtCoordinateAndResolution

  • forDataAtCoordinateAndResolution<T>(coordinate, resolution, callback, opt_this?, opt_request?): void

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

    Type Parameters

    • T

    Parameters

    • coordinate: Coordinate

      Coordinate.

    • resolution: number

      Resolution.

    • callback: ((d) => any)

      Callback.

        • (d): any

        • Parameters

          • d: any

          Returns any

    • Optional opt_this: T

      The object to use as this in the callback.

    • Optional opt_request: boolean

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

    Returns void

    Api

get

  • get(key): any

  • Gets a value.

    Parameters

    • key: string

      Key name.

    Returns any

    Value.

    Api

    stable

getAttributions

getKeys

  • getKeys(): string[]

  • Get a list of object property names.

    Returns string[]

    List of property names.

    Api

    stable

getLogo

  • getLogo(): string | LogoOptions

  • Get the logo of the source.

    Returns string | LogoOptions

    Logo.

    Api

    stable

getProjection

getProperties

  • getProperties(): {
        [k: string]: any;
    }

  • Get an object of all property names and values.

    Returns {
        [k: string]: any;
    }

    Object.

    • [k: string]: any

    Api

    stable

getRevision

  • getRevision(): number

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

    Returns number

    Revision.

    Api

getState

getTemplate

  • getTemplate(): string

  • Return the template from TileJSON.

    Returns string

    The template from TileJSON.

    Api

getTileGrid

  • getTileGrid(): TileGrid

  • Return the tile grid of the tile source.

    Returns TileGrid

    Tile grid.

    Api

    stable

on

  • on(type, listener, opt_this?): Object | Object[]

  • Listen for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object to use as this in listener.

    Returns Object | Object[]

    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.

    Api

    stable

once

  • once(type, listener, opt_this?): Object | Object[]

  • Listen once for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object to use as this in listener.

    Returns Object | Object[]

    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.

    Api

    stable

refresh

  • refresh(): void

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

    Returns void

    Api

set

  • set(key, value, opt_silent?): void

  • Sets a value.

    Parameters

    • key: string

      Key name.

    • value: any

      Value.

    • Optional opt_silent: boolean

      Update without triggering an event.

    Returns void

    Api

    stable

setAttributions

  • setAttributions(attributions): void

  • Set the attributions of the source.

    Parameters

    • attributions: AttributionLike

      Attributions. Can be passed as string, Array<string>, {@link ol.Attribution}, Array<{@link ol.Attribution}> or undefined.

    Returns void

    Api

setProperties

  • setProperties(values, opt_silent?): void

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

    Parameters

    • values: {
          [k: string]: any;
      }

      Values.

      • [k: string]: any
    • Optional opt_silent: boolean

      Update without triggering an event.

    Returns void

    Api

    stable

un

  • un(type, listener, opt_this?): void

  • Unlisten for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object which was used as this by the listener.

    Returns void

    Api

    stable

unByKey

  • unByKey(key): void

  • 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.

    Parameters

    • key: Object | Object[]

      The key returned by on() or once() (or an array of keys).

    Returns void

    Function

    Api

    stable

unset

  • unset(key, opt_silent?): void

  • Unsets a property.

    Parameters

    • key: string

      Key name.

    • Optional opt_silent: boolean

      Unset without triggering an event.

    Returns void

    Api

    stable

Static unByKey

  • unByKey(key): void

  • Removes an event listener using the key returned by on() or once().

    Parameters

    • key: Object | Object[]

      The key returned by on() or once() (or an array of keys).

    Returns void

    Api

    stable

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc