Skip to main content

Class: GtcSidebar

Colletion of functions for working with the GtcSidebar.

Constructors

constructor

new GtcSidebar(): GtcSidebar

Returns

GtcSidebar

Properties

hidePanesString

Static Readonly hidePanesString: "$hide-panes$"

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/Sidebar.ts:55

Methods

createSidebarState

createSidebarState(): GtcSidebarState

Creates an instance of the sidebar state to be used by GtcViews.

Returns

GtcSidebarState

new sidebar state.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/Sidebar.ts:62


isDualConcentricKnobLabelKey

isDualConcentricKnobLabelKey(key): key is "dataEntryPushEnter" | "dataEntryPushEnterHold" | "panPointPushPanOff"

Checks if string is a DualConcentricKnobLabelKey.

Parameters

NameTypeDescription
keystringThe string.

Returns

key is "dataEntryPushEnter" | "dataEntryPushEnterHold" | "panPointPushPanOff"

whether the key is a DualConcentricKnobLabelKey or not.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/Sidebar.ts:144


pipeObjectOfSubs

pipeObjectOfSubs(from, to): Subscription[]

Pipes all the subscribables from one ObjectOfSubjects to another.

Parameters

NameTypeDescription
fromObjectOfSubsObject to pipe from.
toMutableObjectOfSubsObject to pipe to.

Returns

Subscription[]

All the subscriptions made from the pipes.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/Sidebar.ts:88


renderDualConcentricKnobLabel

renderDualConcentricKnobLabel(labelOrKey, orientation): string

Renders the DualConcentricKnobLabel.

Parameters

NameTypeDescription
labelOrKeystringThe label to render, or a DualConcentricKnobLabelKey.
orientationGtcOrientationThe gtc orientation.

Returns

string

the final string.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/Sidebar.ts:100


renderDualConcentricKnobLabelHorizontal

renderDualConcentricKnobLabelHorizontal(labelKey): string

Renders the DualConcentricKnobLabel for the horizontal orientation.

Parameters

NameTypeDescription
labelKey"dataEntryPushEnter" | "dataEntryPushEnterHold" | "panPointPushPanOff"The label key.

Returns

string

The rendered string.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/Sidebar.ts:116


renderDualConcentricKnobLabelVertical

renderDualConcentricKnobLabelVertical(labelKey): string

Renders the DualConcentricKnobLabel for the vertical orientation.

Parameters

NameTypeDescription
labelKey"dataEntryPushEnter" | "dataEntryPushEnterHold" | "panPointPushPanOff"The label key.

Returns

string

The rendered string.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/GtcService/Sidebar.ts:130