Skip to main content

Interface: HorizonCanvasLayerProps

Defined in: src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:8

Properties for a MapCanvasLayer.

Extends​

Properties​

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

HorizonLayerProps.children

class?​

optional class: string | SubscribableSet<string>

Defined in: src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:13

CSS class(es) to apply to the canvas element.

projection​

projection: HorizonProjection

Defined in: src/sdk/components/horizon/HorizonLayer.ts:10

The layer's horizon projection.

Inherited from​

HorizonLayerProps.projection

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

HorizonLayerProps.ref

updateFreq?​

optional updateFreq: Subscribable<number>

Defined in: src/sdk/components/horizon/HorizonLayer.ts:17

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​

HorizonLayerProps.updateFreq

useBuffer?​

optional useBuffer: boolean

Defined in: src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:10

Whether to include an offscreen buffer. False by default.