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
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
mapProjection
mapProjection:
MapProjection
Defined in: src/sdk/components/map/MapLayer.ts:15
A map projection model.
Inherited from
model
model:
MapModel
<M
>
Defined in: src/sdk/components/map/MapLayer.ts:12
A map model.
Inherited from
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
Parameter | Type |
---|---|
layer | MapGenericLayer <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
Parameter | Type |
---|---|
layer | MapGenericLayer <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
Parameter | Type |
---|---|
layer | MapGenericLayer <M > |
mapProjection | MapProjection |
changeFlags | number |
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
Parameter | Type |
---|---|
layer | MapGenericLayer <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
Parameter | Type |
---|---|
layer | MapGenericLayer <M > |
time | number |
elapsed | number |
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
Parameter | Type |
---|---|
layer | MapGenericLayer <M > |
isVisible | boolean |
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
Parameter | Type |
---|---|
layer | MapGenericLayer <M > |
Returns
void
ref?
optional
ref:NodeReference
<any
>
Defined in: src/sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
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.