MapToolsManager

geovisto-map • Readme | API

---

geovisto-map / MapToolsManager

Class: MapToolsManager

This class provide functions for using tools.

Author

Jiri Hynek

Extends

• MapObjectsManager\<IMapTool>

Implements

• IMapToolsManager

Constructors

new MapToolsManager()

new MapToolsManager(tools): MapToolsManager

Parameters

• tools: IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>[]

Returns

MapToolsManager

Overrides

MapObjectsManager.constructor

Source

model/internal/tool/MapToolsManager.ts:12

Methods

add()

add(object): void

It adds object to the list of objects.

Override this function.

Parameters

• object: IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>

Returns

void

Implementation of

IMapToolsManager.add

Inherited from

MapObjectsManager.add

Source

model/internal/object/MapObjectsManager.ts:48

---

copy()

copy(): IMapToolsManager

It returns copy of the tools manager with copies of tools.

Returns

IMapToolsManager

Implementation of

IMapToolsManager.copy

Source

model/internal/tool/MapToolsManager.ts:19

---

getAll()

getAll(): IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>[]

The function returns available map objects.

Returns

IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>[]

Implementation of

IMapToolsManager.getAll

Inherited from

MapObjectsManager.getAll

Source

model/internal/object/MapObjectsManager.ts:23

---

getById()

getById(id): undefined | IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>

The function returns map object of given unique identifier.

Parameters

• id: string

Returns

undefined | IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>

Implementation of

IMapToolsManager.getById

Inherited from

MapObjectsManager.getById

Source

model/internal/object/MapObjectsManager.ts:123

---

getByType()

getByType(type): IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>[]

The function returns map objects of given type.

Parameters

• type: string

Returns

IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>[]

Implementation of

IMapToolsManager.getByType

Inherited from

MapObjectsManager.getByType

Source

model/internal/object/MapObjectsManager.ts:105

---

getIds()

getIds(): string[]

Help function which returns the list of object string labels (object types).

Returns

string[]

Implementation of

IMapToolsManager.getIds

Inherited from

MapObjectsManager.getIds

Source

model/internal/object/MapObjectsManager.ts:89

---

getTypes()

getTypes(): string[]

Help function which returns the list of object string labels (object types).

Returns

string[]

Implementation of

IMapToolsManager.getTypes

Inherited from

MapObjectsManager.getTypes

Source

model/internal/object/MapObjectsManager.ts:75

---

isEmpty()

isEmpty(): boolean

The function returns true if size() is 0.

Returns

boolean

Implementation of

IMapToolsManager.isEmpty

Inherited from

MapObjectsManager.isEmpty

Source

model/internal/object/MapObjectsManager.ts:37

---

remove()

remove(object): void

It removes object from the list of objects.

Parameters

• object: IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>

Returns

void

Implementation of

IMapToolsManager.remove

Inherited from

MapObjectsManager.remove

Source

model/internal/object/MapObjectsManager.ts:57

---

removeById()

removeById(id): void

It removes object from the list of objects.

Override this function.

Parameters

• id: string

Returns

void

Implementation of

IMapToolsManager.removeById

Inherited from

MapObjectsManager.removeById

Source

model/internal/object/MapObjectsManager.ts:68

---

size()

size(): number

The function returns number of objects.

Returns

number

Implementation of

IMapToolsManager.size

Inherited from

MapObjectsManager.size

Source

model/internal/object/MapObjectsManager.ts:30