Class: ArtificialHorizon
Defined in: src/garminsdk/components/nextgenpfd/horizon/ArtificialHorizon.tsx:66
A PFD artificial horizon. Renders sky and ground boxes.
Extends
HorizonSharedCanvasSubLayer
<ArtificalHorizonProps
>
Constructors
Constructor
new ArtificialHorizon(
props
):ArtificialHorizon
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | ArtificalHorizonProps | The propertis of the component. |
Returns
ArtificialHorizon
Inherited from
HorizonSharedCanvasSubLayer<ArtificalHorizonProps>.constructor
Properties
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
HorizonSharedCanvasSubLayer.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
HorizonSharedCanvasSubLayer.contextType
props
props:
ArtificalHorizonProps
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
HorizonSharedCanvasSubLayer.props
Accessors
display
Get Signature
get
protected
display():HorizonSharedCanvasInstance
Defined in: src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:174
This sublayer's shared canvas instance.
Throws
Error if this sublayer is not attached.
Returns
HorizonSharedCanvasInstance
Inherited from
HorizonSharedCanvasSubLayer.display
projection
Get Signature
get
protected
projection():HorizonProjection
Defined in: src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:161
This sublayer's horizon projection.
Throws
Error if this sublayer is not attached.
Returns
HorizonProjection
Inherited from
HorizonSharedCanvasSubLayer.projection
Methods
attach()
attach(
projection
,display
):void
Defined in: src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:203
Attaches this sublayer to a parent layer.
Parameters
Parameter | 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
destroy()
destroy():
void
Defined in: src/garminsdk/components/nextgenpfd/horizon/ArtificialHorizon.tsx:267
Returns
void
Inherit Doc
Overrides
HorizonSharedCanvasSubLayer.destroy
getContext()
protected
getContext(context
):never
Defined in: src/sdk/components/FSComponent.ts:106
Gets a context data subscription from the context collection.
Parameters
Parameter | 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
isAttached()
protected
isAttached():boolean
Defined in: src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:186
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
isVisible()
protected
isVisible():boolean
Defined in: src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:194
Checks whether this sublayer is visible.
Returns
boolean
Whether this sublayer is visible.
Inherited from
HorizonSharedCanvasSubLayer.isVisible
onAfterRender()
onAfterRender(
node
):void
Defined in: src/sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
HorizonSharedCanvasSubLayer.onAfterRender
onAttached()
onAttached():
void
Defined in: src/garminsdk/components/nextgenpfd/horizon/ArtificialHorizon.tsx:94
Returns
void
Inherit Doc
Overrides
HorizonSharedCanvasSubLayer.onAttached
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
HorizonSharedCanvasSubLayer.onBeforeRender
onProjectionChanged()
onProjectionChanged(
projection
,changeFlags
):void
Defined in: src/garminsdk/components/nextgenpfd/horizon/ArtificialHorizon.tsx:103
Parameters
Parameter | Type |
---|---|
projection | HorizonProjection |
changeFlags | number |
Returns
void
Inherit Doc
Overrides
HorizonSharedCanvasSubLayer.onProjectionChanged
onSleep()
onSleep():
void
Defined in: src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:255
This method is called when this sublayer's parent layer is put to sleep.
Returns
void
Inherited from
HorizonSharedCanvasSubLayer.onSleep
onUpdated()
onUpdated():
void
Defined in: src/garminsdk/components/nextgenpfd/horizon/ArtificialHorizon.tsx:115
Returns
void
Inherit Doc
Overrides
HorizonSharedCanvasSubLayer.onUpdated
onVisibilityChanged()
protected
onVisibilityChanged(isVisible
):void
Defined in: src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:234
This method is called when this layer's visibility changes.
Parameters
Parameter | Type | Description |
---|---|---|
isVisible | boolean | Whether the layer is now visible. |
Returns
void
Inherited from
HorizonSharedCanvasSubLayer.onVisibilityChanged
onWake()
onWake():
void
Defined in: src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:248
This method is called when this sublayer's parent layer is awakened.
Returns
void
Inherited from
HorizonSharedCanvasSubLayer.onWake
render()
render():
null
|VNode
Defined in: src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:293
Returns
null
| VNode
Inherit Doc
Inherited from
HorizonSharedCanvasSubLayer.render
setVisible()
setVisible(
val
):void
Defined in: src/sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:218
Sets this sublayer's visibility.
Parameters
Parameter | Type | Description |
---|---|---|
val | boolean | Whether this sublayer should be visible. |
Returns
void
Inherited from
HorizonSharedCanvasSubLayer.setVisible
shouldInvalidate()
shouldInvalidate():
boolean
Defined in: src/garminsdk/components/nextgenpfd/horizon/ArtificialHorizon.tsx:110
Returns
boolean
Inherit Doc
Overrides
HorizonSharedCanvasSubLayer.shouldInvalidate