Class: GarminChartAirplaneIconLayer

Defined in: src/garminsdk/components/charts/GarminChartAirplaneIconLayer.tsx:56

A Garmin terminal (airport) chart display layer that renders an airplane icon. The airplane icon is positioned in the display using geo-referencing data. If there is no geo-referencing data available, or the airplane's position falls outside the geo-referenced area, then the icon is hidden.

Extends

• DisplayComponent<GarminChartAirplaneIconLayerProps>

Implements

• GarminChartDisplayLayer

Constructors

Constructor

new GarminChartAirplaneIconLayer(props): GarminChartAirplaneIconLayer

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	GarminChartAirplaneIconLayerProps	The propertis of the component.

Returns

GarminChartAirplaneIconLayer

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Implementation of

GarminChartDisplayLayer.context

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Implementation of

GarminChartDisplayLayer.contextType

Inherited from

DisplayComponent.contextType

---

isTerminalChartDisplayLayer

readonly isTerminalChartDisplayLayer: true = true

Defined in: src/garminsdk/components/charts/GarminChartAirplaneIconLayer.tsx:61

Flags this object as a GarminChartDisplayLayer.

Implementation of

GarminChartDisplayLayer.isTerminalChartDisplayLayer

---

props

props: GarminChartAirplaneIconLayerProps & ComponentProps

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

The properties of the component.

Implementation of

GarminChartDisplayLayer.props

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/components/charts/GarminChartAirplaneIconLayer.tsx:190

Destroys this component.

Returns

void

Implementation of

GarminChartDisplayLayer.destroy

Overrides

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

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

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.

Implementation of

GarminChartDisplayLayer.getContext

Inherited from

DisplayComponent.getContext

---

onAfterRender()

onAfterRender(node): void

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

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
node	VNode	The component's VNode.

Returns

void

Implementation of

GarminChartDisplayLayer.onAfterRender

Inherited from

DisplayComponent.onAfterRender

---

onAttached()

onAttached(): void

Defined in: src/garminsdk/components/charts/GarminChartAirplaneIconLayer.tsx:84

A method that is called when this layer is attached to its parent display.

Returns

void

Implementation of

GarminChartDisplayLayer.onAttached

---

onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Implementation of

GarminChartDisplayLayer.onBeforeRender

Inherited from

DisplayComponent.onBeforeRender

---

onProjectionChanged()

onProjectionChanged(): void

Defined in: src/garminsdk/components/charts/GarminChartAirplaneIconLayer.tsx:93

A method that is called when the projection of this layer's parent display changes.

Returns

void

Implementation of

GarminChartDisplayLayer.onProjectionChanged

---

onUpdate()

onUpdate(time, projection): void

Defined in: src/garminsdk/components/charts/GarminChartAirplaneIconLayer.tsx:98

A method that is called when this layer's parent display is updated.

Parameters

Parameter	Type	Description
time	number	The current real (operating system) time, as a Javascript timestamp.
projection	GarminChartDisplayProjection	The projection of this layer's parent display.

Returns

void

Implementation of

GarminChartDisplayLayer.onUpdate

---

render()

render(): VNode

Defined in: src/garminsdk/components/charts/GarminChartAirplaneIconLayer.tsx:172

Renders the component.

Returns

VNode

A JSX element to be rendered.

Implementation of

GarminChartDisplayLayer.render

Overrides

DisplayComponent.render