Skip to main content

Class: PfdWindDisplay

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/WindDisplay/PfdWindDisplay.tsx:35

A G3X Touch PFD wind display.

Extends​

Constructors​

Constructor​

new PfdWindDisplay(props): PfdWindDisplay

Defined in: src/sdk/components/FSComponent.ts:76

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsPfdWindDisplayPropsThe propertis of the component.

Returns​

PfdWindDisplay

Inherited from​

DisplayComponent.constructor

Properties​

context?​

optional context: [] = undefined

Defined in: src/sdk/components/FSComponent.ts:67

The context on this component, if any.

Inherited from​

DisplayComponent.context


contextType?​

readonly optional contextType: readonly [] = undefined

Defined in: src/sdk/components/FSComponent.ts:70

The type of context for this component, if any.

Inherited from​

DisplayComponent.contextType


props​

props: PfdWindDisplayProps & ComponentProps

Defined in: src/sdk/components/FSComponent.ts:64

The properties of the component.

Inherited from​

DisplayComponent.props

Methods​

destroy()​

destroy(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/WindDisplay/PfdWindDisplay.tsx:156

Destroys this component.

Returns​

void

Overrides​

DisplayComponent.destroy


getContext()​

protected getContext(context): never

Defined in: src/sdk/components/FSComponent.ts:109

Gets a context data subscription from the context collection.

Parameters​

ParameterTypeDescription
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​

DisplayComponent.getContext


onAfterRender()​

onAfterRender(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/WindDisplay/PfdWindDisplay.tsx:57

A callback that is called after the component is rendered.

Returns​

void

Overrides​

DisplayComponent.onAfterRender


onBeforeRender()​

onBeforeRender(): void

Defined in: src/sdk/components/FSComponent.ts:83

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

DisplayComponent.onBeforeRender


render()​

render(): VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/WindDisplay/PfdWindDisplay.tsx:131

Renders the component.

Returns​

VNode

A JSX element to be rendered.

Overrides​

DisplayComponent.render


sleep()​

sleep(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/WindDisplay/PfdWindDisplay.tsx:83

Puts this display to sleep. While this display is asleep, it is hidden and does not automatically update itself.

Returns​

void


wake()​

wake(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/WindDisplay/PfdWindDisplay.tsx:70

Wakes this display. While this display is awake, it will automatically update itself.

Returns​

void