Class MapboxPolygonLayer

Hierarchy

MapboxLayer<MapboxPolygonLayerOptions, Layer>
MaplibreLayer<MapboxPolygonLayerOptions, MaplibreLayerType>
- MapboxPolygonLayer

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new MapboxPolygonLayer(layer: string, polygons: PolygonDef[], opts?: MapboxPolygonLayerOptions, id?: string): MapboxPolygonLayer

Overrides MapLayer.constructor
- Defined in src/maps/interactive/strategies/mapbox/layers/PolygonLayer.ts:14
Parameters
- layer: string
- polygons: PolygonDef[]
- Default value opts: MapboxPolygonLayerOptions = {}
- Default value id: string = undefined
Returns MapboxPolygonLayer

Properties

data

data: Record<string, any>

enabled

enabled: boolean

id

id: string

source

source: any

Accessors

isHidden

get isHidden(): boolean

Inherited from MapLayer.isHidden

Overrides MapLayer.isHidden
- Defined in src/maps/interactive/layers/MapLayer.ts:93
Returns whether the layer is currently hidden.

readonly

memberof

MapLayer

Returns boolean

layerId

get layerId(): string

Inherited from MapLayer.layerId

Overrides MapLayer.layerId
- Defined in src/maps/interactive/layers/MapLayer.ts:48
Layer identifier on the map.

readonly

memberof

MapLayer

Returns string

map

get map(): Map

Inherited from MapLayer.map

Overrides MapLayer.map
- Defined in src/maps/interactive/layers/MapLayer.ts:60
Map currently associated with the layer.

readonly

memberof

MapLayer

Returns Map

opacity

get opacity(): number

Inherited from MapLayer.opacity

Overrides MapLayer.opacity
- Defined in src/maps/interactive/layers/MapLayer.ts:82
Returns the current layer opacity.

readonly

memberof

MapLayer

Returns number

opts

get opts(): MapboxPolygonLayerOptions

Inherited from MapLayer.opts

Overrides MapLayer.opts
- Defined in src/maps/interactive/layers/MapLayer.ts:37
Returns MapboxPolygonLayerOptions

parentId

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

Inherited from MapboxLayer.parentId

Overrides MaplibreLayer.parentId
- Defined in src/maps/interactive/strategies/mapbox/layers/Layer.ts:33
The parent layer identifier for the layer, if any. When specified, this layer will be rendered on the map below the layer associated with the parent identifier.

memberof

Layer

Returns string
Inherited from MapboxLayer.parentId

Overrides MaplibreLayer.parentId
- Defined in src/maps/interactive/strategies/mapbox/layers/Layer.ts:37
The parent layer identifier for the layer, if any. When specified, this layer will be rendered on the map below the layer associated with the parent identifier.

memberof

Layer

Parameters
- value: string
Returns void

renderable

get renderable(): Layer

Inherited from MapLayer.renderable

Overrides MapLayer.renderable
- Defined in src/maps/interactive/layers/MapLayer.ts:71
Native map object(s) that gets rendered to the map.

readonly

memberof

MapLayer

Returns Layer

sourceId

get sourceId(): string

Inherited from MapboxLayer.sourceId

Overrides MaplibreLayer.sourceId
- Defined in src/maps/interactive/strategies/mapbox/layers/Layer.ts:22
Source identifier on the map.

readonly

memberof

Layer

Returns string

strokeLayerId

get strokeLayerId(): string

- Defined in src/maps/interactive/strategies/maplibre/layers/PolygonLayer.ts:26
Returns string

Methods

addTo

addTo(map: Map): void

Overrides MapLayer.addTo
- Defined in src/maps/interactive/strategies/mapbox/layers/PolygonLayer.ts:26
Parameters
- map: Map
Returns void

exists

exists(): boolean

Inherited from MapboxLayer.exists

Overrides MapLayer.exists
- Defined in src/maps/interactive/strategies/mapbox/layers/Layer.ts:69
Returns boolean

has

has(type: string): boolean

Inherited from EventDispatcher.has

Overrides 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

Inherited from MapLayer.hide

Overrides MapLayer.hide
- Defined in src/maps/interactive/layers/MapLayer.ts:143
Hides the layer on the map.

memberof

MapLayer

Returns void

invalidate

invalidate(): void

Overrides MapboxLayer.invalidate
- Defined in src/maps/interactive/strategies/mapbox/layers/PolygonLayer.ts:63
Returns void

off

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

Inherited from EventDispatcher.off

Overrides 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

Overrides 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

Overrides 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

Overrides 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

Overrides MapLayer.remove
- Defined in src/maps/interactive/strategies/mapbox/layers/PolygonLayer.ts:50
Returns void

setOpacity

setOpacity(value: number): void

Inherited from MapboxLayer.setOpacity

Overrides MapLayer.setOpacity
- Defined in src/maps/interactive/strategies/mapbox/layers/Layer.ts:41
Parameters
- value: number
Returns void

setZIndex

setZIndex(value: number): void

Inherited from MapboxLayer.setZIndex

Overrides MapLayer.setZIndex
- Defined in src/maps/interactive/strategies/mapbox/layers/Layer.ts:53
Parameters
- value: number
Returns void

show

show(): void

Inherited from MapLayer.show

Overrides MapLayer.show
- Defined in src/maps/interactive/layers/MapLayer.ts:133
Shows the layer on the map.

memberof

MapLayer

Returns void

trigger

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

Inherited from EventDispatcher.trigger

Overrides 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

Generated using TypeDoc