Skip to main content

Interface: XMLGaugeProps

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

Base props for an XML gauge.

Extends​

Extended by​

Properties​

beginText​

beginText: string

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

Text at the beginning of the gauge.

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

ComponentProps.children

colorLines​

colorLines: XMLGaugeColorLine[]

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

A list of colir lines.

colorZones​

colorZones: XMLGaugeColorZone[]

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

A list of color zones.

cursorText1​

cursorText1: string

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

The label of the first cursor.

cursorText2​

cursorText2: string

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

The labe of the second cursor, for

endText​

endText: string

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

Text at the end of the gauge.

graduationHasText​

graduationHasText: boolean

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

Do the graduations have text?

graduationLength​

graduationLength: number

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

The length of individual graduations.

id​

id: string

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

The class ID of the gauge.

maximum​

maximum: CompositeLogicXMLElement

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

The maximum value.

minimum​

minimum: CompositeLogicXMLElement

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

The minimum value.

redBlink: CompositeLogicXMLElement

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

Any triggers for blinking the element red.

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

ComponentProps.ref

referenceBugs​

referenceBugs: XMLGaugeReferenceBug[]

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

A reference bug definition, if present.

style​

style: Partial<XMLGaugeStyle>

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

The style definiton.

title​

title: string

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

The title of the gauge.

unit​

unit: string

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

The units measured by the gauge.

value1​

value1: CompositeLogicXMLElement

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

The first possible value.

value2​

value2: CompositeLogicXMLElement

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

The second possible value for dual elements.