Class: NextGenMapWaypointStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:76

A utility class for generating next-generation (NXi, G3000, etc) Garmin map waypoint styles.

Constructors

Constructor

new NextGenMapWaypointStyles(): NextGenMapWaypointStyles

Returns

NextGenMapWaypointStyles

Methods

flightPlanIconStyles()

static flightPlanIconStyles(active, basePriority, scale): (waypoint) => MapWaypointIconStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:320

Creates a function which retrieves next-generation (NXi, G3000, etc) icon styles for flight plan waypoints.

Parameters

Parameter	Type	Default value	Description
active	boolean	undefined	Whether to retrieve styles for active flight plan waypoints.
basePriority	number	undefined	The base icon render priority. Icon priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
scale	number	1	The scaling factor for the icons. The larger the value, the larger the rendered icons. Defaults to 1.

Returns

A function which retrieves next-generation (NXi, G3000, etc) icon styles for flight plan waypoints.

(waypoint): MapWaypointIconStyles

Parameters

Parameter	Type
waypoint	Waypoint

Returns

MapWaypointIconStyles

---

flightPlanLabelStyles()

static flightPlanLabelStyles(active, basePriority, fontType, scale): (waypoint) => MapWaypointLabelStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:376

Creates a function which retrieves next-generation (NXi, G3000, etc) label styles for flight plan waypoints.

Parameters

Parameter	Type	Default value	Description
active	boolean	undefined	Whether to retrieve styles for active flight plan waypoints.
basePriority	number	undefined	The base label render priority. Label priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
fontType	"Roboto" | "DejaVu"	undefined	The type of font to use for the labels.
scale	number	1	The scaling factor for the labels. The larger the value, the larger the rendered labels. Defaults to 1.

Returns

A function which retrieves next-generation (NXi, G3000, etc) label styles for flight plan waypoints.

(waypoint): MapWaypointLabelStyles

Parameters

Parameter	Type
waypoint	Waypoint

Returns

MapWaypointLabelStyles

---

highlightIconStyles()

static highlightIconStyles(basePriority, scale): (waypoint) => MapWaypointIconHighlightStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:496

Creates a function which retrieves next-generation (NXi, G3000, etc) icon styles for highlighted waypoints.

Parameters

Parameter	Type	Default value	Description
basePriority	number	undefined	The base icon render priority. Icon priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
scale	number	1	The scaling factor for the icons. The larger the value, the larger the rendered icons. Defaults to 1.

Returns

A function which retrieves next-generation (NXi, G3000, etc) icon styles for highlighted waypoints.

(waypoint): MapWaypointIconHighlightStyles

Parameters

Parameter	Type
waypoint	Waypoint

Returns

MapWaypointIconHighlightStyles

---

highlightLabelStyles()

static highlightLabelStyles(basePriority, fontType, scale): (waypoint) => MapWaypointLabelStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:594

Creates a function which retrieves next-generation (NXi, G3000, etc) label styles for highlighted waypoints.

Parameters

Parameter	Type	Default value	Description
basePriority	number	undefined	The base label render priority. Label priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
fontType	"Roboto" | "DejaVu"	undefined	The type of font to use for the labels.
scale	number	1	The scaling factor for the labels. The larger the value, the larger the rendered label. Defaults to 1.

Returns

A function which retrieves next-generation (NXi, G3000, etc) label styles for highlighted waypoints.

(waypoint): MapWaypointLabelStyles

Parameters

Parameter	Type
waypoint	Waypoint

Returns

MapWaypointLabelStyles

---

hoverIconStyles()

static hoverIconStyles(basePriority, scale): (combinedRole, waypoint) => MapWaypointIconHighlightStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:784

Creates a function which retrieves next-generation (NXi, G3000, etc) icon styles for hovered waypoints.

Parameters

Parameter	Type	Default value	Description
basePriority	number	undefined	The base icon render priority. Icon priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
scale	number	1	The scaling factor for the icons. The larger the value, the larger the rendered icons. Defaults to 1.

Returns

