Class: MFDMapToggleSettingRow<T, P>
A map settings row which contains a toggle setting control.
Type parameters
Name | Type |
---|---|
T | extends keyof UserSettingValueFilter <MapUserSettingTypes , boolean > |
P | extends MFDMapToggleSettingRowProps <T > = MFDMapToggleSettingRowProps <T > |
Hierarchy
↳
MFDMapToggleSettingRow
Constructors
constructor
• new MFDMapToggleSettingRow<T
, P
>(props
): MFDMapToggleSettingRow
<T
, P
>
Creates an instance of a DisplayComponent.
Type parameters
Name | Type |
---|---|
T | extends "mapAutoNorthUpActive" | "mapGroundNorthUpActive" | "mapTerrainScaleShow" | "mapAirportLargeShow" | "mapAirportMediumShow" | "mapAirportSmallShow" | "mapVorShow" | "mapNdbShow" | "mapIntersectionShow" | "mapUserWaypointShow" | "mapAirspaceClassBShow" | "mapAirspaceClassCShow" | "mapAirspaceClassDShow" | "mapAirspaceRestrictedShow" | "mapAirspaceMoaShow" | "mapAirspaceOtherShow" | "mapTrafficShow" | "mapTrafficLabelShow" | "mapNexradShow" | "mapTrackVectorShow" | "mapAltitudeArcShow" | "mapWindVectorShow" |
P | extends MFDMapToggleSettingRowProps <T > = MFDMapToggleSettingRowProps <T > |
Parameters
Name | Type | Description |
---|---|---|
props | P | The propertis of the component. |
Returns
MFDMapToggleSettingRow
<T
, P
>
Inherited from
Defined in
sdk/components/FSComponent.ts:73
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: P
& 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
onAfterRender
▸ onAfterRender(node
): void
A callback that is called after the component is rendered.
Parameters
Name | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
MFDMapSettingsRow.onAfterRender
Defined in
sdk/components/FSComponent.ts:87
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
MFDMapSettingsRow.onBeforeRender
Defined in
sdk/components/FSComponent.ts:80
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MapSettings/MFDMapSettingsRow.tsx:27
renderLeftControl
▸ renderLeftControl(): null
| VNode
Renders this row's left setting control.
Returns
null
| VNode
Overrides
MFDMapSettingsRow.renderLeftControl
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MapSettings/MFDMapSettingsRow.tsx:97
renderRightControl
▸ renderRightControl(): null
| VNode
Renders this row's right setting control.
Returns
null
| VNode
Overrides
MFDMapSettingsRow.renderRightControl
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MapSettings/MFDMapSettingsRow.tsx:110