Skip to main content

Interface: MapSyncedCanvasLayerProps<M>

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

Component props for MapSyncedCanvasLayer.

Extends​

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​

MapCanvasLayerProps.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​

MapCanvasLayerProps.class

collapseOnSleep?​

optional collapseOnSleep: boolean

Defined in: src/sdk/components/map/layers/MapSyncedCanvasLayer.ts:16

Whether the layer should automatically collapse its canvas elements (the display canvas and the buffer canvas, if it exists) to zero size (0px by 0px) when the map is asleep. Collapsing the canvas elements will free memory used by the canvas textures. It will also clear everything drawn to the canvases and reset their context states. Defaults to false.

mapProjection​

mapProjection: MapProjection

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

A map projection model.

Inherited from​

MapCanvasLayerProps.mapProjection

model​

model: MapModel<M>

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

A map model.

Inherited from​

MapCanvasLayerProps.model

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

MapCanvasLayerProps.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​

MapCanvasLayerProps.updateFreq

useBuffer?​

optional useBuffer: boolean

Defined in: src/sdk/components/map/layers/MapCanvasLayer.tsx:9

Whether to include an offscreen buffer. False by default.

Inherited from​

MapCanvasLayerProps.useBuffer