ThemesToolState

geovisto-map • Readme | API

---

geovisto-map / ThemesToolState

Class: ThemesToolState

This class provide functions for using themes.

Author

Jiri Hynek

Extends

• MapToolState

Implements

• IThemesToolState

Constructors

new ThemesToolState()

new ThemesToolState(tool): ThemesToolState

It creates a tool state.

Parameters

• tool: IThemesTool\<IThemesToolProps, IThemesToolDefaults, IThemesToolState\<IThemesToolProps, IThemesToolDefaults, IThemesToolConfig>, IThemesToolConfig, IMapToolInitProps\<IThemesToolConfig>>

Returns

ThemesToolState

Overrides

MapToolState.constructor

Source

tools/themes/model/internal/tool/ThemesToolState.ts:28

Properties

manager

private manager: IMapThemesManager

Source

tools/themes/model/internal/tool/ThemesToolState.ts:22

---

theme

private theme: IMapTheme

Source

tools/themes/model/internal/tool/ThemesToolState.ts:23

Methods

deserialize()

deserialize(config): void

The metod takes config and deserializes the values.

Parameters

• config: IThemesToolConfig

Returns

void

Implementation of

IThemesToolState.deserialize

Overrides

MapToolState.deserialize

Source

tools/themes/model/internal/tool/ThemesToolState.ts:55

---

getIcon()

getIcon(): string

It returns the icon property of the tool state.

Returns

string

Implementation of

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

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

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

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

---

getTheme()

getTheme(): IMapTheme

It returns the theme property of the tool state.

Returns

IMapTheme

Implementation of

IThemesToolState.getTheme

Source

tools/themes/model/internal/tool/ThemesToolState.ts:106

---

getThemesManager()

getThemesManager(): IMapThemesManager

It returns themes manager.

Returns

IMapThemesManager

Implementation of

IThemesToolState.getThemesManager

Source

tools/themes/model/internal/tool/ThemesToolState.ts:90

---

getType()

getType(): string

It returns the type property of the tool state.

Returns

string

Implementation of

IThemesToolState.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: IThemesToolDefaults

• props: IThemesToolProps

• initProps: IMapToolInitProps\<IThemesToolConfig>

Returns

void

Implementation of

IThemesToolState.initialize

Overrides

MapToolState.initialize

Source

tools/themes/model/internal/tool/ThemesToolState.ts:39

---

isEnabled()

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns

boolean

Implementation of

IThemesToolState.isEnabled

Inherited from

MapToolState.isEnabled

Source

model/internal/tool/MapToolState.ts:88

---

serialize()

serialize(defaults): IThemesToolConfig

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

Parameters

• defaults: undefined | IThemesToolDefaults

Returns

IThemesToolConfig

Implementation of

IThemesToolState.serialize

Overrides

MapToolState.serialize

Source

tools/themes/model/internal/tool/ThemesToolState.ts:76

---

setEnabled()

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters

• enabled: boolean

Returns

void

Implementation of

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

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

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

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

---

setTheme()

setTheme(theme): void

It sets the theme property of the tool state.

Parameters

• theme: IMapTheme

Returns

void

Implementation of

IThemesToolState.setTheme

Source

tools/themes/model/internal/tool/ThemesToolState.ts:115

---

setThemesManager()

setThemesManager(manager): void

It sets themes manager.

Parameters

• manager: IMapThemesManager

Returns

void

Implementation of

IThemesToolState.setThemesManager

Source

tools/themes/model/internal/tool/ThemesToolState.ts:99