SelectionTool

geovisto-map • Readme | API

---

geovisto-map / SelectionTool

Class: SelectionTool

This class provides the selection tool.

Author

Jiri Hynek

Extends

• MapTool

Implements

• ISelectionTool
• IMapFormControl

Constructors

new SelectionTool()

new SelectionTool(props?): SelectionTool

It creates a new tool with respect to the props.

Parameters

• props?: ISelectionToolProps

Returns

SelectionTool

Overrides

MapTool.constructor

Paramps

Source

tools/selection/model/internal/tool/SelectionTool.ts:49

Properties

mapForm

private mapForm: IMapForm

TODO: move to the tool state.

Source

tools/selection/model/internal/tool/SelectionTool.ts:42

---

api

static private api: ISelectionToolAPI = SelectionToolAPI

tool api

Source

tools/selection/model/internal/tool/SelectionTool.ts:37

Methods

copy()

copy(): ISelectionTool\<ISelectionToolProps, ISelectionToolDefaults, ISelectionToolState\<ISelectionToolProps, ISelectionToolDefaults, ISelectionToolConfig>, ISelectionToolConfig, IMapToolInitProps\<ISelectionToolConfig>, ISelectionToolAPI>

It creates a copy of the uninitialized tool.

Returns

ISelectionTool\<ISelectionToolProps, ISelectionToolDefaults, ISelectionToolState\<ISelectionToolProps, ISelectionToolDefaults, ISelectionToolConfig>, ISelectionToolConfig, IMapToolInitProps\<ISelectionToolConfig>, ISelectionToolAPI>

Implementation of

ISelectionTool.copy

Overrides

MapTool.copy

Source

tools/selection/model/internal/tool/SelectionTool.ts:56

---

create()

create(): this

It creates new filter tool.

Returns

this

Implementation of

ISelectionTool.create

Overrides

MapTool.create

Source

tools/selection/model/internal/tool/SelectionTool.ts:127

---

createDefaults()

createDefaults(): ISelectionToolDefaults

It creates new defaults of the tool.

Returns

ISelectionToolDefaults

Overrides

MapTool.createDefaults

Source

tools/selection/model/internal/tool/SelectionTool.ts:77

---

createMapForm()

protected createMapForm(): IMapForm

It creates new tab control.

Returns

IMapForm

Source

tools/selection/model/internal/tool/SelectionTool.ts:162

---

createState()

createState(): ISelectionToolState\<ISelectionToolProps, ISelectionToolDefaults, ISelectionToolConfig>

It creates the tool state.

Returns

ISelectionToolState\<ISelectionToolProps, ISelectionToolDefaults, ISelectionToolConfig>

Overrides

MapTool.createState

Source

tools/selection/model/internal/tool/SelectionTool.ts:91

---

getAPIGetter()

getAPIGetter(): undefined | ISelectionToolAPIGetter

It returns the tool API

Returns

undefined | ISelectionToolAPIGetter

Implementation of

ISelectionTool.getAPIGetter

Overrides

MapTool.getAPIGetter

Source

tools/selection/model/internal/tool/SelectionTool.ts:98

---

getDefaults()

getDefaults(): ISelectionToolDefaults

It returns default values of the selection tool.

Returns

ISelectionToolDefaults

Implementation of

ISelectionTool.getDefaults

Overrides

MapTool.getDefaults

Source

tools/selection/model/internal/tool/SelectionTool.ts:70

---

getId()

getId(): string

Help function which returns the id of the object.

Returns

string

Implementation of

ISelectionTool.getId

Inherited from

MapTool.getId

Source

model/internal/object/MapObject.ts:93

---

getMap()

getMap(): undefined | IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

Help function returns map which uses this tool.

Do not override this function. Use the state class instead.

Returns

undefined | IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

Implementation of

ISelectionTool.getMap

Inherited from

MapTool.getMap

Source

model/internal/tool/MapTool.ts:112

---

getMapForm()

getMapForm(): IMapForm

It returns a tab fragment.

Returns

IMapForm

Implementation of

IMapFormControl.getMapForm

Source

tools/selection/model/internal/tool/SelectionTool.ts:152

---

getProps()

getProps(): ISelectionToolProps

It returns the props given by the programmer.

Returns

ISelectionToolProps

Implementation of

ISelectionTool.getProps

Overrides

MapTool.getProps

Source

tools/selection/model/internal/tool/SelectionTool.ts:63

---

getState()

getState(): ISelectionToolState\<ISelectionToolProps, ISelectionToolDefaults, ISelectionToolConfig>

It returns the selection tool state.

Returns

ISelectionToolState\<ISelectionToolProps, ISelectionToolDefaults, ISelectionToolConfig>

Implementation of

ISelectionTool.getState

Overrides

MapTool.getState

Source

tools/selection/model/internal/tool/SelectionTool.ts:84

---

getType()

getType(): string

Help function which returns the type of the object.

Returns

string

Implementation of

ISelectionTool.getType

Inherited from

MapTool.getType

Source

model/internal/object/MapObject.ts:86

---

handleEvent()

handleEvent(event): void

This function is called when a custom event is invoked.

Parameters

• event: IMapEvent\<IMapObject\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectState\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>>

Returns

void

Overrides

MapTool.handleEvent

Source

tools/selection/model/internal/tool/SelectionTool.ts:171

---

initialize()

initialize(initProps): this

Overrides the super method.

Parameters

• initProps: IMapToolInitProps\<ISelectionToolConfig>

Returns

this

Implementation of

ISelectionTool.initialize

Overrides

MapTool.initialize

Source

tools/selection/model/internal/tool/SelectionTool.ts:109

---

initializeAPI()

protected initializeAPI(): void

Help method which initializes the API.

Returns

void

Source

tools/selection/model/internal/tool/SelectionTool.ts:117

---

isEnabled()

isEnabled(): boolean

Help getter which returns enabled property of state.

Do not override this function. Use the state class instead.

Returns

boolean

Implementation of

ISelectionTool.isEnabled

Inherited from

MapTool.isEnabled

Source

model/internal/tool/MapTool.ts:130

---

isSingleton()

isSingleton(): boolean

Help getter which returns a logtical value whether the tool type is singleton.

Returns

boolean

Implementation of

ISelectionTool.isSingleton

Inherited from

MapTool.isSingleton

Source

model/internal/tool/MapTool.ts:81

---

setEnabled()

setEnabled(enabled): void

Some tools might be dynamicaly enabled/disabled. This function is called externally when the tool is enabled/disabled.

Override this function, if needed.

Parameters

• enabled: boolean

Returns

void

Implementation of

ISelectionTool.setEnabled

Inherited from

MapTool.setEnabled

Source

model/internal/tool/MapTool.ts:142

---

setProps()

protected setProps(props): void

It updates the props.

Parameters

• props: IMapObjectProps

Returns

void

Inherited from

MapTool.setProps

Source

model/internal/object/MapObject.ts:38

---

setSelection()

setSelection(selection): void

Parameters

• selection: null | IMapSelection

Returns

void

Implementation of

ISelectionTool.setSelection

Paramection

Source

tools/selection/model/internal/tool/SelectionTool.ts:138

---

switchEnabled()

switchEnabled(): void

Help function which switches enabled state (enabled/disabled).

Do not override this function. Use setEnabled instead.

Returns

void

Implementation of

ISelectionTool.switchEnabled

Inherited from

MapTool.switchEnabled

Source

model/internal/tool/MapTool.ts:158