Class: GtcSidebar

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/Sidebar.ts:54

Colletion of functions for working with the GtcSidebar.

Constructors

Constructor

new GtcSidebar(): GtcSidebar

Returns

GtcSidebar

Properties

hidePanesString

readonly static hidePanesString: "$hide-panes$" = '$hide-panes$'

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/Sidebar.ts:55

Methods

createSidebarState()

static createSidebarState(): GtcSidebarState

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/Sidebar.ts:62

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

Returns

GtcSidebarState

new sidebar state.

---

isDualConcentricKnobLabelKey()

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

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/Sidebar.ts:144

Checks if string is a DualConcentricKnobLabelKey.

Parameters

Parameter	Type	Description
key	string	The string.

Returns

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

whether the key is a DualConcentricKnobLabelKey or not.

---

pipeObjectOfSubs()

static pipeObjectOfSubs(from, to): Subscription[]

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/Sidebar.ts:88

Pipes all the subscribables from one ObjectOfSubjects to another.

Parameters

Parameter	Type	Description
from	ObjectOfSubs	Object to pipe from.
to	MutableObjectOfSubs	Object to pipe to.

Returns

Subscription[]

All the subscriptions made from the pipes.

---

renderDualConcentricKnobLabel()

static renderDualConcentricKnobLabel(labelOrKey, orientation): string

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/Sidebar.ts:100

Renders the DualConcentricKnobLabel.

Parameters

Parameter	Type	Description
labelOrKey	string	The label to render, or a DualConcentricKnobLabelKey.
orientation	GtcOrientation	The gtc orientation.

Returns

string

the final string.

---

renderDualConcentricKnobLabelHorizontal()

static renderDualConcentricKnobLabelHorizontal(labelKey): string

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/Sidebar.ts:116

Renders the DualConcentricKnobLabel for the horizontal orientation.

Parameters

Parameter	Type	Description
labelKey	"dataEntryPushEnter" | "dataEntryPushEnterHold" | "panPointPushPanOff"	The label key.

Returns

string

The rendered string.

---

renderDualConcentricKnobLabelVertical()

static renderDualConcentricKnobLabelVertical(labelKey): string

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/Sidebar.ts:130

Renders the DualConcentricKnobLabel for the vertical orientation.

Parameters

Parameter	Type	Description
labelKey	"dataEntryPushEnter" | "dataEntryPushEnterHold" | "panPointPushPanOff"	The label key.

Returns

string

The rendered string.