Skip to main content

Class: HdgTrkUpModeMapLayer

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2/MFD/UpperMFD/Map/Layers/HdgTrkUpModeMapLayer.tsx:32

The HdgTrkUpModeMapLayer component.

Extends​

  • MapLayer<HdgTrkUpModeMapLayerProps>

Constructors​

Constructor​

new HdgTrkUpModeMapLayer(props): HdgTrkUpModeMapLayer

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

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsHdgTrkUpModeMapLayerPropsThe propertis of the component.

Returns​

HdgTrkUpModeMapLayer

Inherited from​

MapLayer<HdgTrkUpModeMapLayerProps>.constructor

Properties​

context?​

optional context: [] = undefined

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

The context on this component, if any.

Inherited from​

MapLayer.context


contextType?​

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from​

MapLayer.contextType


props​

props: HdgTrkUpModeMapLayerProps & ComponentProps

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

The properties of the component.

Inherited from​

MapLayer.props

Methods​

destroy()​

destroy(): void

Defined in: sdk/components/FSComponent.ts:98

Destroys this component.

Returns​

void

Inherited from​

MapLayer.destroy


getContext()​

protected getContext(context): never

Defined in: sdk/components/FSComponent.ts:106

Gets a context data subscription from the context collection.

Parameters​

ParameterTypeDescription
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


isVisible()​

isVisible(): boolean

Defined in: sdk/components/map/MapLayer.ts:38

Checks whether this layer is visible.

Returns​

boolean

whether this layer is visible.

Inherited from​

MapLayer.isVisible


onAfterRender()​

onAfterRender(node): void

Defined in: sdk/components/FSComponent.ts:87

A callback that is called after the component is rendered.

Parameters​

ParameterTypeDescription
nodeVNodeThe component's VNode.

Returns​

void

Inherited from​

MapLayer.onAfterRender


onAttached()​

onAttached(): void

Defined in: sdk/components/map/MapLayer.ts:67

This method is called when this layer is attached to its parent map component.

Returns​

void

Inherited from​

MapLayer.onAttached


onBeforeRender()​

onBeforeRender(): void

Defined in: sdk/components/FSComponent.ts:80

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

MapLayer.onBeforeRender


onDetached()​

onDetached(): void

Defined in: sdk/components/map/MapLayer.ts:108

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

Returns​

void

Inherited from​

MapLayer.onDetached


onMapProjectionChanged()​

onMapProjectionChanged(mapProjection, changeFlags): void

Defined in: sdk/components/map/MapLayer.ts:91

This method is called when the map projection changes.

Parameters​

ParameterTypeDescription
mapProjectionMapProjectionthis layer's map projection.
changeFlagsnumberThe types of changes made to the projection.

Returns​

void

Inherited from​

MapLayer.onMapProjectionChanged


onSleep()​

onSleep(): void

Defined in: sdk/components/map/MapLayer.ts:81

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

Returns​

void

Inherited from​

MapLayer.onSleep


onUpdated()​

onUpdated(time, elapsed): void

Defined in: sdk/components/map/MapLayer.ts:101

This method is called once every map update cycle.

Parameters​

ParameterTypeDescription
timenumberThe current time as a UNIX timestamp.
elapsednumberThe elapsed time, in milliseconds, since the last update.

Returns​

void

Inherited from​

MapLayer.onUpdated


onVisibilityChanged()​

onVisibilityChanged(isVisible): void

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2/MFD/UpperMFD/Map/Layers/HdgTrkUpModeMapLayer.tsx:43

Parameters​

ParameterType
isVisibleboolean

Returns​

void

Inherit Doc​

Overrides​

MapLayer.onVisibilityChanged


onWake()​

onWake(): void

Defined in: sdk/components/map/MapLayer.ts:74

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

Returns​

void

Inherited from​

MapLayer.onWake


render()​

render(): VNode

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2/MFD/UpperMFD/Map/Layers/HdgTrkUpModeMapLayer.tsx:48

Returns​

VNode

Inherit Doc​

Overrides​

MapLayer.render


setVisible()​

setVisible(val): void

Defined in: sdk/components/map/MapLayer.ts:46

Sets this layer's visibility.

Parameters​

ParameterTypeDescription
valbooleanWhether this layer should be visible.

Returns​

void

Inherited from​

MapLayer.setVisible