Skip to main content

Class: WaypointRegion

A text display for waypoint region.

Hierarchy

Constructors

constructor

new WaypointRegion(props): WaypointRegion

Creates an instance of a DisplayComponent.

Parameters

NameTypeDescription
propsWaypointRegionPropsThe propertis of the component.

Returns

WaypointRegion

Inherited from

WaypointComponent<WaypointRegionProps>.constructor

Defined in

sdk/components/FSComponent.ts:73

Properties

context

Optional context: [] = undefined

The context on this component, if any.

Inherited from

WaypointComponent.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

WaypointComponent.contextType

Defined in

sdk/components/FSComponent.ts:67


props

props: WaypointRegionProps & ComponentProps

The properties of the component.

Inherited from

WaypointComponent.props

Defined in

sdk/components/FSComponent.ts:61


textSub

Protected Readonly textSub: ComputedSubject<null | Waypoint, string>

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Waypoint/WaypointRegion.tsx:18

Methods

destroy

destroy(): void

Returns

void

Inherited from

WaypointComponent.destroy

Defined in

garminsdk/components/waypoint/WaypointComponent.tsx:34


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

WaypointComponent.getContext

Defined in

sdk/components/FSComponent.ts:106


onAfterRender

onAfterRender(): void

Returns

void

Inherited from

WaypointComponent.onAfterRender

Defined in

garminsdk/components/waypoint/WaypointComponent.tsx:18


onBeforeRender

onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

WaypointComponent.onBeforeRender

Defined in

sdk/components/FSComponent.ts:80


onWaypointChanged

onWaypointChanged(waypoint): void

Parameters

NameType
waypointnull | Waypoint

Returns

void

Overrides

WaypointComponent.onWaypointChanged

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Waypoint/WaypointRegion.tsx:43


render

render(): VNode

Returns

VNode

Overrides

WaypointComponent.render

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Waypoint/WaypointRegion.tsx:48