Class: FlightPathMarker
Defined in: src/garminsdk/components/nextgenpfd/horizon/FlightPathMarker.tsx:30
A PFD synthetic vision technology (SVT) flight path marker. Displays an icon depicting the estimated position of the airplane projected forward in time given the airplane's current horizontal and vertical speed and track.
Extends
HorizonLayer
<FlightPathMarkerProps
>
Constructors
Constructor
new FlightPathMarker(
props
):FlightPathMarker
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | FlightPathMarkerProps | The propertis of the component. |
Returns
FlightPathMarker
Inherited from
HorizonLayer<FlightPathMarkerProps>.constructor
Properties
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
HorizonLayer.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
HorizonLayer.contextType
props
props:
FlightPathMarkerProps
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
HorizonLayer.props
Methods
destroy()
destroy():
void
Defined in: src/garminsdk/components/nextgenpfd/horizon/FlightPathMarker.tsx:187
Returns
void
Inherit Doc
Overrides
HorizonLayer.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
HorizonLayer.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.
Inherited from
HorizonLayer.isAttached
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.
Inherited from
HorizonLayer.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
HorizonLayer.onAfterRender
onAttached()
onAttached():
void
Defined in: src/garminsdk/components/nextgenpfd/horizon/FlightPathMarker.tsx:80
Returns
void
Inherit Doc
Overrides
HorizonLayer.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
HorizonLayer.onBeforeRender
onDetached()
onDetached():
void
Defined in: src/garminsdk/components/nextgenpfd/horizon/FlightPathMarker.tsx:161
Returns
void
Inherit Doc
Overrides
HorizonLayer.onDetached
onProjectionChanged()
onProjectionChanged(
projection
,changeFlags
):void
Defined in: src/garminsdk/components/nextgenpfd/horizon/FlightPathMarker.tsx:103
Parameters
Parameter | Type |
---|---|
projection | HorizonProjection |
changeFlags | number |
Returns
void
Inherit Doc
Overrides
HorizonLayer.onProjectionChanged
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
Inherited from
HorizonLayer.onSleep
onUpdated()
onUpdated(
time
,elapsed
):void
Defined in: src/garminsdk/components/nextgenpfd/horizon/FlightPathMarker.tsx:119
Parameters
Parameter | Type |
---|---|
time | number |
elapsed | number |
Returns
void
Inherit Doc
Overrides
HorizonLayer.onUpdated
onVisibilityChanged()
protected
onVisibilityChanged(isVisible
):void
Defined in: src/garminsdk/components/nextgenpfd/horizon/FlightPathMarker.tsx:69
Parameters
Parameter | Type |
---|---|
isVisible | boolean |
Returns
void
Inherit Doc
Overrides
HorizonLayer.onVisibilityChanged
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
Inherited from
HorizonLayer.onWake
render()
render():
VNode
Defined in: src/garminsdk/components/nextgenpfd/horizon/FlightPathMarker.tsx:171
Renders the component.
Returns
VNode
The component VNode.
Overrides
HorizonLayer.render
setVisible()
setVisible(
val
):void
Defined in: src/sdk/components/horizon/HorizonLayer.ts:47
Sets this layer's visibility.
Parameters
Parameter | Type | Description |
---|---|---|
val | boolean | Whether this layer should be visible. |
Returns
void
Inherited from
HorizonLayer.setVisible