Skip to main content

Abstract Class: WaypointComponent<T>

Defined in: src/garminsdk/components/waypoint/WaypointComponent.tsx:14

An abstract component which is bound to a waypoint.

Extends

  • DisplayComponent<T>

Extended by

Type Parameters

Type Parameter
T extends WaypointComponentProps

Constructors

Constructor

new WaypointComponent<T>(props): WaypointComponent<T>

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

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsTThe propertis of the component.

Returns

WaypointComponent<T>

Inherited from

DisplayComponent<T>.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context


contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType


props

props: T & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/components/waypoint/WaypointComponent.tsx:34

Destroys this component.

Returns

void

Overrides

DisplayComponent.destroy


getContext()

protected getContext(context): never

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

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/garminsdk/components/waypoint/WaypointComponent.tsx:18

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:80

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender


onWaypointChanged()

protected onWaypointChanged(waypoint): void

Defined in: src/garminsdk/components/waypoint/WaypointComponent.tsx:27

A callback which is called when this component's waypoint changes.

Parameters

ParameterTypeDescription
waypointnull | WaypointThe new waypoint.

Returns

void


render()

abstract render(): VNode

Defined in: src/garminsdk/components/waypoint/WaypointComponent.tsx:31

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render