Class: XMLHorizontalGauge
A horizontal bar gauge for displaying a single value.
Hierarchy
BaseGauge<Partial<XMLHorizontalGaugeProps> &XMLHostedLogicGauge>↳
XMLHorizontalGauge
Constructors
constructor
• new XMLHorizontalGauge(props): XMLHorizontalGauge
Create a horizontal gauge.
Parameters
| Name | Type | Description |
|---|---|---|
props | Partial<XMLHorizontalGaugeProps> & XMLHostedLogicGauge | The properties for the gauge. |
Returns
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/HorizontalBarGauge.tsx:790
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<XMLHorizontalGaugeProps> & 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/HorizontalBarGauge.tsx:804
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 horizontal bar gauge
Returns
VNode
A VNode
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/HorizontalBarGauge.tsx:856