Interface: GarminChartDisplayLayer

Defined in: src/garminsdk/components/charts/GarminChartDisplayLayer.ts:8

A layer in a Garmin terminal (airport) chart display.

Extends

• DisplayComponent<ComponentProps>

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

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.

Inherited from

DisplayComponent.contextType

---

isTerminalChartDisplayLayer

readonly isTerminalChartDisplayLayer: true

Defined in: src/garminsdk/components/charts/GarminChartDisplayLayer.ts:10

Flags this object as a GarminChartDisplayLayer.

---

props

props: ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Inherited from

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.

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

Inherited from

DisplayComponent.onAfterRender

---

onAttached()

onAttached(projection): void

Defined in: src/garminsdk/components/charts/GarminChartDisplayLayer.ts:16

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

Parameters

Parameter	Type	Description
projection	GarminChartDisplayProjection	The projection of this layer's parent display.

Returns

void

---

onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

onProjectionChanged()

onProjectionChanged(projection, changeFlags): void

Defined in: src/garminsdk/components/charts/GarminChartDisplayLayer.ts:23

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

Parameters

Parameter	Type	Description
projection	GarminChartDisplayProjection	The projection of this layer's parent display.
changeFlags	number	Bitflags describing the change to the projection.

Returns

void

---

onUpdate()

onUpdate(time, projection): void

Defined in: src/garminsdk/components/charts/GarminChartDisplayLayer.ts:30

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

---

render()

abstract render(): VNode | null

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

Renders the component.

Returns

VNode | null

A JSX element to be rendered.

Inherited from

DisplayComponent.render