Skip to main content

Interface: MapGenericLayerProps<M>

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:8

Component props for MapGenericLayer.

Extends

Type Parameters

Type Parameter
M

Properties

children?

optional children: DisplayChildren[]

Defined in: src/sdk/components/FSComponent.ts:122

The children of the display component.

Inherited from

MapLayerProps.children


class?

optional class: string | SubscribableSet<string>

Defined in: src/sdk/components/map/MapLayer.ts:25

The CSS class(es) to apply to the root of this layer.

Inherited from

MapLayerProps.class


mapProjection

mapProjection: MapProjection

Defined in: src/sdk/components/map/MapLayer.ts:15

A map projection model.

Inherited from

MapLayerProps.mapProjection


model

model: MapModel<M>

Defined in: src/sdk/components/map/MapLayer.ts:12

A map model.

Inherited from

MapLayerProps.model


onAttached()?

optional onAttached: (layer) => void

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:13

A function to be called when the layer is attached to a map.

Parameters

ParameterType
layerMapGenericLayer<M>

Returns

void


onDetached()?

optional onDetached: (layer) => void

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:28

A function to be called when the layer is detached from a map.

Parameters

ParameterType
layerMapGenericLayer<M>

Returns

void


onMapProjectionChanged()?

optional onMapProjectionChanged: (layer, mapProjection, changeFlags) => void

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:22

A function to be called when the projection of the layer's parent map changes.

Parameters

ParameterType
layerMapGenericLayer<M>
mapProjectionMapProjection
changeFlagsnumber

Returns

void


onSleep()?

optional onSleep: (layer) => void

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:19

A function to be called when the layer is put to sleep.

Parameters

ParameterType
layerMapGenericLayer<M>

Returns

void


onUpdated()?

optional onUpdated: (layer, time, elapsed) => void

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:25

A function to be called when the layer updates.

Parameters

ParameterType
layerMapGenericLayer<M>
timenumber
elapsednumber

Returns

void


onVisibilityChanged()?

optional onVisibilityChanged: (layer, isVisible) => void

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:10

A function to be called when the layer's visibility changes.

Parameters

ParameterType
layerMapGenericLayer<M>
isVisibleboolean

Returns

void


onWake()?

optional onWake: (layer) => void

Defined in: src/sdk/components/map/layers/MapGenericLayer.tsx:16

A function to be called when the layer is awakened.

Parameters

ParameterType
layerMapGenericLayer<M>

Returns

void


ref?

optional ref: NodeReference<any>

Defined in: src/sdk/components/FSComponent.ts:125

A reference to the display component.

Inherited from

MapLayerProps.ref


updateFreq?

optional updateFreq: Subscribable<number>

Defined in: src/sdk/components/map/MapLayer.ts:22

A subscribable which provides the maximum update frequency of the layer, in hertz. Note that the actual update frequency will not exceed the update frequency of the layer's parent map. If not defined, the frequency will default to that of the layer's parent map.

Inherited from

MapLayerProps.updateFreq