Class: XMLCircleGauge
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/DialGauge.tsx:352
A new circular gauge
Extends
BaseGauge
<Partial
<XMLCircularGaugeProps
> &XMLHostedLogicGauge
>
Constructors
Constructor
new XMLCircleGauge(
props
):XMLCircleGauge
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/DialGauge.tsx:383
Create an XMLCircleGaugue.
Parameters
Parameter | Type | Description |
---|---|---|
props | Partial <XMLCircularGaugeProps > & XMLHostedLogicGauge | The properties for the gauge. |
Returns
XMLCircleGauge
Overrides
Properties
context?
optional
context: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
props
props:
Partial
<XMLCircularGaugeProps
> &XMLHostedLogicGauge
&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
Methods
destroy()
destroy():
void
Defined in: sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
Inherited from
getContext()
protected
getContext(context
):never
Defined in: sdk/components/FSComponent.ts:106
Gets a context data subscription from the context collection.
Parameters
Parameter | Type | Description |
---|---|---|
context | never | The context to get the subscription for. |
Returns
never
The requested context.
Throws
An error if no data for the specified context type could be found.
Inherited from
initGauge()
protected
initGauge():void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/DialGauge.tsx:423
Initialize the rendered gauge.
Returns
void
Overrides
onAfterRender()
onAfterRender():
void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/BaseGauge.tsx:20
Perform scaling and margin adjustment then render and initialize the gauge.
Returns
void
Inherited from
onBeforeRender()
onBeforeRender():
void
Defined in: sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
render()
render():
VNode
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/BaseGauge.tsx:59
Render the gauge.
Returns
VNode
A VNode
Inherited from
renderGauge()
protected
renderGauge():VNode
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/DialGauge.tsx:627
Render a circle gauge
Returns
VNode
A VNode
Overrides
updateMaxValue()
updateMaxValue(
max
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/DialGauge.tsx:525
Update the maximum value.
Parameters
Parameter | Type | Description |
---|---|---|
max | number | The new max value. |
Returns
void
updateMinValue()
updateMinValue(
min
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/DialGauge.tsx:536
Update the minimum value.
Parameters
Parameter | Type | Description |
---|---|---|
min | number | The new min value. |
Returns
void
updateValue()
updateValue(
value
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/DialGauge.tsx:486
Update the value.
Parameters
Parameter | Type | Description |
---|---|---|
value | number | The new value to set. |
Returns
void
describeArc()
static
describeArc(center
,radius
,startAngle
,endAngle
):string
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/DialGauge.tsx:585
Construct an SVG path string for a given arc based on its coordinates and radius.
Parameters
Parameter | Type | Description |
---|---|---|
center | Cartesian | The cartesian center of the arc. |
radius | number | The radius in pixels. |
startAngle | number | The starting azimuth of the arc in degrees. |
endAngle | number | The final azimuth of the arc in degrees. |
Returns
string
A string describing an SVG path.
distanceFromYOrigin()
static
distanceFromYOrigin(center
,radius
,angle
):number
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/DialGauge.tsx:616
Determine how far from the Y origin a cartesian point is.
Parameters
Parameter | Type | Description |
---|---|---|
center | Cartesian | The cartesian center. |
radius | number | The radius in pixels. |
angle | number | The angle in degrees. |
Returns
number
The distance from the origin in pixels.
heightOfArc()
static
heightOfArc(center
,radius
,startAngle
,endAngle
):number
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/DialGauge.tsx:605
Determine the height "below the line" of the arc in pixels.
Parameters
Parameter | Type | Description |
---|---|---|
center | Cartesian | The cartesian center of the arc. |
radius | number | The radius in pixels. |
startAngle | number | The starting azimuth of the arc in degrees. |
endAngle | number | The final azimuth of the arc in degrees |
Returns
number
An integer with the pixels.
polarToCartesian()
static
polarToCartesian(center
,radius
,azimuth
):Cartesian
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/DialGauge.tsx:568
Given a cartesian origin and a set of polar coordinates, find the cartesian point that represents the polar location in the cartesian grid.
Parameters
Parameter | Type | Description |
---|---|---|
center | Cartesian | The cartesian center. |
radius | number | The radiun in pixels. |
azimuth | number | The angle coordinate in degrees. |
Returns
Cartesian
The cartesian point represented by the polar one.