Type Alias: NextGenProcMapOptions
NextGenProcMapOptions =
object
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:23
Options for creating a next-generation (NXi, G3000, etc) Garmin procedure map.
Properties
airplaneIconAnchor
airplaneIconAnchor:
ReadonlyFloat64Array
|Subscribable
<ReadonlyFloat64Array
>
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:105
The point on the player airplane icon that is anchored to the airplane's position, or a subscribable which provides it. The point is expressed as a 2-tuple relative to the icon's width and height, with [0, 0] at the top left and [1, 1] at the bottom right.
airplaneIconOrientation?
optional
airplaneIconOrientation:MapOwnAirplaneIconOrientation
|Subscribable
<MapOwnAirplaneIconOrientation
>
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:108
The orientation of the player airplane icon. Defaults to MapOwnAirplaneIconOrientation.HeadingUp
.
airplaneIconSize
airplaneIconSize:
number
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:98
The size of the player airplane icon, in pixels.
airplaneIconSrc
airplaneIconSrc:
string
|Subscribable
<string
>
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:95
The URI of the player airplane icon's image asset
allowRelativeTerrainMode?
optional
allowRelativeTerrainMode:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:146
Whether to allow relative terrain mode. Defaults to true
. Ignored if useTerrainUserSettings
is false
or
settingManager
is not defined.
bingDelay?
optional
bingDelay:number
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:28
The amount of time, in milliseconds, to delay binding the map's Bing Map instance. Defaults to 0.
bingId
bingId:
string
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:25
The ID to assign to the map's bound Bing Map instance.
dataUpdateFreq
dataUpdateFreq:
number
|Subscribable
<number
>
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:31
The frequency, in hertz, with which the player airplane's properties are updated from event bus data.
defaultFocusRangeIndex?
optional
defaultFocusRangeIndex:number
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:89
The default map range index to apply when the procedure focus consists of only a single point in space. Defaults
to 17
(25 NM/50 KM with standard range arrays).
includeOrientationIndicator?
optional
includeOrientationIndicator:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:128
Whether to include an orientation indicator. Defaults to true
.
metricRangeArray?
optional
metricRangeArray: readonlyNumberUnitInterface
<UnitFamily.Distance
>[]
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:58
The map range array to use for metric units mode. Defaults to a standard range array.
miniCompassImgSrc?
optional
miniCompassImgSrc:string
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:125
The URI of the mini-compass's image asset. Required to display the mini-compass.
nauticalRangeArray?
optional
nauticalRangeArray: readonlyNumberUnitInterface
<UnitFamily.Distance
>[]
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:55
The map range array to use for nautical units mode. Defaults to a standard range array.
noGpsBannerText?
optional
noGpsBannerText:string
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:74
The text of the banner that is displayed when GPS position is not available. Defaults to 'NO GPS POSITION'
.
noHeadingAirplaneIconAnchor?
optional
noHeadingAirplaneIconAnchor:ReadonlyFloat64Array
|Subscribable
<ReadonlyFloat64Array
>
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:71
The point on the no-heading player airplane icon that is anchored to the airplane's position, or a subscribable which provides it. The point is expressed as a 2-tuple relative to the icon's width and height, with [0, 0] at the top left and [1, 1] at the bottom right.
noHeadingAirplaneIconSrc?
optional
noHeadingAirplaneIconSrc:string
|Subscribable
<string
>
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:64
The URI of the no-heading player airplane icon's image asset, or a subscribable which provides it.
nominalFocusMargins?
optional
nominalFocusMargins:ReadonlyFloat64Array
|Subscribable
<ReadonlyFloat64Array
>
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:83
A subscribable which provides the nominal focus margins, as [left, top, right, bottom]
in pixels. The nominal
margins define the offset of the boundaries of the focus region relative to the map's projected window,
excluding the dead zone. Positive values represent offsets toward the center of the window. When the flight plan
is focused, the focused elements of the plan are guaranteed to be contained within the focus region. Defaults to
[0, 0, 0, 0]
.
pointerBoundsOffset?
optional
pointerBoundsOffset:ReadonlyFloat64Array
|Subscribable
<ReadonlyFloat64Array
>
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:116
The offset of the boundary surrounding the area in which the pointer can freely move, from the edge of the
projected map, excluding the dead zone, or a subscribable which provides it. Expressed as
[left, top, right, bottom]
, relative to the width and height, as appropriate, of the projected map window. A
positive offset is directed toward the center of the map. Required to support the map pointer.
pointerInfoSize?
optional
pointerInfoSize:MapPointerInfoLayerSize
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:122
The size of the pointer information box. Required to display the pointer information box. Ignored if the map pointer is not supported.
rangeEndpoints?
optional
rangeEndpoints:ReadonlyFloat64Array
|Subscribable
<ReadonlyFloat64Array
>
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:52
The range endpoints of the map, as [x1, y1, x2, y2]
, where each component is expressed relative to the width or
height of the map's projected window, excluding the dead zone. Defaults to [0.5, 0.5, 0.5, 0.25]
.
rangeRingOptions
rangeRingOptions:
RangeRingOptions
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:92
Styling options for the range ring.
settingManager?
optional
settingManager:UserSettingManager
<Partial
<MapUserSettingTypes
>>
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:134
A user setting manager containing map settings. If not defined, map options will not be controlled by user settings.
supportDataIntegrity?
optional
supportDataIntegrity:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:61
Whether to support data integrity state. Defaults to true
.
targetOffset?
optional
targetOffset:ReadonlyFloat64Array
|Subscribable
<ReadonlyFloat64Array
>
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:46
The nominal projected target offset of the map, as [x, y]
, where each component is expressed relative to the
width or height of the map's projected window, excluding the dead zone. Defaults to [0, 0]
.
unitsSettingManager?
optional
unitsSettingManager:UnitsUserSettingManager
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:137
A display units user setting manager. If not defined, map display units will not be controlled by user settings.
useDeclutterUserSetting?
optional
useDeclutterUserSetting:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:152
Whether to bind the global declutter function to user settings. Defaults to true
. Ignored if settingManager
is
not defined.
useTerrainUserSettings?
optional
useTerrainUserSettings:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:140
Whether to bind terrain colors to user settings. Defaults to false
. Ignored if settingManager
is not defined.
waypointIconImageCache
waypointIconImageCache:
WaypointIconImageCache
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:34
The image cache from which to retrieve waypoint icon images.
waypointStyleFontType
waypointStyleFontType:
"Roboto"
|"DejaVu"
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:37
The font type to use for waypoint labels.
waypointStyleScale?
optional
waypointStyleScale:number
Defined in: src/garminsdk/components/map/assembled/NextGenProcMapBuilder.tsx:40
The scaling factor of waypoint icons and labels. Defaults to 1
.