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