Skip to main content

Class: NearestFunctionModal

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/UpperMFD/Map/NearestFunctionModal.tsx:23

Modal used for the nearest function menu

Extends

  • Modal<NearestFunctionModalProps>

Constructors

Constructor

new NearestFunctionModal(props): NearestFunctionModal

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

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsNearestFunctionModalPropsThe propertis of the component.

Returns

NearestFunctionModal

Inherited from

Modal.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

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

Modal.contextType


cssClassSet

protected readonly cssClassSet: SetSubject<string>

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/UpperMFD/Map/NearestFunctionModal.tsx:25


props

props: NearestFunctionModalProps & ComponentProps

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

The properties of the component.

Inherited from

Modal.props

Methods

close()

protected close(): void

Defined in: workingtitle-instruments-epic2/shared/Modals/Modal.tsx:33

Closes this modal.

Returns

void

Inherited from

Modal.close


destroy()

destroy(): void

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

Destroys this component.

Returns

void

Inherited from

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

Modal.getContext


onAfterRender()

onAfterRender(): void

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/UpperMFD/Map/NearestFunctionModal.tsx:91

A callback that is called after the component is rendered.

Returns

void

Overrides

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

Modal.onBeforeRender


onPause()

onPause(): void

Defined in: workingtitle-instruments-epic2/shared/Modals/Modal.tsx:28

Called when modal is closed.

Returns

void

Inherited from

Modal.onPause


onResume()

onResume(): void

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/UpperMFD/Map/NearestFunctionModal.tsx:85

Called when modal is opened.

Returns

void

Overrides

Modal.onResume


render()

render(): VNode

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/UpperMFD/Map/NearestFunctionModal.tsx:158

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

Modal.render