Skip to main content

MapSelection

geovisto-map • Readme | API

geovisto-map / MapSelection

Class: MapSelection

The class provides API for the selection of map elements. It wraps reference to the source element and list of identifiers of geographic items.

Author​

Jiri Hynek

Implements​

Constructors​

new MapSelection()​

new MapSelection(tool, srcIds): MapSelection

It creates a map selection.

Parameters​

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

• srcIds: string[]

Returns​

MapSelection

Source​

tools/selection/model/internal/selection/MapSelection.ts:26

Properties​

allIds​

private allIds: string[]

Source​

tools/selection/model/internal/selection/MapSelection.ts:18

srcIds​

private srcIds: string[]

Source​

tools/selection/model/internal/selection/MapSelection.ts:17

tool​

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

Source​

tools/selection/model/internal/selection/MapSelection.ts:16

Methods​

addIds()​

addIds(ids): string[]

It takes geographical items and returns the list of new ids which were added to the list of all ids.

Parameters​

• ids: string[]

Returns​

string[]

Implementation of​

IMapSelection.addIds

Source​

tools/selection/model/internal/selection/MapSelection.ts:81

equals()​

equals(selection): boolean

It compares two map selections.

Parameters​

• selection: null | IMapSelection

Returns​

boolean

Implementation of​

IMapSelection.equals

Source​

tools/selection/model/internal/selection/MapSelection.ts:58

getIds()​

getIds(): string[]

It returns identifiers of geographical items which were selected or affected by this selection.

Returns​

string[]

Implementation of​

IMapSelection.getIds

Source​

tools/selection/model/internal/selection/MapSelection.ts:49

getSrcIds()​

getSrcIds(): string[]

It returns identifiers of geographical items which were selected.

Returns​

string[]

Implementation of​

IMapSelection.getSrcIds

Source​

tools/selection/model/internal/selection/MapSelection.ts:42

getTool()​

getTool(): IMapTool\<IMapToolProps, IMapToolDefaults, IMapToolState\<IMapToolProps, IMapToolDefaults, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>>, IMapToolConfig, IMapToolInitProps\<IMapToolConfig>, IMapToolAPI>

It returns the tool of the selected element.

Returns​

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

Implementation of​

IMapSelection.getTool

Source​

tools/selection/model/internal/selection/MapSelection.ts:35