FiltersToolState

geovisto-map • Readme | API

---

geovisto-map / FiltersToolState

Class: FiltersToolState

This class provide functions for using filters.

Author

Jiri Hynek

Extends

• MapToolState

Implements

• IFiltersToolState

Constructors

new FiltersToolState()

new FiltersToolState(tool): FiltersToolState

It creates a tool state.

Parameters

• tool: IFiltersTool\<IFiltersToolProps, IFiltersToolDefaults, IFiltersToolState\<IFiltersToolProps, IFiltersToolDefaults, IFiltersToolConfig>, IFiltersToolConfig, IMapToolInitProps\<IFiltersToolConfig>>

Returns

FiltersToolState

Overrides

MapToolState.constructor

Source

tools/filters/model/internal/tool/FiltersToolState.ts:31

Properties

manager

private manager: IMapFilterManager

Source

tools/filters/model/internal/tool/FiltersToolState.ts:24

---

rules

private rules: IMapFilterRule[]

Source

tools/filters/model/internal/tool/FiltersToolState.ts:23

Methods

deserialize()

deserialize(config): void

The metod takes config and deserializes the values.

Parameters

• config: IFiltersToolConfig

Returns

void

Implementation of

IFiltersToolState.deserialize

Overrides

MapToolState.deserialize

Source

tools/filters/model/internal/tool/FiltersToolState.ts:54

---

getFilterRules()

getFilterRules(): IMapFilterRule[]

It returns the filterRules property of the tool state.

Returns

IMapFilterRule[]

Implementation of

IFiltersToolState.getFilterRules

Source

tools/filters/model/internal/tool/FiltersToolState.ts:127

---

getFiltersManager()

getFiltersManager(): IMapFilterManager

It returns filter manager

Returns

IMapFilterManager

Implementation of

IFiltersToolState.getFiltersManager

Source

tools/filters/model/internal/tool/FiltersToolState.ts:111

---

getIcon()

getIcon(): string

It returns the icon property of the tool state.

Returns

string

Implementation of

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

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

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

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

IFiltersToolState.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: IFiltersToolDefaults

• props: IFiltersToolProps

• initProps: IMapToolInitProps\<IFiltersToolConfig>

Returns

void

Implementation of

IFiltersToolState.initialize

Overrides

MapToolState.initialize

Source

tools/filters/model/internal/tool/FiltersToolState.ts:38

---

isEnabled()

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns

boolean

Implementation of

IFiltersToolState.isEnabled

Inherited from

MapToolState.isEnabled

Source

model/internal/tool/MapToolState.ts:88

---

serialize()

serialize(defaults): IFiltersToolConfig

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

Parameters

• defaults: undefined | IFiltersToolDefaults

Returns

IFiltersToolConfig

Implementation of

IFiltersToolState.serialize

Overrides

MapToolState.serialize

Source

tools/filters/model/internal/tool/FiltersToolState.ts:88

---

setEnabled()

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters

• enabled: boolean

Returns

void

Implementation of

IFiltersToolState.setEnabled

Inherited from

MapToolState.setEnabled

Source

model/internal/tool/MapToolState.ts:97

---

setFilterRules()

setFilterRules(filterRules): void

It sets the filterRules property of the tool state.

Parameters

• filterRules: IMapFilterRule[]

Returns

void

Implementation of

IFiltersToolState.setFilterRules

Source

tools/filters/model/internal/tool/FiltersToolState.ts:136

---

setFiltersManager()

setFiltersManager(manager): void

It updates filter manager.

Parameters

• manager: IMapFilterManager

Returns

void

Implementation of

IFiltersToolState.setFiltersManager

Source

tools/filters/model/internal/tool/FiltersToolState.ts:120

---

setIcon()

setIcon(icon): void

It sets the icon property of the tool state.

Parameters

• icon: string

Returns

void

Implementation of

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

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

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