Interface: HorizonComponentProps
Component props for HorizonComponent.
Hierarchy
↳
HorizonComponentProps
Properties
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:122
class
• Optional class: string | SubscribableSet<string>
CSS class(es) to apply to the root of the horizon component.
Defined in
src/sdk/components/horizon/HorizonComponent.tsx:34
fov
• fov: number | Subscribable<number>
The field of view, in degrees, of the horizon component's projected window.
Defined in
src/sdk/components/horizon/HorizonComponent.tsx:19
fovEndpoints
• Optional fovEndpoints: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>
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].
Defined in
src/sdk/components/horizon/HorizonComponent.tsx:25
projectedOffset
• Optional projectedOffset: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>
The projected offset of the center of the projection, as [x, y] in pixels. Defaults to [0, 0].
Defined in
src/sdk/components/horizon/HorizonComponent.tsx:28
projectedSize
• projectedSize: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>
The size, as [width, height] in pixels, of the horizon component's projected window.
Defined in
src/sdk/components/horizon/HorizonComponent.tsx:16
projection
• Optional projection: HorizonProjection
A projection to inject. A default will be used if none is provided.
Defined in
src/sdk/components/horizon/HorizonComponent.tsx:31
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:125