Skip to main content

IHierarchyToolState

geovisto-map β€’ Readme | API


geovisto-map / IHierarchyToolState

Interface: IHierarchyToolState\<TProps, TDefaults, TConfig>

State interface for Hierarchy Tool

Author​

VojtΔ›ch MalΓ½

Extends​

Type parameters​

β€’ TProps extends IHierarchyToolProps = IHierarchyToolProps

β€’ TDefaults extends IHierarchyToolDefaults = IHierarchyToolDefaults

β€’ TConfig extends IHierarchyToolConfig = IHierarchyToolConfig

Methods​

deserialize()​

deserialize(config): void

The metod takes config and deserializes the values.

Parameters​

β€’ config: TConfig

Returns​

void

Inherited from​

IMapToolState.deserialize

Source​

model/types/object/IMapObjectState.ts:32


getHierarchies()​

getHierarchies(): IHierarchyConfig[]

It returns the list of hierarchy specififactions.

Returns​

IHierarchyConfig[]

Source​

tools/hierarchy/model/types/tool/IHierarchyToolState.ts:25


getIcon()​

getIcon(): string

It returns the icon property of the tool state.

Returns​

string

Inherited from​

IMapToolState.getIcon

Source​

model/types/tool/IMapToolState.ts:61


getId()​

getId(): string

It returns the id property of the map object state.

Returns​

string

Inherited from​

IMapToolState.getId

Source​

model/types/object/IMapObjectState.ts:49


getLabel()​

getLabel(): string

It returns the label property of the tool state.

Returns​

string

Inherited from​

IMapToolState.getLabel

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

Inherited from​

IMapToolState.getMap

Source​

model/types/tool/IMapToolState.ts:44


getType()​

getType(): string

It returns the type property of the map object state.

Returns​

string

Inherited from​

IMapToolState.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: IMapToolInitProps\<TConfig>

Returns​

void

Inherited from​

IMapToolState.initialize

Source​

model/types/tool/IMapToolState.ts:27


isEnabled()​

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns​

boolean

Inherited from​

IMapToolState.isEnabled

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​

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

Inherited from​

IMapToolState.setEnabled

Source​

model/types/tool/IMapToolState.ts:39


setHierarchies()​

setHierarchies(hierachies): void

It sets the list of hierarchy specififactions.

Parameters​

β€’ hierachies: IHierarchyConfig[]

Returns​

void

Source​

tools/hierarchy/model/types/tool/IHierarchyToolState.ts:32


setIcon()​

setIcon(icon): void

It sets the icon property of the tool state.

Parameters​

β€’ icon: string

Returns​

void

Inherited from​

IMapToolState.setIcon

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​

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

Inherited from​

IMapToolState.setLabel

Source​

model/types/tool/IMapToolState.ts:56