Class: BaseGauge<T>
An abstract base gauge component containing the universal logic for scaling and margin calculations so these don't need to be implemented in every gauge type.
Type parameters
| Name | Type |
|---|---|
T | extends Partial<XMLGaugeProps> |
Hierarchy
DisplayComponent<T>↳
BaseGauge↳↳
XMLTextGauge
Constructors
constructor
• new BaseGauge<T>(props): BaseGauge<T>
Creates an instance of a DisplayComponent.
Type parameters
| Name | Type |
|---|---|
T | extends Partial<XMLGaugeProps> |
Parameters
| Name | Type | Description |
|---|---|---|
props | T | The propertis of the component. |
Returns
BaseGauge<T>
Inherited from
DisplayComponent<T>.constructor
Defined in
sdk/components/FSComponent.ts:73
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
DisplayComponent.context
Defined in
sdk/components/FSComponent.ts:64
contextType
• Optional Readonly contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
Defined in
sdk/components/FSComponent.ts:67
props
• props: T & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Inherited from
DisplayComponent.destroy
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
DisplayComponent.getContext
Defined in
sdk/components/FSComponent.ts:106
initGauge
▸ initGauge(): void
The method to call to perform gauge initialization.
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/BaseGauge.tsx:15
onAfterRender
▸ onAfterRender(): void
Perform scaling and margin adjustment then render and initialize the gauge.
Returns
void
Overrides
DisplayComponent.onAfterRender
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
DisplayComponent.onBeforeRender
Defined in
sdk/components/FSComponent.ts:80
render
▸ render(): VNode
Render the gauge.
Returns
VNode
A VNode
Overrides
DisplayComponent.render
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/BaseGauge.tsx:59
renderGauge
▸ renderGauge(): VNode
The method to call to render the gauge into ourselves.
Returns
VNode
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/BaseGauge.tsx:12