Interface: GenericMapSharedCanvasSubLayerProps<M>

Defined in: src/sdk/components/map/layers/GenericMapSharedCanvasSubLayer.ts:7

Component props for GenericMapSharedCanvasSubLayer.

Extends

• MapSharedCanvasSubLayerProps<M>

Type Parameters

Type Parameter
M

Properties

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

MapSharedCanvasSubLayerProps.children

---

model

model: MapModel<M>

Defined in: src/sdk/components/map/layers/MapSharedCanvasLayer.tsx:187

A map model.

Inherited from

MapSharedCanvasSubLayerProps.model

---

onAttached()?

optional onAttached: (projection, display) => void

Defined in: src/sdk/components/map/layers/GenericMapSharedCanvasSubLayer.ts:12

A function which will be called when the sublayer is attached to its parent layer.

Parameters

Parameter	Type
projection	MapProjection
display	MapSharedCanvasInstance

Returns

void

---

onDestroyed()?

optional onDestroyed: () => void

Defined in: src/sdk/components/map/layers/GenericMapSharedCanvasSubLayer.ts:34

A function which will be called when the sublayer is destroyed.

Returns

void

---

onSleep()?

optional onSleep: (projection, display) => void

Defined in: src/sdk/components/map/layers/GenericMapSharedCanvasSubLayer.ts:18

A function which will be called when the sublayer is put to sleep.

Parameters

Parameter	Type
projection	MapProjection
display	MapSharedCanvasInstance

Returns

void

---

onUpdated()?

optional onUpdated: (projection, display, time, elapsed) => void

Defined in: src/sdk/components/map/layers/GenericMapSharedCanvasSubLayer.ts:31

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

Parameter	Type
projection	MapProjection
display	MapSharedCanvasInstance
time	number
elapsed	number

Returns

void

---

onVisibilityChanged()?

optional onVisibilityChanged: (isVisible) => void

Defined in: src/sdk/components/map/layers/GenericMapSharedCanvasSubLayer.ts:9

A function which will be called when the sublayer's visibility changes.

Parameters

Parameter	Type
isVisible	boolean

Returns

void

---

onWake()?

optional onWake: (projection, display) => void

Defined in: src/sdk/components/map/layers/GenericMapSharedCanvasSubLayer.ts:15

A function which will be called when the sublayer is awakened.

Parameters

Parameter	Type
projection	MapProjection
display	MapSharedCanvasInstance

Returns

void

---

ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

MapSharedCanvasSubLayerProps.ref

---

shouldInvalidate()?

optional shouldInvalidate: (projection, display, time, elapsed) => boolean

Defined in: src/sdk/components/map/layers/GenericMapSharedCanvasSubLayer.ts:25

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

Parameter	Type
projection	MapProjection
display	MapSharedCanvasInstance
time	number
elapsed	number

Returns

boolean