Skip to main content

Interface: HorizonCanvasLayerProps

Properties for a MapCanvasLayer.

Hierarchy

Properties

children

Optional children: DisplayChildren[]

The children of the display component.

Inherited from

HorizonLayerProps.children

Defined in

src/sdk/components/FSComponent.ts:122


class

Optional class: string | SubscribableSet<string>

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

Defined in

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


projection

projection: HorizonProjection

The layer's horizon projection.

Inherited from

HorizonLayerProps.projection

Defined in

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


ref

Optional ref: NodeReference<any>

A reference to the display component.

Inherited from

HorizonLayerProps.ref

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

HorizonLayerProps.updateFreq

Defined in

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


useBuffer

Optional useBuffer: boolean

Whether to include an offscreen buffer. False by default.

Defined in

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