Skip to main content

Interface: XMLGaugeProps

Base props for an XML gauge.

Hierarchy​

Properties​

beginText​

• beginText: string

Text at the beginning of the gauge.

Defined in​

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

children​

• Optional children: DisplayChildren[]

The children of the display component.

Inherited from​

ComponentProps.children

Defined in​

src/sdk/components/FSComponent.ts:122

colorLines​

• colorLines: XMLGaugeColorLine[]

A list of colir lines.

Defined in​

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

colorZones​

• colorZones: XMLGaugeColorZone[]

A list of color zones.

Defined in​

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

cursorText1​

• cursorText1: string

The label of the first cursor.

Defined in​

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

cursorText2​

• cursorText2: string

The labe of the second cursor, for

Defined in​

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

endText​

• endText: string

Text at the end of the gauge.

Defined in​

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

graduationHasText​

• graduationHasText: boolean

Do the graduations have text?

Defined in​

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

graduationLength​

• graduationLength: number

The length of individual graduations.

Defined in​

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

id​

• id: string

The class ID of the gauge.

Defined in​

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

maximum​

• maximum: CompositeLogicXMLElement

The maximum value.

Defined in​

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

minimum​

• minimum: CompositeLogicXMLElement

The minimum value.

Defined in​

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

• redBlink: CompositeLogicXMLElement

Any triggers for blinking the element red.

Defined in​

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

ref​

• Optional ref: NodeReference<any>

A reference to the display component.

Inherited from​

ComponentProps.ref

Defined in​

src/sdk/components/FSComponent.ts:125

referenceBugs​

• referenceBugs: XMLGaugeReferenceBug[]

A reference bug definition, if present.

Defined in​

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

style​

• style: Partial<XMLGaugeStyle>

The style definiton.

Defined in​

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

title​

• title: string

The title of the gauge.

Defined in​

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

unit​

• unit: string

The units measured by the gauge.

Defined in​

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

value1​

• value1: CompositeLogicXMLElement

The first possible value.

Defined in​

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

value2​

• value2: CompositeLogicXMLElement

The second possible value for dual elements.

Defined in​

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