Class: HorizonDisplay
A next-generation (NXi, G3000, etc) Garmin PFD horizon display. Includes an artificial horizon, attitude indicator, aircraft symbol, flight director, and synthetic vision technology (SVT) display.
Hierarchy
DisplayComponent<HorizonDisplayProps>↳
HorizonDisplay
Constructors
constructor
• new HorizonDisplay(props): HorizonDisplay
Creates an instance of a DisplayComponent.
Parameters
| Name | Type | Description |
|---|---|---|
props | HorizonDisplayProps | The propertis of the component. |
Returns
Inherited from
DisplayComponent<HorizonDisplayProps>.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
DisplayComponent.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
DisplayComponent.contextType
Defined in
src/sdk/components/FSComponent.ts:67
props
• props: HorizonDisplayProps & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
Defined in
src/garminsdk/components/nextgenpfd/horizon/HorizonDisplay.tsx:662
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
DisplayComponent.getContext
Defined in
src/sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
Defined in
src/garminsdk/components/nextgenpfd/horizon/HorizonDisplay.tsx:354
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
Defined in
src/sdk/components/FSComponent.ts:80
onProjectionChanged
▸ onProjectionChanged(projection, changeFlags): void
Responds to changes in this horizon display's projection.
Parameters
| Name | Type | Description |
|---|---|---|
projection | HorizonProjection | This display's horizon projection. |
changeFlags | number | The types of changes made to the projection. |
Returns
void
Defined in
src/garminsdk/components/nextgenpfd/horizon/HorizonDisplay.tsx:511
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
src/garminsdk/components/nextgenpfd/horizon/HorizonDisplay.tsx:559
sleep
▸ sleep(): void
Puts this horizon display to sleep. While asleep, this display will not be updated.
Returns
void
Throws
Error if this horizon display is dead.
Defined in
src/garminsdk/components/nextgenpfd/horizon/HorizonDisplay.tsx:485
wake
▸ wake(): void
Wakes this horizon display. While awake, this display will be updated.
Returns
void
Throws
Error if this horizon display is dead.
Defined in
src/garminsdk/components/nextgenpfd/horizon/HorizonDisplay.tsx:460