Class: MapWaypointHighlightIcon<T>
An icon for a highlighted waypoint. This icon embellishes a pre-existing ("base") icon with a surrounding ring and background.
Type parameters
| Name | Type |
|---|---|
T | extends Waypoint |
Hierarchy
AbstractMapWaypointIcon<T>↳
MapWaypointHighlightIcon
Constructors
constructor
• new MapWaypointHighlightIcon<T>(baseIcon, priority, options?): MapWaypointHighlightIcon<T>
Constructor.
Type parameters
| Name | Type |
|---|---|
T | extends Waypoint |
Parameters
| Name | Type | Description |
|---|---|---|
baseIcon | AbstractMapWaypointIcon<T> | This icon's base waypoint icon. |
priority | number | Subscribable<number> | The render priority of this icon. Icons with higher priorities should be rendered above those with lower priorities. |
options? | MapWaypointHighlightIconOptions | Options with which to initialize this icon. |
Returns
Overrides
AbstractMapWaypointIcon\<T\>.constructor
Defined in
src/garminsdk/components/map/MapWaypointIcon.ts:97
Properties
anchor
• Readonly anchor: Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>
The anchor point of this icon, expressed relative to its width and height. [0, 0] is the top-left corner, and [1, 1] is the bottom-right corner.
Inherited from
AbstractMapWaypointIcon.anchor
Defined in
src/sdk/components/map/MapWaypointIcon.ts:86
bgColor
• Readonly bgColor: Subscribable<string>
The color of this icon's ring background.
Defined in
src/garminsdk/components/map/MapWaypointIcon.ts:88
offset
• Readonly offset: Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>
The offset of this icon from the projected position of its associated waypoint, as [x, y] in pixels.
Inherited from
AbstractMapWaypointIcon.offset
Defined in
src/sdk/components/map/MapWaypointIcon.ts:89
outlineColor
• Readonly outlineColor: Subscribable<string>
The color of the outline for this icon's ring.
Defined in
src/garminsdk/components/map/MapWaypointIcon.ts:85
outlineWidth
• Readonly outlineWidth: Subscribable<number>
The width of the outline for this icon's ring, in pixels.
Defined in
src/garminsdk/components/map/MapWaypointIcon.ts:82
priority
• Readonly priority: Subscribable<number>
Inherit Doc
Inherited from
AbstractMapWaypointIcon.priority
Defined in
src/sdk/components/map/MapWaypointIcon.ts:77
ringRadiusBuffer
• Readonly ringRadiusBuffer: Subscribable<number>
The buffer of the ring around this icon's base icon, in pixels.
Defined in
src/garminsdk/components/map/MapWaypointIcon.ts:73
size
• Readonly size: Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>
The size of this icon, as [width, height] in pixels.
Inherited from
AbstractMapWaypointIcon.size
Defined in
src/sdk/components/map/MapWaypointIcon.ts:80
strokeColor
• Readonly strokeColor: Subscribable<string>
The color of the stroke for this icon's ring.
Defined in
src/garminsdk/components/map/MapWaypointIcon.ts:79
strokeWidth
• Readonly strokeWidth: Subscribable<number>
The width of the stroke for this icon's ring, in pixels.
Defined in
src/garminsdk/components/map/MapWaypointIcon.ts:76
waypoint
• Readonly waypoint: T
The waypoint associated with this icon.
Inherited from
AbstractMapWaypointIcon.waypoint
Defined in
src/sdk/components/map/MapWaypointIcon.ts:100
tempVec2
▪ Static Protected Readonly tempVec2: Float64Array
Inherited from
AbstractMapWaypointIcon.tempVec2
Defined in
src/sdk/components/map/MapWaypointIcon.ts:74
Methods
draw
▸ draw(context, mapProjection): void
Parameters
| Name | Type |
|---|---|
context | CanvasRenderingContext2D |
mapProjection | MapProjection |
Returns
void
Inherit Doc
Inherited from
AbstractMapWaypointIcon.draw
Defined in
src/sdk/components/map/MapWaypointIcon.ts:113
drawIconAt
▸ drawIconAt(context, mapProjection, left, top): void
Parameters
| Name | Type |
|---|---|
context | CanvasRenderingContext2D |
mapProjection | MapProjection |
left | number |
top | number |
Returns
void
Inherit Doc
Overrides
AbstractMapWaypointIcon.drawIconAt
Defined in
src/garminsdk/components/map/MapWaypointIcon.ts:113