Skip to main content

Abstract Class: HorizonLayer<P>

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

A base component for horizon layers.

Extends

Extended by

Type Parameters

Type ParameterDefault type
P extends HorizonLayerPropsHorizonLayerProps

Constructors

Constructor

new HorizonLayer<P>(props): HorizonLayer<P>

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

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsPThe propertis of the component.

Returns

HorizonLayer<P>

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context


contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType


props

props: P & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy


getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

ParameterTypeDescription
contextneverThe context to get the subscription for.

Returns

never

The requested context.

Throws

An error if no data for the specified context type could be found.

Inherited from

DisplayComponent.getContext


isAttached()

protected isAttached(): boolean

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

Checks whether this layer is attached to a horizon component.

Returns

boolean

Whether this layer is attached to a horizon component.


isVisible()

isVisible(): boolean

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

Checks whether this layer is visible.

Returns

boolean

whether this layer is visible.


onAfterRender()

onAfterRender(node): void

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

A callback that is called after the component is rendered.

Parameters

ParameterTypeDescription
nodeVNodeThe component's VNode.

Returns

void

Inherited from

DisplayComponent.onAfterRender


onAttached()

onAttached(): void

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

This method is called when this layer is attached to its parent horizon component.

Returns

void


onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender


onDetached()

onDetached(): void

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

This method is called when this layer is detached from its parent horizon component.

Returns

void


onProjectionChanged()

onProjectionChanged(projection, changeFlags): void

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

This method is called when this layer's horizon projection changes.

Parameters

ParameterTypeDescription
projectionHorizonProjectionThis layer's horizon projection.
changeFlagsnumberThe types of changes made to the projection.

Returns

void


onSleep()

onSleep(): void

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

This method is called when this layer's parent horizon component is put to sleep.

Returns

void


onUpdated()

onUpdated(time, elapsed): void

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

This method is called once every update cycle.

Parameters

ParameterTypeDescription
timenumberThe current time as a UNIX timestamp in milliseconds.
elapsednumberThe elapsed time, in milliseconds, since the last update.

Returns

void


onVisibilityChanged()

protected onVisibilityChanged(isVisible): void

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

This method is called when this layer's visibility changes.

Parameters

ParameterTypeDescription
isVisiblebooleanWhether the layer is now visible.

Returns

void


onWake()

onWake(): void

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

This method is called when this layer's parent horizon component is awakened.

Returns

void


render()

abstract render(): null | VNode

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

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Inherited from

DisplayComponent.render


setVisible()

setVisible(val): void

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

Sets this layer's visibility.

Parameters

ParameterTypeDescription
valbooleanWhether this layer should be visible.

Returns

void