Class: WaypointIcon

A waypoint icon.

Hierarchy

• WaypointComponent<WaypointIconProps>

  ↳ WaypointIcon

Constructors

constructor

• new WaypointIcon(props): WaypointIcon

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	WaypointIconProps	The propertis of the component.

Returns

WaypointIcon

Inherited from

WaypointComponent.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

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

WaypointComponent.contextType

Defined in

src/sdk/components/FSComponent.ts:67

---

props

• props: WaypointIconProps & ComponentProps

The properties of the component.

Inherited from

WaypointComponent.props

Defined in

src/sdk/components/FSComponent.ts:61

Methods

destroy

▸ destroy(): void

Returns

void

Inherit Doc

Overrides

WaypointComponent.destroy

Defined in

src/garminsdk/components/waypoint/WaypointIcon.tsx:164

---

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

WaypointComponent.getContext

Defined in

src/sdk/components/FSComponent.ts:106

---

onAfterRender

▸ onAfterRender(): void

Returns

void

Inherit Doc

Overrides

WaypointComponent.onAfterRender

Defined in

src/garminsdk/components/waypoint/WaypointIcon.tsx:49

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

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

Overrides

WaypointComponent.onWaypointChanged

Defined in

src/garminsdk/components/waypoint/WaypointIcon.tsx:60

---

render

▸ render(): VNode

Returns

VNode

Inherit Doc

Overrides

WaypointComponent.render

Defined in

src/garminsdk/components/waypoint/WaypointIcon.tsx:136