Class: ArtificialHorizon

A PFD artificial horizon. Renders sky and ground boxes.

Hierarchy

• HorizonSharedCanvasSubLayer<ArtificalHorizonProps>

  ↳ ArtificialHorizon

Constructors

constructor

• new ArtificialHorizon(props): ArtificialHorizon

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	ArtificalHorizonProps	The propertis of the component.

Returns

ArtificialHorizon

Inherited from

HorizonSharedCanvasSubLayer<ArtificalHorizonProps>.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

HorizonSharedCanvasSubLayer.context

Defined in

src/sdk/components/FSComponent.ts:64

---

contextType

• Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

HorizonSharedCanvasSubLayer.contextType

Defined in

src/sdk/components/FSComponent.ts:67

---

props

• props: ArtificalHorizonProps & ComponentProps

The properties of the component.

Inherited from

HorizonSharedCanvasSubLayer.props

Defined in

src/sdk/components/FSComponent.ts:61

Accessors

display

• get display(): HorizonSharedCanvasInstance

This sublayer's shared canvas instance.

Returns

HorizonSharedCanvasInstance

Throws

Error if this sublayer is not attached.

Inherited from

HorizonSharedCanvasSubLayer.display

Defined in

src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:174

---

projection

• get projection(): HorizonProjection

This sublayer's horizon projection.

Returns

HorizonProjection

Throws

Error if this sublayer is not attached.

Inherited from

HorizonSharedCanvasSubLayer.projection

Defined in

src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:161

Methods

attach

▸ attach(projection, display): void

Attaches this sublayer to a parent layer.

Parameters

Name	Type	Description
projection	HorizonProjection	The horizon projection used by this sublayer.
display	HorizonSharedCanvasInstance	The canvas instance shared by this sublayer.

Returns

void

Inherited from

HorizonSharedCanvasSubLayer.attach

Defined in

src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:203

---

destroy

▸ destroy(): void

Returns

void

Inherit Doc

Overrides

HorizonSharedCanvasSubLayer.destroy

Defined in

src/garminsdk/components/nextgenpfd/horizon/ArtificialHorizon.tsx:267

---

getContext

▸ getContext(context): never

Gets a context data subscription from the context collection.

Parameters

Name	Type	Description
context	never	The 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

HorizonSharedCanvasSubLayer.getContext

Defined in

src/sdk/components/FSComponent.ts:106

---

isAttached

▸ isAttached(): boolean

Checks whether this sublayer is attached to a parent layer.

Returns

boolean

Whether this sublayer is attached to a parent layer.

Inherited from

HorizonSharedCanvasSubLayer.isAttached

Defined in

src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:186

---

isVisible

▸ isVisible(): boolean

Checks whether this sublayer is visible.

Returns

boolean

Whether this sublayer is visible.

Inherited from

HorizonSharedCanvasSubLayer.isVisible

Defined in

src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:194

---

onAfterRender

▸ onAfterRender(node): void

A callback that is called after the component is rendered.

Parameters

Name	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

HorizonSharedCanvasSubLayer.onAfterRender

Defined in

src/sdk/components/FSComponent.ts:87

---

onAttached

▸ onAttached(): void

Returns

void

Inherit Doc

Overrides

HorizonSharedCanvasSubLayer.onAttached

Defined in

src/garminsdk/components/nextgenpfd/horizon/ArtificialHorizon.tsx:94

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

HorizonSharedCanvasSubLayer.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80

---

onProjectionChanged

▸ onProjectionChanged(projection, changeFlags): void

Parameters

Name	Type
projection	HorizonProjection
changeFlags	number

Returns

void

Inherit Doc

Overrides

HorizonSharedCanvasSubLayer.onProjectionChanged

Defined in

src/garminsdk/components/nextgenpfd/horizon/ArtificialHorizon.tsx:103

---

onSleep

▸ onSleep(): void

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

Returns

void

Inherited from

HorizonSharedCanvasSubLayer.onSleep

Defined in

src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:255

---

onUpdated

▸ onUpdated(): void

Returns

void

Inherit Doc

Overrides

HorizonSharedCanvasSubLayer.onUpdated

Defined in

src/garminsdk/components/nextgenpfd/horizon/ArtificialHorizon.tsx:115

---

onVisibilityChanged

▸ onVisibilityChanged(isVisible): void

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

Parameters

Name	Type	Description
isVisible	boolean	Whether the layer is now visible.

Returns

void

Inherited from

HorizonSharedCanvasSubLayer.onVisibilityChanged

Defined in

src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:234

---

onWake

▸ onWake(): void

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

Returns

void

Inherited from

HorizonSharedCanvasSubLayer.onWake

Defined in

src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:248

---

render

▸ render(): null | VNode

Returns

null | VNode

Inherit Doc

Inherited from

HorizonSharedCanvasSubLayer.render

Defined in

src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:293

---

setVisible

▸ setVisible(val): void

Sets this sublayer's visibility.

Parameters

Name	Type	Description
val	boolean	Whether this sublayer should be visible.

Returns

void

Inherited from

HorizonSharedCanvasSubLayer.setVisible

Defined in

src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:218

---

shouldInvalidate

▸ shouldInvalidate(): boolean

Returns

boolean

Inherit Doc

Overrides

HorizonSharedCanvasSubLayer.shouldInvalidate

Defined in

src/garminsdk/components/nextgenpfd/horizon/ArtificialHorizon.tsx:110