Class: MapPointerController

Defined in: src/garminsdk/components/map/controllers/MapPointerController.ts:17

Controls the pointer of a map.

Extends

• MapSystemController<MapPointerControllerModules>

Constructors

Constructor

new MapPointerController(context): MapPointerController

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:30

Constructor.

Parameters

Parameter	Type	Description
context	MapSystemContext<MapPointerControllerModules, any, any, any>	This controller's map context.

Returns

MapPointerController

Inherited from

MapSystemController<MapPointerControllerModules>.constructor

Properties

context

protected readonly context: MapSystemContext<MapPointerControllerModules, any, any, any>

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:24

Inherited from

MapSystemController.context

---

pointerModule

protected readonly pointerModule: MapPointerModule

Defined in: src/garminsdk/components/map/controllers/MapPointerController.ts:20

Accessors

isAlive

Get Signature

get isAlive(): boolean

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:20

Whether this controller is alive.

Returns

boolean

Inherited from

MapSystemController.isAlive

Methods

destroy()

destroy(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:106

Destroys this controller.

Returns

void

Inherited from

MapSystemController.destroy

---

movePointer()

movePointer(dx, dy): void

Defined in: src/garminsdk/components/map/controllers/MapPointerController.ts:53

Moves the map pointer.

Parameters

Parameter	Type	Description
dx	number	The horizontal displacement, in pixels.
dy	number	The vertical dispacement, in pixels.

Returns

void

---

onAfterMapRender()

onAfterMapRender(ref): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:39

This method is called after this controller' map is rendered.

Parameters

Parameter	Type	Description
ref	MapSystemComponent	A reference to the rendered map.

Returns

void

Inherited from

MapSystemController.onAfterMapRender

---

onAfterUpdated()

onAfterUpdated(time, elapsed): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:78

This method is called immediately after this controller's map updates its layers.

Parameters

Parameter	Type	Description
time	number	The current time, as a Javascript timestamp.
elapsed	number	The elapsed time, in milliseconds, since the last update.

Returns

void

Inherited from

MapSystemController.onAfterUpdated

---

onBeforeUpdated()

onBeforeUpdated(time, elapsed): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:68

This method is called immediately before this controller's map updates its layers.

Parameters

Parameter	Type	Description
time	number	The current time, as a Javascript timestamp.
elapsed	number	The elapsed time, in milliseconds, since the last update.

Returns

void

Inherited from

MapSystemController.onBeforeUpdated

---

onDeadZoneChanged()

onDeadZoneChanged(deadZone): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:48

This method is called when the dead zone of this controller's map changes.

Parameters

Parameter	Type	Description
deadZone	ReadonlyFloat64Array	The map's new dead zone.

Returns

void

Inherited from

MapSystemController.onDeadZoneChanged

---

onMapDestroyed()

onMapDestroyed(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:99

This method is called when this controller's map is destroyed.

Returns

void

Inherited from

MapSystemController.onMapDestroyed

---

onMapProjectionChanged()

onMapProjectionChanged(mapProjection, changeFlags): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:58

This method is called when the projection of this controller's map changes.

Parameters

Parameter	Type	Description
mapProjection	MapProjection	The map projection.
changeFlags	number	Bit flags describing the type of change.

Returns

void

Inherited from

MapSystemController.onMapProjectionChanged

---

onSleep()

onSleep(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:92

This method is called when this controller's map is put to sleep.

Returns

void

Inherited from

MapSystemController.onSleep

---

onWake()

onWake(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:85

This method is called when this controller's map is awakened.

Returns

void

Inherited from

MapSystemController.onWake

---

setPointerActive()

setPointerActive(isActive): void

Defined in: src/garminsdk/components/map/controllers/MapPointerController.ts:26

Activates or deactivates the map pointer.

Parameters

Parameter	Type	Description
isActive	boolean	Whether to activate the map pointer.

Returns

void

---

targetPointer()

targetPointer(): void

Defined in: src/garminsdk/components/map/controllers/MapPointerController.ts:62

Sets the map target to the current position of the pointer. The pointer will also be moved to the new projected target position.

Returns

void

---

togglePointerActive()

togglePointerActive(): boolean

Defined in: src/garminsdk/components/map/controllers/MapPointerController.ts:43

Toggles activation of the map pointer.

Returns

boolean

Whether the map pointer is active after the toggle operation.