Skip to main content

IMapToolsManager

geovisto-mapReadme | API


geovisto-map / IMapToolsManager

Interface: IMapToolsManager

This interface declares functions for using tools.

Author

Jiri Hynek

Extends

Methods

add()

add(object): void

It adds object to the list of objects.

Parameters

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

Returns

void

Inherited from

IMapObjectsManager.add

Source

model/types/object/IMapObjectsManager.ts:30


copy()

copy(): IMapToolsManager

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

Returns

IMapToolsManager

Source

model/types/tool/IMapToolsManager.ts:14


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>[]

Inherited from

IMapObjectsManager.getAll

Source

model/types/object/IMapObjectsManager.ts:13


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>

Inherited from

IMapObjectsManager.getById

Source

model/types/object/IMapObjectsManager.ts:68


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>[]

Inherited from

IMapObjectsManager.getByType

Source

model/types/object/IMapObjectsManager.ts:61


getIds()

getIds(): string[]

Help function which returns the list of object string identifiers.

Returns

string[]

Inherited from

IMapObjectsManager.getIds

Source

model/types/object/IMapObjectsManager.ts:54


getTypes()

getTypes(): string[]

Help function which returns the list of object string types.

Returns

string[]

Inherited from

IMapObjectsManager.getTypes

Source

model/types/object/IMapObjectsManager.ts:49


isEmpty()

isEmpty(): boolean

The function returns true if size() is 0.

Returns

boolean

Inherited from

IMapObjectsManager.isEmpty

Source

model/types/object/IMapObjectsManager.ts:23


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

Inherited from

IMapObjectsManager.remove

Source

model/types/object/IMapObjectsManager.ts:37


removeById()

removeById(id): void

It removes object of the given id from the list of objects.

Parameters

id: string

Returns

void

Inherited from

IMapObjectsManager.removeById

Source

model/types/object/IMapObjectsManager.ts:44


size()

size(): number

The function returns the number of objects.

Returns

number

Inherited from

IMapObjectsManager.size

Source

model/types/object/IMapObjectsManager.ts:18