Skip to main content

Interface: HorizonComponentProps

Defined in: src/sdk/components/horizon/HorizonComponent.tsx:14

Component props for HorizonComponent.

Extends​

Properties​

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

ComponentProps.children

class?​

optional class: string | SubscribableSet<string>

Defined in: src/sdk/components/horizon/HorizonComponent.tsx:34

CSS class(es) to apply to the root of the horizon component.

fov​

fov: number | Subscribable<number>

Defined in: src/sdk/components/horizon/HorizonComponent.tsx:19

The field of view, in degrees, of the horizon component's projected window.

fovEndpoints?​

optional fovEndpoints: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

Defined in: src/sdk/components/horizon/HorizonComponent.tsx:25

The projected endpoints at which to measure the field of view as [x1, y1, x2, y2] with each component expressed relative to the width or height of the projected window. Defaults to [0.5, 0, 0.5, 1].

projectedOffset?​

optional projectedOffset: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

Defined in: src/sdk/components/horizon/HorizonComponent.tsx:28

The projected offset of the center of the projection, as [x, y] in pixels. Defaults to [0, 0].

projectedSize​

projectedSize: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

Defined in: src/sdk/components/horizon/HorizonComponent.tsx:16

The size, as [width, height] in pixels, of the horizon component's projected window.

projection?​

optional projection: HorizonProjection

Defined in: src/sdk/components/horizon/HorizonComponent.tsx:31

A projection to inject. A default will be used if none is provided.

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

ComponentProps.ref