InfoToolState

geovisto-map • Readme | API

---

geovisto-map / InfoToolState

Class: InfoToolState

This class provide functions for using filters.

Author

Jiri Hynek

Author

Tomas Koscielniak

Extends

• MapToolState

Implements

• IInfoToolState

Constructors

new InfoToolState()

new InfoToolState(tool): InfoToolState

It creates a tool state.

Parameters

• tool: IInfoTool\<IInfoToolProps, IInfoToolDefaults, IInfoToolState\<IInfoToolProps, IInfoToolDefaults, IInfoToolConfig>, IInfoToolConfig, IMapToolInitProps\<IInfoToolConfig>>

Returns

InfoToolState

Overrides

MapToolState.constructor

Source

tools/info/model/internal/tool/InfoToolState.ts:33

Properties

data

private data: null | string

Source

tools/info/model/internal/tool/InfoToolState.ts:23

---

defaultFile

private defaultFile: string

Source

tools/info/model/internal/tool/InfoToolState.ts:26

---

manager?

private optional manager: IInfoDataManager

Source

tools/info/model/internal/tool/InfoToolState.ts:24

---

md_data?

private optional md_data: IInfoData

Source

tools/info/model/internal/tool/InfoToolState.ts:25

Methods

deserialize()

deserialize(config): void

The method takes config and deserializes the values.

Parameters

• config: IInfoToolConfig

Returns

void

Implementation of

IInfoToolState.deserialize

Overrides

MapToolState.deserialize

Source

tools/info/model/internal/tool/InfoToolState.ts:62

---

getContent()

getContent(): null | string

Returns

null | string

Implementation of

IInfoToolState.getContent

Source

tools/info/model/internal/tool/InfoToolState.ts:78

---

getDefaultFile()

getDefaultFile(): string

It returns the default file property of the tool state.

Returns

string

Implementation of

IInfoToolState.getDefaultFile

Source

tools/info/model/internal/tool/InfoToolState.ts:92

---

getIcon()

getIcon(): string

It returns the icon property of the tool state.

Returns

string

Implementation of

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

IInfoToolState.getId

Inherited from

MapToolState.getId

Source

model/internal/object/MapObjectState.ts:87

---

getInfoDataManager()

getInfoDataManager(): undefined | IInfoDataManager

It returns markdown manager.

Returns

undefined | IInfoDataManager

Implementation of

IInfoToolState.getInfoDataManager

Source

tools/info/model/internal/tool/InfoToolState.ts:117

---

getLabel()

getLabel(): string

It returns the label property of the tool state.

Returns

string

Implementation of

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

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

---

getMarkdown()

getMarkdown(): undefined | IInfoData

It returns the markdown property of the tool state.

Returns

undefined | IInfoData

Implementation of

IInfoToolState.getMarkdown

Source

tools/info/model/internal/tool/InfoToolState.ts:85

---

getType()

getType(): string

It returns the type property of the tool state.

Returns

string

Implementation of

IInfoToolState.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: IInfoToolDefaults

• props: IInfoToolProps

• initProps: IMapToolInitProps\<IInfoToolConfig>

Returns

void

Implementation of

IInfoToolState.initialize

Overrides

MapToolState.initialize

Source

tools/info/model/internal/tool/InfoToolState.ts:46

---

isEnabled()

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns

boolean

Implementation of

IInfoToolState.isEnabled

Inherited from

MapToolState.isEnabled

Source

model/internal/tool/MapToolState.ts:88

---

serialize()

serialize(defaults): IInfoToolConfig

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

Parameters

• defaults: undefined | IInfoToolDefaults

Returns

IInfoToolConfig

Implementation of

IInfoToolState.serialize

Overrides

MapToolState.serialize

Source

tools/info/model/internal/tool/InfoToolState.ts:72

---

setEnabled()

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters

• enabled: boolean

Returns

void

Implementation of

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

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

IInfoToolState.setId

Inherited from

MapToolState.setId

Source

model/internal/object/MapObjectState.ts:96

---

setInfoDataManager()

setInfoDataManager(manager): void

It sets markdown manager.

Parameters

• manager: IInfoDataManager

Returns

void

Implementation of

IInfoToolState.setInfoDataManager

Source

tools/info/model/internal/tool/InfoToolState.ts:110

---

setLabel()

setLabel(label): void

It sets the label property of the tool state.

Parameters

• label: string

Returns

void

Implementation of

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

---

setMarkdown()

setMarkdown(md): void

It sets the markdown property of the tool state.

Parameters

• md: IInfoData

Returns

void

Implementation of

IInfoToolState.setMarkdown

Source

tools/info/model/internal/tool/InfoToolState.ts:101