SelectionToolState

geovisto-map • Readme | API

---

geovisto-map / SelectionToolState

Class: SelectionToolState

This class provide functions for using selections.

Author

Jiri Hynek

Extends

• MapToolState

Implements

• ISelectionToolState

Constructors

new SelectionToolState()

new SelectionToolState(tool): SelectionToolState

It creates a tool state.

Parameters

• tool: ISelectionTool\<ISelectionToolProps, ISelectionToolDefaults, ISelectionToolState\<ISelectionToolProps, ISelectionToolDefaults, ISelectionToolConfig>, ISelectionToolConfig, IMapToolInitProps\<ISelectionToolConfig>, ISelectionToolAPI>

Returns

SelectionToolState

Overrides

MapToolState.constructor

Source

tools/selection/model/internal/tool/SelectionToolState.ts:28

Properties

selection

private selection: null | IMapSelection

Source

tools/selection/model/internal/tool/SelectionToolState.ts:23

Methods

deserialize()

deserialize(config): void

The metod takes config and deserializes the values.

Parameters

• config: ISelectionToolConfig

Returns

void

Implementation of

ISelectionToolState.deserialize

Overrides

MapToolState.deserialize

Source

tools/selection/model/internal/tool/SelectionToolState.ts:48

---

getIcon()

getIcon(): string

It returns the icon property of the tool state.

Returns

string

Implementation of

ISelectionToolState.getIcon

Inherited from

MapToolState.getIcon

Source

model/internal/tool/MapToolState.ts:120

---

getId()

getId(): string

It returns the id property of the tool state.

Returns

string

Implementation of

ISelectionToolState.getId

Inherited from

MapToolState.getId

Source

model/internal/object/MapObjectState.ts:87

---

getLabel()

getLabel(): string

It returns the label property of the tool state.

Returns

string

Implementation of

ISelectionToolState.getLabel

Inherited from

MapToolState.getLabel

Source

model/internal/tool/MapToolState.ts:104

---

getMap()

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

It returns the map property of the tool state.

Returns

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

Implementation of

ISelectionToolState.getMap

Inherited from

MapToolState.getMap

Source

model/internal/tool/MapToolState.ts:136

---

getMapObject()

protected getMapObject(): IMapObject\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectState\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>

It makes the map object visible to extended classes.

Returns

IMapObject\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectState\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>

Inherited from

MapToolState.getMapObject

Source

model/internal/object/MapObjectState.ts:39

---

getSelection()

getSelection(): null | IMapSelection

It returns the selection property of the tool state.

Returns

null | IMapSelection

Implementation of

ISelectionToolState.getSelection

Source

tools/selection/model/internal/tool/SelectionToolState.ts:83

---

getType()

getType(): string

It returns the type property of the tool state.

Returns

string

Implementation of

ISelectionToolState.getType

Inherited from

MapToolState.getType

Source

model/internal/object/MapObjectState.ts:80

---

initialize()

initialize(defaults, props, initProps): void

It resets state with respect to initial props.

Parameters

• defaults: ISelectionToolDefaults

• props: ISelectionToolProps

• initProps: IMapToolInitProps\<ISelectionToolConfig>

Returns

void

Implementation of

ISelectionToolState.initialize

Overrides

MapToolState.initialize

Source

tools/selection/model/internal/tool/SelectionToolState.ts:35

---

isEnabled()

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns

boolean

Implementation of

ISelectionToolState.isEnabled

Inherited from

MapToolState.isEnabled

Source

model/internal/tool/MapToolState.ts:88

---

serialize()

serialize(defaults): ISelectionToolConfig

The method serializes the tool state. Optionally, defaults can be set if property is undefined.

Parameters

• defaults: undefined | ISelectionToolDefaults

Returns

ISelectionToolConfig

Implementation of

ISelectionToolState.serialize

Overrides

MapToolState.serialize

Source

tools/selection/model/internal/tool/SelectionToolState.ts:65

---

setEnabled()

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters

• enabled: boolean

Returns

void

Implementation of

ISelectionToolState.setEnabled

Inherited from

MapToolState.setEnabled

Source

model/internal/tool/MapToolState.ts:97

---

setIcon()

setIcon(icon): void

It sets the icon property of the tool state.

Parameters

• icon: string

Returns

void

Implementation of

ISelectionToolState.setIcon

Inherited from

MapToolState.setIcon

Source

model/internal/tool/MapToolState.ts:129

---

setId()

setId(id): void

It sets the id property of the tool state.

Parameters

• id: string

Returns

void

Implementation of

ISelectionToolState.setId

Inherited from

MapToolState.setId

Source

model/internal/object/MapObjectState.ts:96

---

setLabel()

setLabel(label): void

It sets the label property of the tool state.

Parameters

• label: string

Returns

void

Implementation of

ISelectionToolState.setLabel

Inherited from

MapToolState.setLabel

Source

model/internal/tool/MapToolState.ts:113

---

setMap()

protected setMap(map): void

It sets the map property of the tool state.

Parameters

• map: IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

Returns

void

Inherited from

MapToolState.setMap

Source

model/internal/tool/MapToolState.ts:145

---

setSelection()

setSelection(selection): void

It sets the selection property of the tool state.

Parameters

• selection: null | IMapSelection

Returns

void

Implementation of

ISelectionToolState.setSelection

Source

tools/selection/model/internal/tool/SelectionToolState.ts:92