Skip to main content

Class: MapFlightPlanLayer

A map layer which displays a flight plan.

Hierarchy

Constructors

constructor

new MapFlightPlanLayer(props): MapFlightPlanLayer

Creates an instance of a DisplayComponent.

Parameters

NameTypeDescription
propsMapFlightPlanLayerPropsThe propertis of the component.

Returns

MapFlightPlanLayer

Inherited from

MapLayer<MapFlightPlanLayerProps>.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

context

Optional context: [] = undefined

The context on this component, if any.

Inherited from

MapLayer.context

Defined in

src/sdk/components/FSComponent.ts:64


contextType

Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

MapLayer.contextType

Defined in

src/sdk/components/FSComponent.ts:67


props

props: MapFlightPlanLayerProps & ComponentProps

The properties of the component.

Inherited from

MapLayer.props

Defined in

src/sdk/components/FSComponent.ts:61

Methods

destroy

destroy(): void

Returns

void

Inherit Doc

Overrides

MapLayer.destroy

Defined in

src/garminsdk/components/map/layers/MapFlightPlanLayer.tsx:404


getContext

getContext(context): never

Gets a context data subscription from the context collection.

Parameters

NameTypeDescription
contextneverThe 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

MapLayer.getContext

Defined in

src/sdk/components/FSComponent.ts:106


isVisible

isVisible(): boolean

Checks whether this layer is visible.

Returns

boolean

whether this layer is visible.

Inherited from

MapLayer.isVisible

Defined in

src/sdk/components/map/MapLayer.ts:38


onAfterRender

onAfterRender(node): void

A callback that is called after the component is rendered.

Parameters

NameTypeDescription
nodeVNodeThe component's VNode.

Returns

void

Inherited from

MapLayer.onAfterRender

Defined in

src/sdk/components/FSComponent.ts:87


onAttached

onAttached(): void

Returns

void

Inherit Doc

Overrides

MapLayer.onAttached

Defined in

src/garminsdk/components/map/layers/MapFlightPlanLayer.tsx:79


onBeforeRender

onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

MapLayer.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80


onDetached

onDetached(): void

This method is called when this layer is detached from its parent map component.

Returns

void

Inherited from

MapLayer.onDetached

Defined in

src/sdk/components/map/MapLayer.ts:108


onMapProjectionChanged

onMapProjectionChanged(mapProjection, changeFlags): void

Parameters

NameType
mapProjectionMapProjection
changeFlagsnumber

Returns

void

Inherit Doc

Overrides

MapLayer.onMapProjectionChanged

Defined in

src/garminsdk/components/map/layers/MapFlightPlanLayer.tsx:130


onSleep

onSleep(): void

This method is called when this layer's parent map is put to sleep.

Returns

void

Inherited from

MapLayer.onSleep

Defined in

src/sdk/components/map/MapLayer.ts:81


onUpdated

onUpdated(time, elapsed): void

Parameters

NameType
timenumber
elapsednumber

Returns

void

Inherit Doc

Overrides

MapLayer.onUpdated

Defined in

src/garminsdk/components/map/layers/MapFlightPlanLayer.tsx:150


onVisibilityChanged

onVisibilityChanged(isVisible): void

This method is called when this layer's visibility changes.

Parameters

NameTypeDescription
isVisiblebooleanWhether the layer is now visible.

Returns

void

Inherited from

MapLayer.onVisibilityChanged

Defined in

src/sdk/components/map/MapLayer.ts:60


onWake

onWake(): void

This method is called when this layer's parent map is woken.

Returns

void

Inherited from

MapLayer.onWake

Defined in

src/sdk/components/map/MapLayer.ts:74


render

render(): VNode

Returns

VNode

Inherit Doc

Overrides

MapLayer.render

Defined in

src/garminsdk/components/map/layers/MapFlightPlanLayer.tsx:390


setVisible

setVisible(val): void

Sets this layer's visibility.

Parameters

NameTypeDescription
valbooleanWhether this layer should be visible.

Returns

void

Inherited from

MapLayer.setVisible

Defined in

src/sdk/components/map/MapLayer.ts:46