A function which retrieves next-generation (NXi, G3000, etc) icon styles for hovered waypoints.

(combinedRole, waypoint): MapWaypointIconHighlightStyles

Parameters

Parameter	Type
combinedRole	0 | MapWaypointRenderRole
waypoint	Waypoint

Returns

MapWaypointIconHighlightStyles

---

hoverLabelStyles()

static hoverLabelStyles(basePriority, fontType, scale): (combinedRole, waypoint) => MapWaypointLabelStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:892

Creates a function which retrieves next-generation (NXi, G3000, etc) label styles for hovered waypoints.

Parameters

Parameter	Type	Default value	Description
basePriority	number	undefined	The base label render priority. Label priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
fontType	"Roboto" | "DejaVu"	undefined	The type of font to use for the labels.
scale	number	1	The scaling factor for the labels. The larger the value, the larger the rendered label. Defaults to 1.

Returns

A function which retrieves next-generation (NXi, G3000, etc) label styles for hovered waypoints.

(combinedRole, waypoint): MapWaypointLabelStyles

Parameters

Parameter	Type
combinedRole	0 | MapWaypointRenderRole
waypoint	Waypoint

Returns

MapWaypointLabelStyles

---

normalIconStyles()

static normalIconStyles(basePriority, scale): (waypoint) => MapWaypointIconStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:134

Creates a function which retrieves next-generation (NXi, G3000, etc) icon styles for normal waypoints.

Parameters

Parameter	Type	Default value	Description
basePriority	number	undefined	The base icon render priority. Icon priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
scale	number	1	The scaling factor for the icons. The larger the value, the larger the rendered icons. Defaults to 1.

Returns

A function which retrieves next-generation (NXi, G3000, etc) icon styles for normal waypoints.

(waypoint): MapWaypointIconStyles

Parameters

Parameter	Type
waypoint	Waypoint

Returns

MapWaypointIconStyles

---

normalLabelStyles()

static normalLabelStyles(basePriority, fontType, scale): (waypoint) => MapWaypointLabelStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:182

Creates a function which retrieves next-generation (NXi, G3000, etc) label styles for normal waypoints.

Parameters

Parameter	Type	Default value	Description
basePriority	number	undefined	The base label render priority. Label priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
fontType	"Roboto" | "DejaVu"	undefined	The type of font to use for the labels.
scale	number	1	The scaling factor for the labels. The larger the value, the larger the rendered labels. Defaults to 1.

Returns

A function which retrieves next-generation (NXi, G3000, etc) label styles for normal waypoints.

(waypoint): MapWaypointLabelStyles

Parameters

Parameter	Type
waypoint	Waypoint

Returns

MapWaypointLabelStyles

---

procPreviewIconStyles()

static procPreviewIconStyles(basePriority, scale): (waypoint) => MapWaypointIconStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:730

Creates a function which retrieves next-generation (NXi, G3000, etc) icon styles for procedure preview waypoints.

Parameters

Parameter	Type	Default value	Description
basePriority	number	undefined	The base icon render priority. Icon priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
scale	number	1	The scaling factor for the icons. The larger the value, the larger the rendered icons. Defaults to 1.

Returns

A function which retrieves next-generation (NXi, G3000, etc) icon styles for procedure preview waypoints.

(waypoint): MapWaypointIconStyles

Parameters

Parameter	Type
waypoint	Waypoint

Returns

MapWaypointIconStyles

---

procPreviewLabelStyles()

static procPreviewLabelStyles(basePriority, fontType, scale): (waypoint) => MapWaypointLabelStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:743

Creates a function which retrieves next-generation (NXi, G3000, etc) label styles for procedure preview waypoints.

Parameters

Parameter	Type	Default value	Description
basePriority	number	undefined	The base label render priority. Label priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
fontType	"Roboto" | "DejaVu"	undefined	The type of font to use for the labels.
scale	number	1	The scaling factor for the labels. The larger the value, the larger the rendered labels. Defaults to 1.

Returns

A function which retrieves next-generation (NXi, G3000, etc) label styles for procedure preview waypoints.

