MapToolState

geovisto-map • Readme | API

---

geovisto-map / MapToolState

Class: MapToolState

This class manages state of the tool. It wraps the state since the tool can work with state objects which needs to be explicitly serialized.

Author

Jiri Hynek

Extends

• MapObjectState

Implements

• IMapToolState

Constructors

new MapToolState()

new MapToolState(tool): MapToolState

It creates a map object state.

Parameters

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

Returns

MapToolState

Overrides

MapObjectState.constructor

Source

model/internal/tool/MapToolState.ts:31

Properties

enabled

private enabled: boolean

Source

model/internal/tool/MapToolState.ts:17

---

icon

private icon: string

Source

model/internal/tool/MapToolState.ts:19

---

label

private label: string

Source

model/internal/tool/MapToolState.ts:18

---

map

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

map is set during the tool initialization

Source

model/internal/tool/MapToolState.ts:24

Methods

deserialize()

deserialize(config): void

The metod takes config and deserializes the values.

Parameters

• config: IMapToolConfig

Returns

void

Implementation of

IMapToolState.deserialize

Overrides

MapObjectState.deserialize

Source

model/internal/tool/MapToolState.ts:64

---

getIcon()

getIcon(): string

It returns the icon property of the tool state.

Returns

string

Implementation of

IMapToolState.getIcon

Source

model/internal/tool/MapToolState.ts:120

---

getId()

getId(): string

It returns the id property of the tool state.

Returns

string

Implementation of

IMapToolState.getId

Inherited from

MapObjectState.getId

Source

model/internal/object/MapObjectState.ts:87

---

getLabel()

getLabel(): string

It returns the label property of the tool state.

Returns

string

Implementation of

IMapToolState.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

IMapToolState.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

MapObjectState.getMapObject

Source

model/internal/object/MapObjectState.ts:39

---

getType()

getType(): string

It returns the type property of the tool state.

Returns

string

Implementation of

IMapToolState.getType

Inherited from

MapObjectState.getType

Source

model/internal/object/MapObjectState.ts:80

---

initialize()

initialize(defaults, props, initProps): void

It resets the state to the initial props.

Parameters

• defaults: IMapToolDefaults

• props: IMapToolProps

• initProps: IMapToolInitProps

Returns

void

Implementation of

IMapToolState.initialize

Overrides

MapObjectState.initialize

Source

model/internal/tool/MapToolState.ts:42

---

isEnabled()

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns

boolean

Implementation of

IMapToolState.isEnabled

Source

model/internal/tool/MapToolState.ts:88

---

serialize()

serialize(defaults): IMapToolConfig

The method serializes the tool state. Optionally, a serialized value can be let undefined if it equals the default value.

Parameters

• defaults: undefined | IMapToolDefaults

Returns

IMapToolConfig

Implementation of

IMapToolState.serialize

Overrides

MapObjectState.serialize

Source

model/internal/tool/MapToolState.ts:76

---

setEnabled()

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters

• enabled: boolean

Returns

void

Implementation of

IMapToolState.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

IMapToolState.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

IMapToolState.setId

Inherited from

MapObjectState.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

IMapToolState.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

Source

model/internal/tool/MapToolState.ts:145