Skip to main content

SelectionToolEvent

geovisto-map • Readme | API

geovisto-map / SelectionToolEvent

Class: SelectionToolEvent

This class provides the map selection change event.

Author​

Jiri Hynek

Extends​

Implements​

Constructors​

new SelectionToolEvent()​

new SelectionToolEvent(selectionTool, selection): SelectionToolEvent

It initializes event.

Parameters​

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

• selection: null | IMapSelection

Returns​

SelectionToolEvent

Overrides​

MapChangeEvent.constructor

Source​

tools/selection/model/internal/event/SelectionToolEvent.ts:20

Methods​

getChangedObject()​

getChangedObject(): null | IMapSelection

Return the changed object.

Returns​

null | IMapSelection

Implementation of​

ISelectionToolEvent.getChangedObject

Inherited from​

MapChangeEvent.getChangedObject

Source​

model/internal/event/generic/MapChangeEvent.ts:26

getSource()​

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

It return source map object of the event.

Returns​

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

Implementation of​

ISelectionToolEvent.getSource

Inherited from​

MapChangeEvent.getSource

Source​

model/internal/event/generic/MapEvent.ts:32

getType()​

getType(): string

It returns string which identifies the event.

Returns​

string

Implementation of​

ISelectionToolEvent.getType

Inherited from​

MapChangeEvent.getType

Source​

model/internal/event/generic/MapEvent.ts:25

TYPE()​

static TYPE(): string

Type of the event.

Returns​

string

Source​

tools/selection/model/internal/event/SelectionToolEvent.ts:27