(waypoint): MapWaypointLabelStyles

Parameters

Parameter	Type
waypoint	Waypoint

Returns

MapWaypointLabelStyles

---

procTransitionPreviewIconStyles()

static procTransitionPreviewIconStyles(basePriority, scale): (waypoint) => MapWaypointIconStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:757

Creates a function which retrieves next-generation (NXi, G3000, etc) icon styles for procedure transition preview waypoints.

Parameters

Parameter	Type	Default value	Description
basePriority	number	undefined	The base icon render priority. Icon priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
scale	number	1	The scaling factor for the icons. The larger the value, the larger the rendered icons. Defaults to 1.

Returns

A function which retrieves next-generation (NXi, G3000, etc) icon styles for procedure transition preview waypoints.

(waypoint): MapWaypointIconStyles

Parameters

Parameter	Type
waypoint	Waypoint

Returns

MapWaypointIconStyles

---

procTransitionPreviewLabelStyles()

static procTransitionPreviewLabelStyles(basePriority, fontType, scale): (waypoint) => MapWaypointLabelStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:772

Creates a function which retrieves next-generation (NXi, G3000, etc) label styles for procedure transition preview waypoints.

Parameters

Parameter	Type	Default value	Description
basePriority	number	undefined	The base label render priority. Label priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
fontType	"Roboto" | "DejaVu"	undefined	The type of font to use for the labels.
scale	number	1	The scaling factor for the labels. The larger the value, the larger the rendered labels. Defaults to 1.

Returns

A function which retrieves next-generation (NXi, G3000, etc) label styles for procedure preview transition waypoints.

(waypoint): MapWaypointLabelStyles

Parameters

Parameter	Type
waypoint	Waypoint

Returns

MapWaypointLabelStyles

---

runwayOutlineIconStyles()

static runwayOutlineIconStyles(basePriority): (waypoint) => MapRunwayOutlineIconStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:290

Creates a function which retrieves next-generation (NXi, G3000, etc) icon styles for runway outline waypoints.

Parameters

Parameter	Type	Description
basePriority	number	The base icon render priority. Icon priorities are guaranteed to fall in the range [basePriority, basePriority + 1).

Returns

A function which retrieves next-generation (NXi, G3000, etc) icon styles for normal waypoints.

(waypoint): MapRunwayOutlineIconStyles

Parameters

Parameter	Type
waypoint	MapRunwayOutlineWaypoint

Returns

MapRunwayOutlineIconStyles

---

vnavIconStyles()

static vnavIconStyles(basePriority, scale): (waypoint) => MapWaypointIconStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:683

Creates a function which retrieves next-generation (NXi, G3000, etc) icon styles for VNAV waypoints.

Parameters

Parameter	Type	Default value	Description
basePriority	number	undefined	The base icon render priority. Icon priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
scale	number	1	The scaling factor for the icons. The larger the value, the larger the rendered icons. Defaults to 1.

Returns

A function which retrieves next-generation (NXi, G3000, etc) icon styles for VNAV waypoints.

(waypoint): MapWaypointIconStyles

Parameters

Parameter	Type
waypoint	Waypoint

Returns

MapWaypointIconStyles

---

vnavLabelStyles()

static vnavLabelStyles(basePriority, fontType, scale): (waypoint) => MapWaypointLabelStyles

Defined in: src/garminsdk/components/map/MapWaypointStyles.ts:700

Creates a function which retrieves next-generation (NXi, G3000, etc) label styles for VNAV waypoints.

Parameters

Parameter	Type	Default value	Description
basePriority	number	undefined	The base label render priority. Label priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
fontType	"Roboto" | "DejaVu"	undefined	The type of font to use for the labels.
scale	number	1	The scaling factor for the labels. The larger the value, the larger the rendered labels. Defaults to 1.

Returns

A function which retrieves next-generation (NXi, G3000, etc) label styles for VNAV waypoints.

(waypoint): MapWaypointLabelStyles

Parameters

Parameter	Type
waypoint	Waypoint

Returns

MapWaypointLabelStyles