Abstract Class: WindOption
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/Overlays/Wind/WindOption.tsx:18
The Wind Option Component
Extends
DisplayComponent
<WindOptionProps
>
Extended by
Constructors
Constructor
new WindOption(
props
):WindOption
Defined in: sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | WindOptionProps | The propertis of the component. |
Returns
WindOption
Inherited from
DisplayComponent<WindOptionProps>.constructor
Properties
containerRef
protected
readonly
containerRef:NodeReference
<HTMLDivElement
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/Overlays/Wind/WindOption.tsx:19
context?
optional
context: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
DisplayComponent.context
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
props
props:
WindOptionProps
&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
DisplayComponent.props
Methods
destroy()
destroy():
void
Defined in: sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
Inherited from
DisplayComponent.destroy
getContext()
protected
getContext(context
):never
Defined in: sdk/components/FSComponent.ts:106
Gets a context data subscription from the context collection.
Parameters
Parameter | 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
onAfterRender()
onAfterRender(
node
):void
Defined in: sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
DisplayComponent.onAfterRender
onBeforeRender()
onBeforeRender():
void
Defined in: sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
render()
render():
VNode
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/Overlays/Wind/WindOption.tsx:56
Renders the component - to be overridden.
Returns
VNode
The component VNode.
Overrides
DisplayComponent.render
setVisible()
setVisible(
isVisible
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/Overlays/Wind/WindOption.tsx:47
Set as visible or not.
Parameters
Parameter | Type | Description |
---|---|---|
isVisible | boolean | is whether to set this visible or not. |
Returns
void
update()
abstract
protected
update():void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/Overlays/Wind/WindOption.tsx:25
Update the component data.
Returns
void