Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MapboxTileSource

MapboxTileSource is a subclass of TileSource that creates and manages a single tile layer to be used with an MapboxMapStrategy.

export

Hierarchy

Implements

Index

Constructors

constructor

Properties

code

code: string

Optional dataSource

dataSource: ITileDataSource

The receiver's data source.

memberof

TileSource

enabled

enabled: boolean

Whether the data source is enabled.

memberof

TileSource

isAnimationFrame

isAnimationFrame: boolean = false

key

key: string

Data key associated with the data source.

memberof

TileSource

Accessors

animation

identifier

  • get identifier(): string
  • set identifier(value: string): void
  • Identifier associated with the data source.

    memberof

    TileSource

    Returns string

  • Identifier associated with the data source.

    memberof

    TileSource

    Parameters

    • value: string

    Returns void

overlay

  • get overlay(): TileLayer
  • Returns TileLayer

service

timestamp

  • set timestamp(value: Date): void
  • Parameters

    • value: Date

    Returns void

url

  • get url(): string
  • Tile template URL

    Returns string

Methods

animationLayerForDate

canShow

  • canShow(): boolean
  • Returns boolean

destroy

  • destroy(): void
  • Returns void

has

  • has(type: string): boolean
  • Returns whether the listeners are registered for the specified event name.

    memberof

    EventDispatcher

    Parameters

    • type: string

    Returns boolean

hide

  • hide(): void
  • Hides the layer associated with the source.

    memberof

    MapboxTileSource

    Returns void

isAnimating

  • isAnimating(): boolean
  • Returns boolean

isAnimationActive

  • isAnimationActive(): boolean

isFuture

  • isFuture(): boolean
  • Returns boolean

isVisible

  • isVisible(): boolean
  • Returns whether the source is currently visible.

    memberof

    TileSource

    Returns boolean

off

  • Removes a registered listener function for the specified event.

    memberof

    EventDispatcher

    Parameters

    • type: string

      Name of the event to remove the listener for.

    • callback: Function

      Handler function to remove so it won't be executed next time the event is triggered.

    • Default value scope: any = null

    Returns EventDispatcher

offAll

on

  • on(type: string, callback: Function, scope?: any, priority?: number): EventDispatcher
  • Registers a listener function to be executed each time an event occurs

    memberof

    EventDispatcher

    Parameters

    • type: string

      Name of the event to listen for. Value can contain multiple event names separated by spaces to trigger the same handler function for each event name.

    • callback: Function

      Handler function to be called when the event occurs

    • Default value scope: any = null
    • Default value priority: number = 0

    Returns EventDispatcher

once

  • once(type: string, callback: Function, scope?: any, priority?: number): EventDispatcher
  • Registers a listener function to be executed the first time an event occurs.

    memberof

    EventDispatcher

    Parameters

    • type: string

      Name of the event to listen for. Value can contain multiple event names separated by spaces to trigger the same handler function for each event name.

    • callback: Function

      Handler function to be called when the event occurs

    • Default value scope: any = null
    • Default value priority: number = 0

    Returns EventDispatcher

remove

  • remove(): void
  • Flags the source for removal from the managing map strategy.

    memberof

    MapboxTileSource

    Returns void

setOpacity

  • setOpacity(value: number, update?: boolean): void
  • Changes the opacity of source's layer.

    memberof

    MapboxTileSource

    Parameters

    • value: number
    • Default value update: boolean = true

    Returns void

setOrder

  • setOrder(value: number): void
  • Changes the z-index of the source's layer.

    memberof

    MapboxTileSource

    Parameters

    • value: number

    Returns void

show

  • show(): void
  • Shows the layer associated with the source.

    memberof

    MapboxTileSource

    Returns void

trigger

  • Triggers the specified event so that all registered listeners will be executed with the specified parameters.

    memberof

    EventDispatcher

    Parameters

    • type: any

      Event name to trigger

    • Default value data: any = null

    Returns EventDispatcher

updateVisibility

  • updateVisibility(): void

urlTemplate

  • urlTemplate(): string
  • Returns the url template string to use for tile requests based on the current timestamp.

    Returns string

Generated using TypeDoc