Class: NextGenMapWaypointStyles
A utility class for generating next-generation (NXi, G3000, etc) Garmin map waypoint styles.
Constructors
constructor
• new NextGenMapWaypointStyles(): NextGenMapWaypointStyles
Returns
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
Name | 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
fn
A function which retrieves next-generation (NXi, G3000, etc) icon styles for flight plan waypoints.
▸ (waypoint
): MapWaypointIconStyles
Parameters
Name | Type |
---|---|
waypoint | Waypoint |
Returns
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
Name | 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
fn
A function which retrieves next-generation (NXi, G3000, etc) label styles for flight plan waypoints.
▸ (waypoint
): MapWaypointLabelStyles
Parameters
Name | Type |
---|---|
waypoint | Waypoint |
Returns
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
Name | 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
fn
A function which retrieves next-generation (NXi, G3000, etc) icon styles for highlighted waypoints.
▸ (waypoint
): MapWaypointIconHighlightStyles
Parameters
Name | Type |
---|---|
waypoint | Waypoint |
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
Name | 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
fn
A function which retrieves next-generation (NXi, G3000, etc) label styles for highlighted waypoints.
▸ (waypoint
): MapWaypointLabelStyles
Parameters
Name | Type |
---|---|
waypoint | Waypoint |
Returns
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
Name | 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
fn
A function which retrieves next-generation (NXi, G3000, etc) icon styles for normal waypoints.
▸ (waypoint
): MapWaypointIconStyles
Parameters
Name | Type |
---|---|
waypoint | Waypoint |
Returns
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
Name | 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
fn
A function which retrieves next-generation (NXi, G3000, etc) label styles for normal waypoints.
▸ (waypoint
): MapWaypointLabelStyles
Parameters
Name | Type |
---|---|
waypoint | Waypoint |
Returns
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
Name | 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
fn
A function which retrieves next-generation (NXi, G3000, etc) icon styles for procedure preview waypoints.
▸ (waypoint
): MapWaypointIconStyles
Parameters
Name | Type |
---|---|
waypoint | Waypoint |
Returns
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
Name | 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
fn
A function which retrieves next-generation (NXi, G3000, etc) label styles for procedure preview waypoints.
▸ (waypoint
): MapWaypointLabelStyles
Parameters
Name | Type |
---|---|
waypoint | Waypoint |
Returns
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
Name | 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
fn
A function which retrieves next-generation (NXi, G3000, etc) icon styles for procedure transition preview waypoints.
▸ (waypoint
): MapWaypointIconStyles
Parameters
Name | Type |
---|---|
waypoint | Waypoint |
Returns
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
Name | 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
fn
A function which retrieves next-generation (NXi, G3000, etc) label styles for procedure preview transition waypoints.
▸ (waypoint
): MapWaypointLabelStyles
Parameters
Name | Type |
---|---|
waypoint | Waypoint |
Returns
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
Name | Type | Description |
---|---|---|
basePriority | number | The 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
Name | Type |
---|---|
waypoint | MapRunwayOutlineWaypoint |
Returns
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
Name | 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
fn
A function which retrieves next-generation (NXi, G3000, etc) icon styles for VNAV waypoints.
▸ (waypoint
): MapWaypointIconStyles
Parameters
Name | Type |
---|---|
waypoint | Waypoint |
Returns
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
Name | 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
fn
A function which retrieves next-generation (NXi, G3000, etc) label styles for VNAV waypoints.
▸ (waypoint
): MapWaypointLabelStyles
Parameters
Name | Type |
---|---|
waypoint | Waypoint |
Returns
Defined in
src/garminsdk/components/map/MapWaypointStyles.ts:664