Interface: XMLCylinderGaugeProps
Props for a cylinder gauge
Hierarchy
↳
XMLCylinderGaugeProps
Properties
beginText
• beginText: string
Text at the beginning of the gauge.
Inherited from
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:33
bus
• bus: EventBus
An event bus for leaning events.
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/Cylinder.ts:7
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:122
colorLines
• colorLines: XMLGaugeColorLine[]
A list of colir lines.
Inherited from
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:19
colorZones
• colorZones: XMLGaugeColorZone[]
A list of color zones.
Inherited from
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:17
cursorText1
• cursorText1: string
The label of the first cursor.
Inherited from
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:37
cursorText2
• cursorText2: string
The labe of the second cursor, for
Inherited from
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:39
endText
• endText: string
Text at the end of the gauge.
Inherited from
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:35
graduationHasText
• graduationHasText: boolean
Do the graduations have text?
Inherited from
XMLGaugeProps.graduationHasText
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:31
graduationLength
• graduationLength: number
The length of individual graduations.
Inherited from
XMLGaugeProps.graduationLength
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:29
id
• id: string
The class ID of the gauge.
Inherited from
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:41
maximum
• maximum: CompositeLogicXMLElement
The maximum value.
Inherited from
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:15
minimum
• minimum: CompositeLogicXMLElement
The minimum value.
Inherited from
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:13
numColumns
• numColumns: CompositeLogicXMLElement
The number of columns in the gauge.
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/Cylinder.ts:9
numRows
• numRows: CompositeLogicXMLElement
The number of boxes each column should have.
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/Cylinder.ts:11
redBlink
• redBlink: CompositeLogicXMLElement
Any triggers for blinking the element red.
Inherited from
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:44
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:125
referenceBugs
• referenceBugs: XMLGaugeReferenceBug[]
A reference bug definition, if present.
Inherited from
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:46
style
• style: Partial<XMLCylinderGaugeStyle>
The gauge styling.
Overrides
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/Cylinder.ts:15
tempOrder
• Optional tempOrder: number[]
What's the order of the hottest cylinders?
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/Cylinder.ts:13
title
• title: string
The title of the gauge.
Inherited from
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:25
unit
• unit: string
The units measured by the gauge.
Inherited from
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:27
value1
• value1: CompositeLogicXMLElement
The first possible value.
Inherited from
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:21
value2
• value2: CompositeLogicXMLElement
The second possible value for dual elements.
Inherited from
Defined in
src/sdk/components/XMLGauges/GaugeDefinitions/BaseGauge.ts:23