Skip to main content

Class: MFDMapSettingsGroup<P>

A component which displays a group of controls to adjust map settings.

Type parameters

NameType
Pextends MFDMapSettingsGroupProps

Hierarchy

Constructors

constructor

new MFDMapSettingsGroup<P>(props): MFDMapSettingsGroup<P>

Type parameters

NameType
Pextends MFDMapSettingsGroupProps

Parameters

NameType
propsP

Returns

MFDMapSettingsGroup<P>

Inherit Doc

Inherited from

UiControlGroup.constructor

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:36

Properties

context

Optional context: [] = undefined

The context on this component, if any.

Inherited from

UiControlGroup.context

Defined in

sdk/components/FSComponent.ts:64


contextType

Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

UiControlGroup.contextType

Defined in

sdk/components/FSComponent.ts:67


focusSubject

Protected focusSubject: Subject<boolean>

Inherited from

UiControlGroup.focusSubject

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:33


props

props: P & ComponentProps

The properties of the component.

Inherited from

UiControlGroup.props

Defined in

sdk/components/FSComponent.ts:61


scrollController

Protected scrollController: ScrollController

Inherited from

UiControlGroup.scrollController

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:32

Methods

blur

blur(): void

Method to unfocus this control group

Returns

void

Inherited from

UiControlGroup.blur

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:71


destroy

destroy(): void

Destroys this component.

Returns

void

Inherited from

UiControlGroup.destroy

Defined in

sdk/components/FSComponent.ts:98


focus

focus(dir?): void

Method to focus this control group

Parameters

NameTypeDefault valueDescription
dirEntryDirection'top'The direction of entry.

Returns

void

Inherited from

UiControlGroup.focus

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:61


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

UiControlGroup.getContext

Defined in

sdk/components/FSComponent.ts:106


getHighlightElement

getHighlightElement(): null | Element

This is just a dummy that exists here to be compatible with the union type of ScrollableControl

Returns

null | Element

null

Inherited from

UiControlGroup.getHighlightElement

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:125


getIsFocusable

getIsFocusable(): boolean

Gets a boolean indicating if this control is able to be focused.

Returns

boolean

true

Inherited from

UiControlGroup.getIsFocusable

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:88


getIsFocused

getIsFocused(): boolean

Method to check if this UiControlGroup is in focus

Returns

boolean

true if the control group is in focus, false otherwise

Inherited from

UiControlGroup.getIsFocused

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:80


getSettingRows

getSettingRows(containerRef): VNode[]

Gets an array of setting rows to render for this group.

Parameters

NameTypeDescription
containerRefNodeReference<HTMLElement>A node reference to this group's root container.

Returns

VNode[]

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MapSettings/MFDMapSettingsGroup.tsx:58


hide

hide(): void

Hides this group.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MapSettings/MFDMapSettingsGroup.tsx:40


onAfterRender

onAfterRender(node): void

A callback that is called after the component is rendered.

Parameters

NameTypeDescription
nodeVNodeThe component's VNode.

Returns

void

Inherited from

UiControlGroup.onAfterRender

Defined in

sdk/components/FSComponent.ts:87


onBeforeRender

onBeforeRender(): void

Returns

void

Inherit Doc

Inherited from

UiControlGroup.onBeforeRender

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:51


onBlurred

onBlurred(): void

A callback which is called when this control group is blurred.

Returns

void

Inherited from

UiControlGroup.onBlurred

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:244


onFocused

onFocused(): void

A callback which is called when this control group is focused.

Returns

void

Inherited from

UiControlGroup.onFocused

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:237


onInteractionEvent

onInteractionEvent(evt): boolean

Handler for interaction events to be handled by the view.

Parameters

NameTypeDescription
evtFmsHEventThe HEvenet.

Returns

boolean

true if the event was handled in this group

Inherited from

UiControlGroup.onInteractionEvent

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:217


onScrollToggled

onScrollToggled(enabled): void

A method called when the control group scroll is toggled.

Parameters

NameTypeDescription
enabledbooleanif the scroll is enabled.

Returns

void

Inherited from

UiControlGroup.onScrollToggled

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:97


processHEvent

processHEvent(evt): boolean

Handles HEvents and routes them to the subdialog when existant.

Parameters

NameTypeDescription
evtFmsHEventThe received event.

Returns

boolean

true if the event was handled in this control group, false otherwise.

Inherited from

UiControlGroup.processHEvent

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:134


processScrollEvent

processScrollEvent(evt): boolean

Attempts to handle scroll events.

Parameters

NameTypeDescription
evtFmsHEventThe received event.

Returns

boolean

whether the event was handled.

Inherited from

UiControlGroup.processScrollEvent

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:196


register

register(ctrl, unregister?): void

Register/Unregisters a UiControl with the scroll controller.

Parameters

NameTypeDefault valueDescription
ctrlScrollableControlundefinedThe UiControl to register.
unregisterbooleanfalseIndicates if the UiControl should be unregistered.

Returns

void

Inherited from

UiControlGroup.register

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:226


render

render(): VNode

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

UiControlGroup.render

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MapSettings/MFDMapSettingsGroup.tsx:45


routeEventToControl

routeEventToControl(evt, control): boolean

Routes an interaction event to a UiControl.

Parameters

NameTypeDescription
evtFmsHEventAn interaction event.
controlUiControl<UiControlProps>The UiControl to which to route the event.

Returns

boolean

Whether the event was handled by the UiControl.

Inherited from

UiControlGroup.routeEventToControl

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:176


setScrollEnabled

setScrollEnabled(enabled): void

Sets the scroll enabled state

Parameters

NameTypeDescription
enabledbooleanindicating if scrolling should be enabled

Returns

void

Inherited from

UiControlGroup.setScrollEnabled

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:113


show

show(): void

Shows this group.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MapSettings/MFDMapSettingsGroup.tsx:33


toggleScroll

toggleScroll(): void

Toggles the scroll highlighting

Returns

void

Inherited from

UiControlGroup.toggleScroll

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:104