Skip to main content

Class: NextGenMapWaypointStyles

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

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:238

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

Parameters

ParameterTypeDefault valueDescription
activebooleanundefinedWhether to retrieve styles for active flight plan waypoints.
basePrioritynumberundefinedThe base icon render priority. Icon priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
scalenumber1The 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
ParameterType
waypointWaypoint
Returns

MapWaypointIconStyles


flightPlanLabelStyles()

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

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

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

Parameters

ParameterTypeDefault valueDescription
activebooleanundefinedWhether to retrieve styles for active flight plan waypoints.
basePrioritynumberundefinedThe base label render priority. Label priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
fontType"Roboto" | "DejaVu"undefinedThe type of font to use for the labels.
scalenumber1The 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
ParameterType
waypointWaypoint
Returns

MapWaypointLabelStyles


highlightIconStyles()

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

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

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

Parameters

ParameterTypeDefault valueDescription
basePrioritynumberundefinedThe base icon render priority. Icon priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
scalenumber1The 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
ParameterType
waypointWaypoint
Returns

MapWaypointIconHighlightStyles


highlightLabelStyles()

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

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

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

Parameters

ParameterTypeDefault valueDescription
basePrioritynumberundefinedThe base label render priority. Label priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
fontType"Roboto" | "DejaVu"undefinedThe type of font to use for the labels.
scalenumber1The 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
ParameterType
waypointWaypoint
Returns

MapWaypointLabelStyles


normalIconStyles()

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

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

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

Parameters

ParameterTypeDefault valueDescription
basePrioritynumberundefinedThe base icon render priority. Icon priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
scalenumber1The 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
ParameterType
waypointWaypoint
Returns

MapWaypointIconStyles


normalLabelStyles()

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

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

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

Parameters

ParameterTypeDefault valueDescription
basePrioritynumberundefinedThe base label render priority. Label priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
fontType"Roboto" | "DejaVu"undefinedThe type of font to use for the labels.
scalenumber1The 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
ParameterType
waypointWaypoint
Returns

MapWaypointLabelStyles


procPreviewIconStyles()

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

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

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

Parameters

ParameterTypeDefault valueDescription
basePrioritynumberundefinedThe base icon render priority. Icon priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
scalenumber1The 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
ParameterType
waypointWaypoint
Returns

MapWaypointIconStyles


procPreviewLabelStyles()

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

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

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

Parameters

ParameterTypeDefault valueDescription
basePrioritynumberundefinedThe base label render priority. Label priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
fontType"Roboto" | "DejaVu"undefinedThe type of font to use for the labels.
scalenumber1The 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
ParameterType
waypointWaypoint
Returns

MapWaypointLabelStyles


procTransitionPreviewIconStyles()

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

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

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

Parameters

ParameterTypeDefault valueDescription
basePrioritynumberundefinedThe base icon render priority. Icon priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
scalenumber1The 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
ParameterType
waypointWaypoint
Returns

MapWaypointIconStyles


procTransitionPreviewLabelStyles()

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

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

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

Parameters

ParameterTypeDefault valueDescription
basePrioritynumberundefinedThe base label render priority. Label priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
fontType"Roboto" | "DejaVu"undefinedThe type of font to use for the labels.
scalenumber1The 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
ParameterType
waypointWaypoint
Returns

MapWaypointLabelStyles


runwayOutlineIconStyles()

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

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

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

Parameters

ParameterTypeDescription
basePrioritynumberThe 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
ParameterType
waypointMapRunwayOutlineWaypoint
Returns

MapRunwayOutlineIconStyles


vnavIconStyles()

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

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

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

Parameters

ParameterTypeDefault valueDescription
basePrioritynumberundefinedThe base icon render priority. Icon priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
scalenumber1The 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
ParameterType
waypointWaypoint
Returns

MapWaypointIconStyles


vnavLabelStyles()

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

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

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

Parameters

ParameterTypeDefault valueDescription
basePrioritynumberundefinedThe base label render priority. Label priorities are guaranteed to fall in the range [basePriority, basePriority + 1).
fontType"Roboto" | "DejaVu"undefinedThe type of font to use for the labels.
scalenumber1The 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
ParameterType
waypointWaypoint
Returns

MapWaypointLabelStyles