Class: WaypointComponent<T>
An abstract component which is bound to a waypoint.
Type parameters
Name | Type |
---|---|
T | extends WaypointComponentProps |
Hierarchy
DisplayComponent
<T
>↳
WaypointComponent
↳↳
WaypointIcon
Constructors
constructor
• new WaypointComponent<T
>(props
): WaypointComponent
<T
>
Creates an instance of a DisplayComponent.
Type parameters
Name | Type |
---|---|
T | extends WaypointComponentProps |
Parameters
Name | Type | Description |
---|---|---|
props | T | The propertis of the component. |
Returns
Inherited from
DisplayComponent<T>.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
context
• Optional
context: [] = undefined
The context on this component, if any.
Inherited from
DisplayComponent.context
Defined in
src/sdk/components/FSComponent.ts:64
contextType
• Optional
Readonly
contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
Defined in
src/sdk/components/FSComponent.ts:67
props
• props: T
& ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Returns
void
Overrides
DisplayComponent.destroy
Defined in
src/garminsdk/components/waypoint/WaypointComponent.tsx:34
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
DisplayComponent.getContext
Defined in
src/sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(): void
Returns
void
Overrides
DisplayComponent.onAfterRender
Defined in
src/garminsdk/components/waypoint/WaypointComponent.tsx:18
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
Defined in
src/sdk/components/FSComponent.ts:80
onWaypointChanged
▸ onWaypointChanged(waypoint
): void
A callback which is called when this component's waypoint changes.
Parameters
Name | Type | Description |
---|---|---|
waypoint | null | Waypoint | The new waypoint. |
Returns
void
Defined in
src/garminsdk/components/waypoint/WaypointComponent.tsx:27
render
▸ render(): VNode
Returns
VNode
Overrides
DisplayComponent.render
Defined in
src/garminsdk/components/waypoint/WaypointComponent.tsx:31