Interface: MapGenericLayerProps<M>
Component props for MapGenericLayer.
Type parameters
| Name |
|---|
M |
Hierarchy
↳
MapGenericLayerProps
Properties
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:122
class
• Optional class: string | SubscribableSet<string>
The CSS class(es) to apply to the root of this layer.
Inherited from
Defined in
src/sdk/components/map/MapLayer.ts:25
mapProjection
• mapProjection: MapProjection
A map projection model.
Inherited from
Defined in
src/sdk/components/map/MapLayer.ts:15
model
• model: MapModel<M>
A map model.
Inherited from
Defined in
src/sdk/components/map/MapLayer.ts:12
onAttached
• Optional onAttached: (layer: MapGenericLayer<M>) => void
A function to be called when the layer is attached to a map.
Type declaration
▸ (layer): void
A function to be called when the layer is attached to a map.
Parameters
| Name | Type |
|---|---|
layer | MapGenericLayer<M> |
Returns
void
Defined in
src/sdk/components/map/layers/MapGenericLayer.tsx:13
onDetached
• Optional onDetached: (layer: MapGenericLayer<M>) => void
A function to be called when the layer is detached from a map.
Type declaration
▸ (layer): void
A function to be called when the layer is detached from a map.
Parameters
| Name | Type |
|---|---|
layer | MapGenericLayer<M> |
Returns
void
Defined in
src/sdk/components/map/layers/MapGenericLayer.tsx:28
onMapProjectionChanged
• Optional onMapProjectionChanged: (layer: MapGenericLayer<M>, mapProjection: MapProjection, changeFlags: number) => void
A function to be called when the projection of the layer's parent map changes.
Type declaration
▸ (layer, mapProjection, changeFlags): void
A function to be called when the projection of the layer's parent map changes.
Parameters
| Name | Type |
|---|---|
layer | MapGenericLayer<M> |
mapProjection | MapProjection |
changeFlags | number |
Returns
void
Defined in
src/sdk/components/map/layers/MapGenericLayer.tsx:22
onSleep
• Optional onSleep: (layer: MapGenericLayer<M>) => void
A function to be called when the layer is put to sleep.
Type declaration
▸ (layer): void
A function to be called when the layer is put to sleep.
Parameters
| Name | Type |
|---|---|
layer | MapGenericLayer<M> |
Returns
void
Defined in
src/sdk/components/map/layers/MapGenericLayer.tsx:19
onUpdated
• Optional onUpdated: (layer: MapGenericLayer<M>, time: number, elapsed: number) => void
A function to be called when the layer updates.
Type declaration
▸ (layer, time, elapsed): void
A function to be called when the layer updates.
Parameters
| Name | Type |
|---|---|
layer | MapGenericLayer<M> |
time | number |
elapsed | number |
Returns
void
Defined in
src/sdk/components/map/layers/MapGenericLayer.tsx:25
onVisibilityChanged
• Optional onVisibilityChanged: (layer: MapGenericLayer<M>, isVisible: boolean) => void
A function to be called when the layer's visibility changes.
Type declaration
▸ (layer, isVisible): void
A function to be called when the layer's visibility changes.
Parameters
| Name | Type |
|---|---|
layer | MapGenericLayer<M> |
isVisible | boolean |
Returns
void
Defined in
src/sdk/components/map/layers/MapGenericLayer.tsx:10
onWake
• Optional onWake: (layer: MapGenericLayer<M>) => void
A function to be called when the layer is awakened.
Type declaration
▸ (layer): void
A function to be called when the layer is awakened.
Parameters
| Name | Type |
|---|---|
layer | MapGenericLayer<M> |
Returns
void
Defined in
src/sdk/components/map/layers/MapGenericLayer.tsx:16
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:125
updateFreq
• Optional updateFreq: Subscribable<number>
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
Defined in
src/sdk/components/map/MapLayer.ts:22