Skip to main content

Interface: G3XToggleButtonGaugeProps

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Gauges/G3XToggleButtonGaugeProps.ts:6

Properties of gauge button.

Extends​

Properties​

beginText​

beginText: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:41

Text at the beginning of the gauge.

Inherited from​

G3XGaugeProps.beginText


bus​

bus: EventBus

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Gauges/G3XToggleButtonGaugeProps.ts:8

The event bus.


cached​

cached: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Gauges/G3XToggleButtonGaugeProps.ts:17

Whether to cache the data that the button publishes to the event bus.


children?​

optional children: DisplayChildren[]

Defined in: src/sdk/components/FSComponent.ts:122

The children of the display component.

Inherited from​

G3XGaugeProps.children


colorLines​

colorLines: G3XGaugeColorLine[]

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:27

A list of colir lines.

Inherited from​

G3XGaugeProps.colorLines


colorLines2​

colorLines2: XMLGaugeColorLine[]

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:13

A list of colir lines.

Inherited from​

G3XGaugeProps.colorLines2


colorZones​

colorZones: G3XGaugeColorZone[]

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:9

A list of color zones.

Inherited from​

G3XGaugeProps.colorZones


colorZones2?​

optional colorZones2: G3XGaugeColorZone[]

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:11

A list of color zones for double gauge.

Inherited from​

G3XGaugeProps.colorZones2


cursorText1​

cursorText1: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:45

The label of the first cursor.

Inherited from​

G3XGaugeProps.cursorText1


cursorText2​

cursorText2: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:47

The labe of the second cursor, for

Inherited from​

G3XGaugeProps.cursorText2


dataChecklistId​

dataChecklistId: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:49

The identifier to assign to the data-checklist attribute of the gauge's root element.

Inherited from​

G3XGaugeProps.dataChecklistId


endText​

endText: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:43

Text at the end of the gauge.

Inherited from​

G3XGaugeProps.endText


event​

event: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Gauges/G3XToggleButtonGaugeProps.ts:11

The event bus topic to which to bind the button's state.


graduationHasText​

graduationHasText: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:39

Do the graduations have text?

Inherited from​

G3XGaugeProps.graduationHasText


graduationLength​

graduationLength: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:37

The length of individual graduations.

Inherited from​

G3XGaugeProps.graduationLength


label?​

optional label: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Gauges/G3XToggleButtonGaugeProps.ts:20

The button's label.


maximum​

maximum: CompositeLogicXMLElement

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:25

The maximum value.

Inherited from​

G3XGaugeProps.maximum


maximum2​

maximum2: CompositeLogicXMLElement

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:17

The maximum2 value.

Inherited from​

G3XGaugeProps.maximum2


minimum​

minimum: CompositeLogicXMLElement

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:23

The minimum value.

Inherited from​

G3XGaugeProps.minimum


minimum2​

minimum2: CompositeLogicXMLElement

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:15

The minimum2 value.

Inherited from​

G3XGaugeProps.minimum2


redBlink: CompositeLogicXMLElement

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:51

Any triggers for blinking the element red.

Inherited from​

G3XGaugeProps.redBlink


ref?​

optional ref: NodeReference<any>

Defined in: src/sdk/components/FSComponent.ts:125

A reference to the display component.

Inherited from​

G3XGaugeProps.ref


smoothFactor?​

optional smoothFactor: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:21

An optional smoothing factor for value changes.

Inherited from​

G3XGaugeProps.smoothFactor


style​

style: Partial<G3XGaugeStyle>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:19

Style for the gauge

Inherited from​

G3XGaugeProps.style


sync​

sync: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Gauges/G3XToggleButtonGaugeProps.ts:14

Whether to sync to other instruments the data that the button publishes to the event bus.


title​

title: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:33

The title of the gauge.

Inherited from​

G3XGaugeProps.title


unit​

unit: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:35

The units measured by the gauge.

Inherited from​

G3XGaugeProps.unit


value1​

value1: CompositeLogicXMLElement

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:29

The first possible value.

Inherited from​

G3XGaugeProps.value1


value2​

value2: CompositeLogicXMLElement

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/G3XGaugesConfigFactory/Definitions/G3XGaugeProps.ts:31

The second possible value for dual elements.

Inherited from​

G3XGaugeProps.value2