HierarchyToolState

geovisto-map • Readme | API

---

geovisto-map / HierarchyToolState

Class: HierarchyToolState

State of hierarchy tool

Author

Vojtěch Malý

Author

Jiri Hynek

Extends

• MapToolState

Implements

• IHierarchyToolState

Constructors

new HierarchyToolState()

new HierarchyToolState(tool): HierarchyToolState

Parameters

• tool: IHierarchyTool\<IMapToolProps, IHierarchyToolDefaults, IHierarchyToolState\<IMapToolProps, IHierarchyToolDefaults, IHierarchyToolConfig>, IHierarchyToolConfig, IMapToolInitProps\<IHierarchyToolConfig>>

Returns

HierarchyToolState

Overrides

MapToolState.constructor

Source

tools/hierarchy/model/internal/tool/HierarchyToolState.ts:24

Properties

hierarchies

private hierarchies: IHierarchyConfig[]

Source

tools/hierarchy/model/internal/tool/HierarchyToolState.ts:22

Methods

deserialize()

deserialize(config): void

The metod takes config and deserializes the values.

Parameters

• config: IHierarchyToolConfig

Returns

void

Implementation of

IHierarchyToolState.deserialize

Overrides

MapToolState.deserialize

Source

tools/hierarchy/model/internal/tool/HierarchyToolState.ts:35

---

getHierarchies()

getHierarchies(): IHierarchyConfig[]

It returns the list of hierarchy specififactions.

Returns

IHierarchyConfig[]

Implementation of

IHierarchyToolState.getHierarchies

Source

tools/hierarchy/model/internal/tool/HierarchyToolState.ts:54

---

getIcon()

getIcon(): string

It returns the icon property of the tool state.

Returns

string

Implementation of

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

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

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

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

---

getType()

getType(): string

It returns the type property of the tool state.

Returns

string

Implementation of

IHierarchyToolState.getType

Inherited from

MapToolState.getType

Source

model/internal/object/MapObjectState.ts:80

---

initialize()

initialize(defaults, props, initProps): void

It resets the state with respect to the initial props.

Parameters

• defaults: IHierarchyToolDefaults

• props: IMapToolProps

• initProps: IMapToolInitProps\<IMapToolProps>

Returns

void

Implementation of

IHierarchyToolState.initialize

Overrides

MapToolState.initialize

Source

tools/hierarchy/model/internal/tool/HierarchyToolState.ts:28

---

isEnabled()

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns

boolean

Implementation of

IHierarchyToolState.isEnabled

Inherited from

MapToolState.isEnabled

Source

model/internal/tool/MapToolState.ts:88

---

serialize()

serialize(defaults): IMapToolConfig

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

Parameters

• defaults: undefined | IMapToolDefaults

Returns

IMapToolConfig

Implementation of

IHierarchyToolState.serialize

Overrides

MapToolState.serialize

Source

tools/hierarchy/model/internal/tool/HierarchyToolState.ts:43

---

setEnabled()

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters

• enabled: boolean

Returns

void

Implementation of

IHierarchyToolState.setEnabled

Inherited from

MapToolState.setEnabled

Source

model/internal/tool/MapToolState.ts:97

---

setHierarchies()

setHierarchies(hierachies): void

It sets the list of hierarchy specififactions.

Parameters

• hierachies: IHierarchyConfig[]

Returns

void

Implementation of

IHierarchyToolState.setHierarchies

Source

tools/hierarchy/model/internal/tool/HierarchyToolState.ts:63

---

setIcon()

setIcon(icon): void

It sets the icon property of the tool state.

Parameters

• icon: string

Returns

void

Implementation of

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

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

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