Skip to main content

Class: NextGenMapWaypointStyles

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

Constructors

constructor

new NextGenMapWaypointStyles(): NextGenMapWaypointStyles

Returns

NextGenMapWaypointStyles

Methods

flightPlanIconStyles

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

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

Parameters

NameTypeDefault 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

fn

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

▸ (waypoint): MapWaypointIconStyles

Parameters
NameType
waypointWaypoint
Returns

MapWaypointIconStyles

Defined in

src/garminsdk/components/map/MapWaypointStyles.ts:238


flightPlanLabelStyles

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

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

Parameters

NameTypeDefault 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

fn

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

▸ (waypoint): MapWaypointLabelStyles

Parameters
NameType
waypointWaypoint
Returns

MapWaypointLabelStyles

Defined in

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


highlightIconStyles

highlightIconStyles(basePriority, scale?): (waypoint: Waypoint) => MapWaypointIconHighlightStyles

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

Parameters

NameTypeDefault 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

fn

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

▸ (waypoint): MapWaypointIconHighlightStyles

Parameters
NameType
waypointWaypoint
Returns

MapWaypointIconHighlightStyles

Defined in

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


highlightLabelStyles

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

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

Parameters

NameTypeDefault 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

fn

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

▸ (waypoint): MapWaypointLabelStyles

Parameters
NameType
waypointWaypoint
Returns

MapWaypointLabelStyles

Defined in

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


normalIconStyles

normalIconStyles(basePriority, scale?): (waypoint: Waypoint) => MapWaypointIconStyles

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

Parameters

NameTypeDefault 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

fn

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

▸ (waypoint): MapWaypointIconStyles

Parameters
NameType
waypointWaypoint
Returns

MapWaypointIconStyles

Defined in

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


normalLabelStyles

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

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

Parameters

NameTypeDefault 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

fn

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

▸ (waypoint): MapWaypointLabelStyles

Parameters
NameType
waypointWaypoint
Returns

MapWaypointLabelStyles

Defined in

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


procPreviewIconStyles

procPreviewIconStyles(basePriority, scale?): (waypoint: Waypoint) => MapWaypointIconStyles

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

Parameters

NameTypeDefault 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

fn

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

▸ (waypoint): MapWaypointIconStyles

Parameters
NameType
waypointWaypoint
Returns

MapWaypointIconStyles

Defined in

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


procPreviewLabelStyles

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

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

Parameters

NameTypeDefault 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

fn

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

▸ (waypoint): MapWaypointLabelStyles

Parameters
NameType
waypointWaypoint
Returns

MapWaypointLabelStyles

Defined in

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


procTransitionPreviewIconStyles

procTransitionPreviewIconStyles(basePriority, scale?): (waypoint: Waypoint) => MapWaypointIconStyles

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

Parameters

NameTypeDefault 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

fn

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

▸ (waypoint): MapWaypointIconStyles

Parameters
NameType
waypointWaypoint
Returns

MapWaypointIconStyles

Defined in

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


procTransitionPreviewLabelStyles

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

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

Parameters

NameTypeDefault 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

fn

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

▸ (waypoint): MapWaypointLabelStyles

Parameters
NameType
waypointWaypoint
Returns

MapWaypointLabelStyles

Defined in

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


runwayOutlineIconStyles

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

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

Parameters

NameTypeDescription
basePrioritynumberThe base icon render priority. Icon priorities are guaranteed to fall in the range [basePriority, basePriority + 1).

Returns

fn

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

▸ (waypoint): MapRunwayOutlineIconStyles

Parameters
NameType
waypointMapRunwayOutlineWaypoint
Returns

MapRunwayOutlineIconStyles

Defined in

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


vnavIconStyles

vnavIconStyles(basePriority, scale?): (waypoint: Waypoint) => MapWaypointIconStyles

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

Parameters

NameTypeDefault 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

fn

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

▸ (waypoint): MapWaypointIconStyles

Parameters
NameType
waypointWaypoint
Returns

MapWaypointIconStyles

Defined in

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


vnavLabelStyles

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

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

Parameters

NameTypeDefault 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

fn

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

▸ (waypoint): MapWaypointLabelStyles

Parameters
NameType
waypointWaypoint
Returns

MapWaypointLabelStyles

Defined in

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