IHierarchyToolState
geovisto-map / IHierarchyToolState
Interface: IHierarchyToolState\<TProps, TDefaults, TConfig>
State interface for Hierarchy Tool
Authorβ
VojtΔch MalΓ½
Extendsβ
IMapToolState
\<TProps
,TDefaults
,TConfig
>
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β
Sourceβ
model/types/object/IMapObjectState.ts:32
getHierarchies()β
getHierarchies():
IHierarchyConfig
[]
It returns the list of hierarchy specififactions.
Returnsβ
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β
Sourceβ
model/types/tool/IMapToolState.ts:61
getId()β
getId():
string
It returns the id property of the map object state.
Returnsβ
string
Inherited fromβ
Sourceβ
model/types/object/IMapObjectState.ts:49
getLabel()β
getLabel():
string
It returns the label property of the tool state.
Returnsβ
string
Inherited fromβ
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β
Sourceβ
model/types/tool/IMapToolState.ts:44
getType()β
getType():
string
It returns the type property of the map object state.
Returnsβ
string
Inherited fromβ
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β
Sourceβ
model/types/tool/IMapToolState.ts:27
isEnabled()β
isEnabled():
boolean
It returns the enabled property of the tool state.
Returnsβ
boolean
Inherited fromβ
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β
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β
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β
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β
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