Skip to main content

GeoDownloaderToolState

geovisto-map β€’ Readme | API

geovisto-map / GeoDownloaderToolState

Class: GeoDownloaderToolState

State class for GeoDownloaderTool.

Author​

VojtΔ›ch MalΓ½

Extends​

Implements​

Constructors​

new GeoDownloaderToolState()​

new GeoDownloaderToolState(tool): GeoDownloaderToolState

Parameters​

β€’ tool: IGeoDownloaderTool

Returns​

GeoDownloaderToolState

Overrides​

MapToolState.constructor

Source​

tools/geo-downloader/model/internal/tool/GeoDownloaderToolState.ts:17

Methods​

deserialize()​

deserialize(config): void

The metod takes config and deserializes the values.

Parameters​

β€’ config: IMapToolConfig

Returns​

void

Implementation of​

IGeoDownloaderToolState.deserialize

Inherited from​

MapToolState.deserialize

Source​

model/internal/tool/MapToolState.ts:64

getIcon()​

getIcon(): string

It returns the icon property of the tool state.

Returns​

string

Implementation of​

IGeoDownloaderToolState.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​

IGeoDownloaderToolState.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​

IGeoDownloaderToolState.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​

IGeoDownloaderToolState.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​

IGeoDownloaderToolState.getType

Inherited from​

MapToolState.getType

Source​

model/internal/object/MapObjectState.ts:80

initialize()​

initialize(defaults, props, initProps): void

It resets the state to the initial props.

Parameters​

β€’ defaults: IGeoDownloaderToolDefaults

β€’ props: IMapToolProps

β€’ initProps: IMapToolInitProps\<IMapToolProps>

Returns​

void

Implementation of​

IGeoDownloaderToolState.initialize

Overrides​

MapToolState.initialize

Source​

tools/geo-downloader/model/internal/tool/GeoDownloaderToolState.ts:21

isEnabled()​

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns​

boolean

Implementation of​

IGeoDownloaderToolState.isEnabled

Inherited from​

MapToolState.isEnabled

Source​

model/internal/tool/MapToolState.ts:88

serialize()​

serialize(defaults): IMapToolConfig

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

Parameters​

β€’ defaults: undefined | IMapToolDefaults

Returns​

IMapToolConfig

Implementation of​

IGeoDownloaderToolState.serialize

Inherited from​

MapToolState.serialize

Source​

model/internal/tool/MapToolState.ts:76

setEnabled()​

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters​

β€’ enabled: boolean

Returns​

void

Implementation of​

IGeoDownloaderToolState.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​

IGeoDownloaderToolState.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​

IGeoDownloaderToolState.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​

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