Skip to main content

Class: G3XNearestMapBuilder

Builds G3X Touch nearest maps.

Constructors

constructor

new G3XNearestMapBuilder(): G3XNearestMapBuilder

Returns

G3XNearestMapBuilder

Methods

build

build<MapBuilder>(mapBuilder, options): MapBuilder

Configures a map builder to generate a G3X Touch nearest map.

The controller [GarminMapKeys.Range]: MapRangeController is added to the map context and can be used to control the range of the map.

If drag-to-pan is supported, then the controller [G3XMapKeys.DragPan]: MapDragPanController is added to the map context and can be used to control drag-to-pan functionality.

The map builder will not be configured to apply a custom projected size, dead zone, or to automatically update the map.

Type parameters

NameType
MapBuilderextends MapSystemBuilder<any, any, any, any>

Parameters

NameTypeDescription
mapBuilderMapBuilderThe map builder to configure.
optionsG3XNearestMapOptionsOptions for configuring the map.

Returns

MapBuilder

The builder, after it has been configured.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Map/Assembled/G3XNearestMapBuilder.tsx:253