Skip to main content

IMapToolState

geovisto-mapReadme | API


geovisto-map / IMapToolState

Interface: IMapToolState\<TProps, TDefaults, TConfig, TInitProps>

This interface declares the state of the map tool. It wraps the state since the map tool can work with state objects which needs to be explicitly serialized.

Author

Jiri Hynek

Extends

Type parameters

TProps extends IMapToolProps = IMapToolProps

TDefaults extends IMapToolDefaults = IMapToolDefaults

TConfig extends IMapToolConfig = IMapToolConfig

TInitProps extends IMapToolInitProps\<TConfig> = IMapToolInitProps\<TConfig>

Methods

deserialize()

deserialize(config): void

The metod takes config and deserializes the values.

Parameters

config: TConfig

Returns

void

Inherited from

IMapObjectState.deserialize

Source

model/types/object/IMapObjectState.ts:32


getIcon()

getIcon(): string

It returns the icon property of the tool state.

Returns

string

Source

model/types/tool/IMapToolState.ts:61


getId()

getId(): string

It returns the id property of the map object state.

Returns

string

Inherited from

IMapObjectState.getId

Source

model/types/object/IMapObjectState.ts:49


getLabel()

getLabel(): string

It returns the label property of the tool state.

Returns

string

Source

model/types/tool/IMapToolState.ts:49


getMap()

getMap(): undefined | IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

It returns the map property of the tool state.

Returns

undefined | IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

Source

model/types/tool/IMapToolState.ts:44


getType()

getType(): string

It returns the type property of the map object state.

Returns

string

Inherited from

IMapObjectState.getType

Source

model/types/object/IMapObjectState.ts:44


initialize()

initialize(defaults, props, initProps): void

It resets the state with respect to the initial props.

Parameters

defaults: TDefaults

props: TProps

initProps: TInitProps

Returns

void

Overrides

IMapObjectState.initialize

Source

model/types/tool/IMapToolState.ts:27


isEnabled()

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns

boolean

Source

model/types/tool/IMapToolState.ts:32


serialize()

serialize(defaults): TConfig

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

Parameters

defaults: undefined | TDefaults

Returns

TConfig

Inherited from

IMapObjectState.serialize

Source

model/types/object/IMapObjectState.ts:39


setEnabled()

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters

enabled: boolean

Returns

void

Source

model/types/tool/IMapToolState.ts:39


setIcon()

setIcon(icon): void

It sets the icon property of the tool state.

Parameters

icon: string

Returns

void

Source

model/types/tool/IMapToolState.ts:68


setId()

setId(id): void

It sets the id property of the map object state. It can be set only once.

Parameters

id: string

Returns

void

Inherited from

IMapObjectState.setId

Source

model/types/object/IMapObjectState.ts:57


setLabel()

setLabel(label): void

It sets the label property of the tool state.

Parameters

label: string

Returns

void

Source

model/types/tool/IMapToolState.ts:56