Skip to main content

Class: XMLTextGauge

A text gauge display element.

Hierarchy​

  • BaseGauge<XMLTextElementProps & XMLHostedLogicGauge>

    ↳ XMLTextGauge

Constructors​

constructor​

• new XMLTextGauge(props): XMLTextGauge

Creates an instance of a DisplayComponent.

Parameters​

NameTypeDescription
propsXMLTextElementProps & XMLHostedLogicGaugeThe propertis of the component.

Returns​

XMLTextGauge

Inherited from​

BaseGauge.constructor

Defined in​

sdk/components/FSComponent.ts:73

Properties​

context​

• Optional context: [] = undefined

The context on this component, if any.

Inherited from​

BaseGauge.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​

BaseGauge.contextType

Defined in​

sdk/components/FSComponent.ts:67

props​

• props: XMLTextElementProps & XMLHostedLogicGauge & ComponentProps

The properties of the component.

Inherited from​

BaseGauge.props

Defined in​

sdk/components/FSComponent.ts:61

Methods​

destroy​

▸ destroy(): void

Destroys this component.

Returns​

void

Inherited from​

BaseGauge.destroy

Defined in​

sdk/components/FSComponent.ts:98

getContext​

▸ getContext(context): never

Gets a context data subscription from the context collection.

Parameters​

NameTypeDescription
contextneverThe 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​

BaseGauge.getContext

Defined in​

sdk/components/FSComponent.ts:106

initGauge​

▸ initGauge(): void

Initialize the rendered gauge.

Returns​

void

Overrides​

BaseGauge.initGauge

Defined in​

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/TextGauge.tsx:62

onAfterRender​

▸ onAfterRender(): void

Perform scaling and margin adjustment then render and initialize the gauge.

Returns​

void

Inherited from​

BaseGauge.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​

BaseGauge.onBeforeRender

Defined in​

sdk/components/FSComponent.ts:80

render​

▸ render(): VNode

Render the gauge.

Returns​

VNode

A VNode

Inherited from​

BaseGauge.render

Defined in​

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/BaseGauge.tsx:59

renderGauge​

▸ renderGauge(): VNode

Render a text gauge

Returns​

VNode

A VNode

Overrides​

BaseGauge.renderGauge

Defined in​

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/EngineInstruments/TextGauge.tsx:71