Skip to main content

IMapSelection

geovisto-map • Readme | API


geovisto-map / IMapSelection

Interface: IMapSelection

The interface declares API for the selection of map elements.

The selection can affect multiple geographical items identified by some id (e.g., ISO 3166-1 alpha-3 - CZE, SVK, ...).

Author​

Jiri Hynek

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

Source​

tools/selection/model/types/selection/IMapSelection.ts:43


equals()​

equals(selection): boolean

It compares two selections.

Parameters​

• selection: null | IMapSelection

Returns​

boolean

Source​

tools/selection/model/types/selection/IMapSelection.ts:35


getIds()​

getIds(): string[]

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

Returns​

string[]

Source​

tools/selection/model/types/selection/IMapSelection.ts:28


getSrcIds()​

getSrcIds(): string[]

It returns identifiers of geographical items which were selected.

Returns​

string[]

Source​

tools/selection/model/types/selection/IMapSelection.ts:23


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>

Source​

tools/selection/model/types/selection/IMapSelection.ts:18