Class MapboxTileSource

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

export

Hierarchy

TileSource
- MapboxTileSource

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new MapboxTileSource(key: string, service: MapRequest, opts?: TileSourceOptions): MapboxTileSource

Overrides TileSource.constructor
- Defined in src/maps/interactive/strategies/mapbox/sources/MapboxTileSource.ts:19
Parameters
- key: string
- service: MapRequest
- Optional opts: TileSourceOptions
Returns MapboxTileSource

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

get animation(): TileAnimation | ImageAnimation

Inherited from TileSource.animation
- Defined in src/maps/interactive/sources/TileSource.ts:178
Returns the animation associated with the static layer.

Returns TileAnimation | ImageAnimation

identifier

get identifier(): string
set identifier(value: string): void

Inherited from TileSource.identifier
- Defined in src/maps/interactive/sources/TileSource.ts:144
Identifier associated with the data source.

memberof

TileSource

Returns string
Inherited from TileSource.identifier
- Defined in src/maps/interactive/sources/TileSource.ts:148
Identifier associated with the data source.

memberof

TileSource

Parameters
- value: string
Returns void

overlay

get overlay(): TileLayer

Overrides TileSource.overlay
- Defined in src/maps/interactive/strategies/mapbox/sources/MapboxTileSource.ts:62
Returns TileLayer

service

get service(): MapRequest

Inherited from TileSource.service
- Defined in src/maps/interactive/sources/TileSource.ts:171
Returns MapRequest

timestamp

set timestamp(value: Date): void

Overrides TileSource.timestamp
- Defined in src/maps/interactive/strategies/mapbox/sources/MapboxTileSource.ts:66
Parameters
- value: Date
Returns void

url

get url(): string

Inherited from TileSource.url
- Defined in src/maps/interactive/sources/TileSource.ts:153
Tile template URL

Returns string

Methods

animationLayerForDate

animationLayerForDate(animation: TileAnimation, date: Date, wait?: boolean): Promise<TiledLayer>

Implementation of TileAnimationProvider.animationLayerForDate

Overrides TileSource.animationLayerForDate
- Defined in src/maps/interactive/strategies/mapbox/sources/MapboxTileSource.ts:173
Animation Providers

Parameters
- animation: TileAnimation
- date: Date
- Default value wait: boolean = true
Returns Promise<TiledLayer>

canShow

canShow(): boolean

Inherited from TileSource.canShow
- Defined in src/maps/interactive/sources/TileSource.ts:210
Returns boolean

destroy

destroy(): void

Inherited from TileSource.destroy
- Defined in src/maps/interactive/sources/TileSource.ts:273
Returns void

has

has(type: string): boolean

Inherited from EventDispatcher.has
- Defined in src/event/EventDispatcher.ts:230
Returns whether the listeners are registered for the specified event name.

memberof

EventDispatcher

Parameters
- type: string
Returns boolean

hide

hide(): void

Implementation of TiledLayer.hide

Overrides TileSource.hide
- Defined in src/maps/interactive/strategies/mapbox/sources/MapboxTileSource.ts:105
Hides the layer associated with the source.

memberof

MapboxTileSource

Returns void

isAnimating

isAnimating(): boolean

Inherited from TileSource.isAnimating
- Defined in src/maps/interactive/sources/TileSource.ts:225
Returns boolean

isAnimationActive

isAnimationActive(): boolean

Inherited from TileSource.isAnimationActive
- Defined in src/maps/interactive/sources/TileSource.ts:221
Returns boolean

isFuture

isFuture(): boolean

Inherited from TileSource.isFuture
- Defined in src/maps/interactive/sources/TileSource.ts:198
Returns boolean

isVisible

isVisible(): boolean

Implementation of TiledLayer.isVisible

Inherited from TileSource.isVisible
- Defined in src/maps/interactive/sources/TileSource.ts:253
Returns whether the source is currently visible.

memberof

TileSource

Returns boolean

off

off(type: string, callback: Function, scope?: any): EventDispatcher

Inherited from EventDispatcher.off
- Defined in src/event/EventDispatcher.ts:124
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

offAll(): EventDispatcher

Inherited from EventDispatcher.offAll
- Defined in src/event/EventDispatcher.ts:150
Returns EventDispatcher

on

on(type: string, callback: Function, scope?: any, priority?: number): EventDispatcher

Inherited from EventDispatcher.on
- Defined in src/event/EventDispatcher.ts:38
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

Inherited from EventDispatcher.once
- Defined in src/event/EventDispatcher.ts:91
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

Implementation of TiledLayer.remove

Overrides TileSource.remove
- Defined in src/maps/interactive/strategies/mapbox/sources/MapboxTileSource.ts:123
Flags the source for removal from the managing map strategy.

memberof

MapboxTileSource

Returns void

setOpacity

setOpacity(value: number, update?: boolean): void

Overrides TileSource.setOpacity
- Defined in src/maps/interactive/strategies/mapbox/sources/MapboxTileSource.ts:133
Changes the opacity of source's layer.

memberof

MapboxTileSource

Parameters
- value: number
- Default value update: boolean = true
Returns void

setOrder

setOrder(value: number): void

Overrides TileSource.setOrder
- Defined in src/maps/interactive/strategies/mapbox/sources/MapboxTileSource.ts:152
Changes the z-index of the source's layer.

memberof

MapboxTileSource

Parameters
- value: number
Returns void

show

show(): void

Implementation of TiledLayer.show

Overrides TileSource.show
- Defined in src/maps/interactive/strategies/mapbox/sources/MapboxTileSource.ts:89
Shows the layer associated with the source.

memberof

MapboxTileSource

Returns void

trigger

trigger(type: any, data?: any): EventDispatcher

Inherited from EventDispatcher.trigger
- Defined in src/event/EventDispatcher.ts:164
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

Inherited from TileSource.updateVisibility
- Defined in src/maps/interactive/sources/TileSource.ts:202
Returns void

urlTemplate

urlTemplate(): string

Inherited from TileSource.urlTemplate
- Defined in src/maps/interactive/sources/TileSource.ts:185
Returns the url template string to use for tile requests based on the current timestamp.

Returns string

Generated using TypeDoc