Skip to main content

Interface: XMLCylinderGaugeProps

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/Cylinder.ts:5

Props for a cylinder gauge

Extends​

Properties​

beginText​

beginText: string

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:33

Text at the beginning of the gauge.

Inherited from​

XMLGaugeProps.beginText

bus​

bus: EventBus

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/Cylinder.ts:7

An event bus for leaning events.

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

XMLGaugeProps.children

colorLines​

colorLines: XMLGaugeColorLine[]

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:19

A list of colir lines.

Inherited from​

XMLGaugeProps.colorLines

colorZones​

colorZones: XMLGaugeColorZone[]

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:17

A list of color zones.

Inherited from​

XMLGaugeProps.colorZones

cursorText1​

cursorText1: string

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:37

The label of the first cursor.

Inherited from​

XMLGaugeProps.cursorText1

cursorText2​

cursorText2: string

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:39

The labe of the second cursor, for

Inherited from​

XMLGaugeProps.cursorText2

endText​

endText: string

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:35

Text at the end of the gauge.

Inherited from​

XMLGaugeProps.endText

graduationHasText​

graduationHasText: boolean

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:31

Do the graduations have text?

Inherited from​

XMLGaugeProps.graduationHasText

graduationLength​

graduationLength: number

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:29

The length of individual graduations.

Inherited from​

XMLGaugeProps.graduationLength

id​

id: string

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:41

The class ID of the gauge.

Inherited from​

XMLGaugeProps.id

maximum​

maximum: CompositeLogicXMLElement

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:15

The maximum value.

Inherited from​

XMLGaugeProps.maximum

minimum​

minimum: CompositeLogicXMLElement

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:13

The minimum value.

Inherited from​

XMLGaugeProps.minimum

numColumns​

numColumns: CompositeLogicXMLElement

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/Cylinder.ts:9

The number of columns in the gauge.

numRows​

numRows: CompositeLogicXMLElement

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/Cylinder.ts:11

The number of boxes each column should have.

redBlink: CompositeLogicXMLElement

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:44

Any triggers for blinking the element red.

Inherited from​

XMLGaugeProps.redBlink

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

XMLGaugeProps.ref

referenceBugs​

referenceBugs: XMLGaugeReferenceBug[]

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:46

A reference bug definition, if present.

Inherited from​

XMLGaugeProps.referenceBugs

style​

style: Partial<XMLCylinderGaugeStyle>

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/Cylinder.ts:15

The gauge styling.

Overrides​

XMLGaugeProps.style

tempOrder?​

optional tempOrder: number[]

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/Cylinder.ts:13

What's the order of the hottest cylinders?

title​

title: string

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:25

The title of the gauge.

Inherited from​

XMLGaugeProps.title

unit​

unit: string

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:27

The units measured by the gauge.

Inherited from​

XMLGaugeProps.unit

value1​

value1: CompositeLogicXMLElement

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:21

The first possible value.

Inherited from​

XMLGaugeProps.value1

value2​

value2: CompositeLogicXMLElement

Defined in: src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:23

The second possible value for dual elements.

Inherited from​

XMLGaugeProps.value2