Interface: GenericMapSharedCanvasSubLayerProps<M>
Component props for GenericMapSharedCanvasSubLayer.
Type parameters
| Name |
|---|
M |
Hierarchy
MapSharedCanvasSubLayerProps<M>↳
GenericMapSharedCanvasSubLayerProps
Properties
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
MapSharedCanvasSubLayerProps.children
Defined in
src/sdk/components/FSComponent.ts:122
model
• model: MapModel<M>
A map model.
Inherited from
MapSharedCanvasSubLayerProps.model
Defined in
src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:165
onAttached
• Optional onAttached: (projection: MapProjection, display: MapSharedCanvasInstance) => void
A function which will be called when the sublayer is attached to its parent layer.
Type declaration
▸ (projection, display): void
A function which will be called when the sublayer is attached to its parent layer.
Parameters
| Name | Type |
|---|---|
projection | MapProjection |
display | MapSharedCanvasInstance |
Returns
void
Defined in
src/sdk/components/map/layers/GenericMapSharedCanvasSubLayer.ts:12
onDestroyed
• Optional onDestroyed: () => void
A function which will be called when the sublayer is destroyed.
Type declaration
▸ (): void
A function which will be called when the sublayer is destroyed.
Returns
void
Defined in
src/sdk/components/map/layers/GenericMapSharedCanvasSubLayer.ts:34
onSleep
• Optional onSleep: (projection: MapProjection, display: MapSharedCanvasInstance) => void
A function which will be called when the sublayer is put to sleep.
Type declaration
▸ (projection, display): void
A function which will be called when the sublayer is put to sleep.
Parameters
| Name | Type |
|---|---|
projection | MapProjection |
display | MapSharedCanvasInstance |
Returns
void
Defined in
src/sdk/components/map/layers/GenericMapSharedCanvasSubLayer.ts:18
onUpdated
• Optional onUpdated: (projection: MapProjection, display: MapSharedCanvasInstance, time: number, elapsed: number) => void
A function which will be called once every update cycle after the sublayer's shared canvas instance has had a chance to be invalidated.
Type declaration
▸ (projection, display, time, elapsed): void
A function which will be called once every update cycle after the sublayer's shared canvas instance has had a chance to be invalidated.
Parameters
| Name | Type |
|---|---|
projection | MapProjection |
display | MapSharedCanvasInstance |
time | number |
elapsed | number |
Returns
void
Defined in
src/sdk/components/map/layers/GenericMapSharedCanvasSubLayer.ts:31
onVisibilityChanged
• Optional onVisibilityChanged: (isVisible: boolean) => void
A function which will be called when the sublayer's visibility changes.
Type declaration
▸ (isVisible): void
A function which will be called when the sublayer's visibility changes.
Parameters
| Name | Type |
|---|---|
isVisible | boolean |
Returns
void
Defined in
src/sdk/components/map/layers/GenericMapSharedCanvasSubLayer.ts:9
onWake
• Optional onWake: (projection: MapProjection, display: MapSharedCanvasInstance) => void
A function which will be called when the sublayer is awakened.
Type declaration
▸ (projection, display): void
A function which will be called when the sublayer is awakened.
Parameters
| Name | Type |
|---|---|
projection | MapProjection |
display | MapSharedCanvasInstance |
Returns
void
Defined in
src/sdk/components/map/layers/GenericMapSharedCanvasSubLayer.ts:15
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
MapSharedCanvasSubLayerProps.ref
Defined in
src/sdk/components/FSComponent.ts:125
shouldInvalidate
• Optional shouldInvalidate: (projection: MapProjection, display: MapSharedCanvasInstance, time: number, elapsed: number) => boolean
A function which will be called at the beginning of every update cycle to check whether the sublayer's shared canvas instance should be invalidated. If the canvas is already invalidated, then this function will not be called.
Type declaration
▸ (projection, display, time, elapsed): boolean
A function which will be called at the beginning of every update cycle to check whether the sublayer's shared canvas instance should be invalidated. If the canvas is already invalidated, then this function will not be called.
Parameters
| Name | Type |
|---|---|
projection | MapProjection |
display | MapSharedCanvasInstance |
time | number |
elapsed | number |
Returns
boolean
Defined in
src/sdk/components/map/layers/GenericMapSharedCanvasSubLayer.ts:25