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:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | NavInsetMapProps | The propertis of the component. |
Returns
NavInsetMap
Inherited from
Properties
context?
optional
context: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
props
props:
NavInsetMapProps
&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
Methods
destroy()
destroy():
void
Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InsetMap/NavInsetMap.tsx:316
Destroys this component.
Returns
void
Overrides
getContext()
protected
getContext(context
):never
Defined in: 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.
Inherited from
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:80
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
Parameter | Type | Description |
---|---|---|
event | DisplayPaneViewEvent | A 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
Parameter | Type | Description |
---|---|---|
event | string | The 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
A JSX element to be rendered.
Overrides
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
Parameter | Type | Description |
---|---|---|
time | number | The 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