Skip to main content

Class: NavInsetMap

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InsetMap/NavInsetMap.tsx:47

A PFD inset map.

Extends​

Constructors​

Constructor​

new NavInsetMap(props): NavInsetMap

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

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsNavInsetMapPropsThe propertis of the component.

Returns​

NavInsetMap

Inherited from​

DisplayComponent.constructor

Properties​

context?​

optional context: [] = undefined

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

The context on this component, if any.

Inherited from​

DisplayComponent.context


contextType?​

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from​

DisplayComponent.contextType


props​

props: NavInsetMapProps & ComponentProps

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

The properties of the component.

Inherited from​

DisplayComponent.props

Methods​

destroy()​

destroy(): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InsetMap/NavInsetMap.tsx:316

Destroys this component.

Returns​

void

Overrides​

DisplayComponent.destroy


getContext()​

protected getContext(context): never

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

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​

DisplayComponent.getContext


onAfterRender()​

onAfterRender(): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InsetMap/NavInsetMap.tsx:159

A callback that is called after the component is rendered.

Returns​

void

Overrides​

DisplayComponent.onAfterRender


onBeforeRender()​

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

DisplayComponent.onBeforeRender


onEvent()​

onEvent(event): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InsetMap/NavInsetMap.tsx:234

Responds to display pane view events.

Parameters​

ParameterTypeDescription
eventDisplayPaneViewEventA display pane view event.

Returns​

void


onInteractionEvent()​

onInteractionEvent(event): boolean

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InsetMap/NavInsetMap.tsx:263

Handles an interaction event.

Parameters​

ParameterTypeDescription
eventstringThe interaction event to handle.

Returns​

boolean

Whether the interaction event was handled.


render()​

render(): VNode

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InsetMap/NavInsetMap.tsx:311

Renders the component.

Returns​

VNode

A JSX element to be rendered.

Overrides​

DisplayComponent.render


sleep()​

sleep(): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InsetMap/NavInsetMap.tsx:195

Wakes this map.

Returns​

void


update()​

update(time): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InsetMap/NavInsetMap.tsx:218

Updates this map.

Parameters​

ParameterTypeDescription
timenumberThe current real time, as a UNIX timestamp in milliseconds.

Returns​

void


wake()​

wake(): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InsetMap/NavInsetMap.tsx:176

Wakes this map.

Returns​

void