TilesLayerToolState

geovisto-map • Readme | API

---

geovisto-map / TilesLayerToolState

Class: TilesLayerToolState

This class provide functions for using the state of the tiles layer tool.

Author

Jiri Hynek

Extends

• LayerToolState

Implements

• ITilesLayerToolState

Constructors

new TilesLayerToolState()

new TilesLayerToolState(tool): TilesLayerToolState

It creates a tool state.

Parameters

• tool: ITilesLayerTool\<ITilesLayerToolProps, ITilesLayerToolDefaults, ITilesLayerToolState\<ITilesLayerToolProps, ITilesLayerToolDefaults, ILayerToolConfig, ILayerToolDimensionsConfig, ILayerToolDimensions>, ILayerToolConfig, IMapToolInitProps\<ILayerToolConfig>>

Returns

TilesLayerToolState

Overrides

LayerToolState.constructor

Source

tools/layers/tiles/model/internal/tool/TilesLayerToolState.ts:27

Properties

layer?

private optional layer: any

Source

tools/layers/tiles/model/internal/tool/TilesLayerToolState.ts:22

---

tilesModel

private tilesModel: IMapTilesModel

Source

tools/layers/tiles/model/internal/tool/TilesLayerToolState.ts:21

Methods

deserialize()

deserialize(config): void

The metod takes config and deserializes the values.

Parameters

• config: ILayerToolConfig

Returns

void

Implementation of

ITilesLayerToolState.deserialize

Overrides

LayerToolState.deserialize

Source

tools/layers/tiles/model/internal/tool/TilesLayerToolState.ts:47

---

deserializeDimensions()

deserializeDimensions(dimensionsConfig): void

It sets the marker layer dimensions property of tool state.

Parameters

• dimensionsConfig: ILayerToolDimensionsConfig

Returns

void

Implementation of

ITilesLayerToolState.deserializeDimensions

Inherited from

LayerToolState.deserializeDimensions

Source

model/internal/layer/LayerToolState.ts:67

---

getBaseMap()

getBaseMap(): IMapTilesModel

It returns a base map ID.

Returns

IMapTilesModel

Implementation of

ITilesLayerToolState.getBaseMap

Source

tools/layers/tiles/model/internal/tool/TilesLayerToolState.ts:71

---

getDimensions()

getDimensions(): ILayerToolDimensions

It returns the map layer dimensions property of the tool state.

Returns

ILayerToolDimensions

Implementation of

ITilesLayerToolState.getDimensions

Inherited from

LayerToolState.getDimensions

Source

model/internal/layer/LayerToolState.ts:120

---

getIcon()

getIcon(): string

It returns the icon property of the tool state.

Returns

string

Implementation of

ITilesLayerToolState.getIcon

Inherited from

LayerToolState.getIcon

Source

model/internal/tool/MapToolState.ts:120

---

getId()

getId(): string

It returns the id property of the tool state.

Returns

string

Implementation of

ITilesLayerToolState.getId

Inherited from

LayerToolState.getId

Source

model/internal/object/MapObjectState.ts:87

---

getLabel()

getLabel(): string

It returns the label property of the tool state.

Returns

string

Implementation of

ITilesLayerToolState.getLabel

Inherited from

LayerToolState.getLabel

Source

model/internal/tool/MapToolState.ts:104

---

getLayerItems()

getLayerItems(): undefined | Layer[]

It returns the layer items property of the tool state.

Returns

undefined | Layer[]

Implementation of

ITilesLayerToolState.getLayerItems

Inherited from

LayerToolState.getLayerItems

Source

model/internal/layer/LayerToolState.ts:104

---

getLayerName()

getLayerName(): string

It returns the layer name property of the tool state.

Returns

string

Implementation of

ITilesLayerToolState.getLayerName

Inherited from

LayerToolState.getLayerName

Source

model/internal/layer/LayerToolState.ts:88

---

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

ITilesLayerToolState.getMap

Inherited from

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

LayerToolState.getMapObject

Source

model/internal/object/MapObjectState.ts:39

---

getTileLayer()

getTileLayer(): any

It returns a Leaflet tile layer.

Returns

any

Implementation of

ITilesLayerToolState.getTileLayer

Source

tools/layers/tiles/model/internal/tool/TilesLayerToolState.ts:87

---

getType()

getType(): string

It returns the type property of the tool state.

Returns

string

Implementation of

ITilesLayerToolState.getType

Inherited from

LayerToolState.getType

Source

model/internal/object/MapObjectState.ts:80

---

initialize()

initialize(defaults, props, initProps): void

It resets state with respect to initial props.

Parameters

• defaults: ITilesLayerToolDefaults

• props: ITilesLayerToolProps

• initProps: IMapToolInitProps\<ILayerToolConfig>

Returns

void

Implementation of

ITilesLayerToolState.initialize

Overrides

LayerToolState.initialize

Source

tools/layers/tiles/model/internal/tool/TilesLayerToolState.ts:34

---

isEnabled()

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns

boolean

Implementation of

ITilesLayerToolState.isEnabled

Inherited from

LayerToolState.isEnabled

Source

model/internal/tool/MapToolState.ts:88

---

serialize()

serialize(defaults): ILayerToolConfig

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

Parameters

• defaults: undefined | ITilesLayerToolDefaults

Returns

ILayerToolConfig

Implementation of

ITilesLayerToolState.serialize

Overrides

LayerToolState.serialize

Source

tools/layers/tiles/model/internal/tool/TilesLayerToolState.ts:59

---

setBaseMap()

setBaseMap(baseMap): void

It sets a base map ID.

Parameters

• baseMap: IMapTilesModel

Returns

void

Implementation of

ITilesLayerToolState.setBaseMap

Source

tools/layers/tiles/model/internal/tool/TilesLayerToolState.ts:80

---

setDimensions()

setDimensions(dimensions): void

It sets the map layer dimensions property of tool state.

Parameters

• dimensions: ILayerToolDimensions

Returns

void

Implementation of

ITilesLayerToolState.setDimensions

Inherited from

LayerToolState.setDimensions

Source

model/internal/layer/LayerToolState.ts:129

---

setEnabled()

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters

• enabled: boolean

Returns

void

Implementation of

ITilesLayerToolState.setEnabled

Inherited from

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

ITilesLayerToolState.setIcon

Inherited from

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

ITilesLayerToolState.setId

Inherited from

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

ITilesLayerToolState.setLabel

Inherited from

LayerToolState.setLabel

Source

model/internal/tool/MapToolState.ts:113

---

setLayerItems()

setLayerItems(layerItems): void

It sets the layer items property of tool state.

Parameters

• layerItems: Layer[]

Returns

void

Implementation of

ITilesLayerToolState.setLayerItems

Inherited from

LayerToolState.setLayerItems

Source

model/internal/layer/LayerToolState.ts:113

---

setLayerName()

setLayerName(layerName): void

It sets the layer name property of the tool state.

Parameters

• layerName: string

Returns

void

Implementation of

ITilesLayerToolState.setLayerName

Inherited from

LayerToolState.setLayerName

Source

model/internal/layer/LayerToolState.ts:97

---

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

LayerToolState.setMap

Source

model/internal/tool/MapToolState.ts:145

---

setTileLayer()

setTileLayer(layer): void

It sets a Leaflet tile layer.

Parameters

• layer: TileLayer

Returns

void

Implementation of

ITilesLayerToolState.setTileLayer

Source

tools/layers/tiles/model/internal/tool/TilesLayerToolState.ts:96