Class: WaypointIcon

Defined in: src/garminsdk/components/waypoint/WaypointIcon.tsx:30

A waypoint icon.

Extends

• WaypointComponent<WaypointIconProps>

Constructors

Constructor

new WaypointIcon(props): WaypointIcon

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	WaypointIconProps	The propertis of the component.

Returns

WaypointIcon

Inherited from

WaypointComponent.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

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

WaypointComponent.contextType

---

props

props: WaypointIconProps & ComponentProps

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

The properties of the component.

Inherited from

WaypointComponent.props

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Overrides

WaypointComponent.destroy

---

getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

Parameter	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

---

onAfterRender()

onAfterRender(): void

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

A callback that is called after the component is rendered.

Returns

void

Overrides

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

WaypointComponent.onBeforeRender

---

onWaypointChanged()

protected onWaypointChanged(waypoint): void

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

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

Parameters

Parameter	Type	Description
waypoint	null | Waypoint	The new waypoint.

Returns

void

Overrides

WaypointComponent.onWaypointChanged

---

render()

render(): VNode

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

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

WaypointComponent.render