Class: GarminChartScaleBarLayer

Defined in: src/garminsdk/components/charts/GarminChartScaleBarLayer.tsx:53

A Garmin terminal (airport) chart display layer that renders a scale bar. The scale bar depicts a nominal geographical range value chosen such that the length of the projected range lies within certain limits.

Extends

• DisplayComponent<GarminChartScaleBarLayerProps>

Implements

• GarminChartDisplayLayer

Constructors

Constructor

new GarminChartScaleBarLayer(props): GarminChartScaleBarLayer

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	GarminChartScaleBarLayerProps	The propertis of the component.

Returns

GarminChartScaleBarLayer

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

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

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:67

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/GarminChartScaleBarLayer.tsx:83

Flags this object as a GarminChartDisplayLayer.

Implementation of

GarminChartDisplayLayer.isTerminalChartDisplayLayer

---

props

props: GarminChartScaleBarLayerProps & ComponentProps

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

The properties of the component.

Implementation of

GarminChartDisplayLayer.props

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/components/charts/GarminChartScaleBarLayer.tsx:319

Destroys this component.

Returns

void

Implementation of

GarminChartDisplayLayer.destroy

Overrides

DisplayComponent.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.

Implementation of

GarminChartDisplayLayer.getContext

Inherited from

DisplayComponent.getContext

---

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

Implementation of

GarminChartDisplayLayer.onAfterRender

Inherited from

DisplayComponent.onAfterRender

---

onAttached()

onAttached(): void

Defined in: src/garminsdk/components/charts/GarminChartScaleBarLayer.tsx:116

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:80

A callback that is called before the component is rendered.

Returns

void

Implementation of

GarminChartDisplayLayer.onBeforeRender

Inherited from

DisplayComponent.onBeforeRender

---

onProjectionChanged()

onProjectionChanged(projection, changeFlags): void

Defined in: src/garminsdk/components/charts/GarminChartScaleBarLayer.tsx:148

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

Implementation of

GarminChartDisplayLayer.onProjectionChanged

---

onUpdate()

onUpdate(time, projection): void

Defined in: src/garminsdk/components/charts/GarminChartScaleBarLayer.tsx:153

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

---

refreshStyle()

refreshStyle(): void

Defined in: src/garminsdk/components/charts/GarminChartScaleBarLayer.tsx:141

Schedules a refresh of this layer's scale bar. The refresh will occur the next time the layer's parent display is updated. This method should be called when the width of the scale bar's left or right labels is changed independently of its text content due to outside styling.

Returns

void

---

render()

render(): VNode

Defined in: src/garminsdk/components/charts/GarminChartScaleBarLayer.tsx:258

Renders the component.

Returns

VNode

A JSX element to be rendered.

Implementation of

GarminChartDisplayLayer.render

Overrides

DisplayComponent.render