Class VectorTile<FeatureType>

Type Parameters

  • FeatureType extends FeatureLike

Hierarchy (view full)

Constructors

constructor

Properties

disposed extent interpolate key projection resolution state tileCoord

Methods

addEventListener changed dispatchEvent dispose disposeInternal endTransition getAlpha getFeatures getFormat getKey getListeners getState getTileCoord getTileUrl hasListener inTransition load onError onLoad release removeEventListener setFeatures setLoader setState

Constructors

constructor

  • new VectorTile<FeatureType>(tileCoord, state, src, format, tileLoadFunction, options?): external.ol.VectorTile<FeatureType>

  • Type Parameters

    • FeatureType extends FeatureLike

    Parameters

    • tileCoord: TileCoord

      Tile coordinate.

    • state: any

      State.

    • src: string

      Data source url.

    • format: FeatureFormat<FeatureType>

      Feature format.

    • tileLoadFunction: LoadFunction

      Tile load function.

    • Optionaloptions: Options

      Tile options.

    Returns external.ol.VectorTile<FeatureType>

Properties

Protecteddisposed

disposed: boolean

The object has already been disposed.

extent

extent: Extent

Extent of this tile; set by the source.

interpolate

interpolate: boolean

key

key: string

A key assigned to the tile. This is used in conjunction with a source key to determine if a cached version of this tile may be used by the renderer.

projection

projection: Projection

Feature projection of this tile; set by the source.

resolution

resolution: number

Resolution of this tile; set by the source.

Protectedstate

state: any

tileCoord

tileCoord: TileCoord

Methods

addEventListener

  • addEventListener(type, listener): void

  • Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

Protectedchanged

  • changed(): void
  • Protected

    Returns void

dispatchEvent

  • dispatchEvent(event): undefined | boolean

  • 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

    • event: string | BaseEvent

      Event object.

    Returns undefined | boolean

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

    Api

dispose

  • dispose(): void

  • Clean up.

    Returns void

ProtecteddisposeInternal

  • disposeInternal(): void
  • Protected

    Extension point for disposable objects.

    Returns void

endTransition

  • endTransition(id): void

  • Mark a transition as complete.

    Parameters

    • id: string

      An id for the renderer.

    Returns void

getAlpha

  • getAlpha(id, time): number

  • Get the alpha value for rendering.

    Parameters

    • id: string

      An id for the renderer.

    • time: number

      The render frame time.

    Returns number

    A number between 0 and 1.

getFeatures

  • getFeatures(): FeatureType[]

  • Get the features for this tile. Geometries will be in the view projection.

    Returns FeatureType[]

    Features.

    Api

getFormat

  • getFormat(): FeatureFormat<FeatureType>

  • Get the feature format assigned for reading this tile's features.

    Returns FeatureFormat<FeatureType>

    Feature format.

    Api

getKey

  • getKey(): string

  • Returns string

    Key.

getListeners

  • getListeners(type): undefined | Listener[]

  • Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.

    Parameters

    • type: string

      Type.

    Returns undefined | Listener[]

    Listeners.

getState

  • getState(): any

  • Returns any

    State.

getTileCoord

  • getTileCoord(): TileCoord

  • Get the tile coordinate for this tile.

    Returns TileCoord

    The tile coordinate.

    Api

getTileUrl

  • getTileUrl(): string

  • Returns string

    Tile url.

hasListener

  • hasListener(type?): boolean

  • Parameters

    • Optionaltype: string

      Type. If not provided, true will be returned if this event target has any listeners.

    Returns boolean

    Has listeners.

inTransition

  • inTransition(id): boolean

  • Determine if a tile is in an alpha transition. A tile is considered in transition if tile.getAlpha() has not yet been called or has been called and returned 1.

    Parameters

    • id: string

      An id for the renderer.

    Returns boolean

    The tile is in transition.

Abstractload

  • load(): void

  • Load the image or retry if loading previously failed. Loading is taken care of by the tile queue, and calling this method is only needed for preloading or for reloading in case of an error.

    Returns void

    Api

onError

  • onError(): void

  • Handler for tile load errors.

    Returns void

onLoad

  • onLoad(features, dataProjection): void

  • Handler for successful tile load.

    Parameters

    • features: FeatureType[]

      The loaded features.

    • dataProjection: Projection

      Data projection.

    Returns void

release

  • release(): void

  • Called by the tile cache when the tile is removed from the cache due to expiry

    Returns void

removeEventListener

  • removeEventListener(type, listener): void

  • Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

setFeatures

  • setFeatures(features): void

  • Function for use in a module:ol/source/VectorTile~VectorTile's tileLoadFunction. Sets the features for the tile.

    Parameters

    Returns void

    Api

setLoader

  • setLoader(loader): void

  • Set the feature loader for reading this tile's features.

    Parameters

    Returns void

    Api

setState

  • setState(state): void

  • Sets the state of this tile. If you write your own module:ol/Tile~LoadFunction tileLoadFunction , it is important to set the state correctly to module:ol/TileState~ERROR when the tile cannot be loaded. Otherwise the tile cannot be removed from the tile queue and will block other requests.

    Parameters

    • state: any

      State.

    Returns void

    Api

Settings

Member Visibility

On This Page

Constructors
Properties
Methods