IInfoToolState
geovisto-map / IInfoToolState
Interface: IInfoToolState\<TProps, TDefaults, TConfig>
This indetrface declares functions for using info data.
Author
Jiri Hynek
Author
Tomas Koscielniak
Extends
IMapToolState\<TProps,TDefaults,TConfig>
Type parameters
• TProps extends IInfoToolProps = IInfoToolProps
• TDefaults extends IInfoToolDefaults = IInfoToolDefaults
• TConfig extends IInfoToolConfig = IInfoToolConfig
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
getContent()
getContent():
void
Returns
void
Source
tools/info/model/types/tool/IInfoToolState.ts:23
getDefaultFile()
getDefaultFile():
string
Returns
string
Source
tools/info/model/types/tool/IInfoToolState.ts:28
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
getInfoDataManager()
getInfoDataManager():
undefined|IInfoDataManager
Returns
undefined | IInfoDataManager
Source
tools/info/model/types/tool/IInfoToolState.ts:24
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
getMarkdown()
getMarkdown():
undefined|IInfoData
Returns
undefined | IInfoData
Source
tools/info/model/types/tool/IInfoToolState.ts:25
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
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
setInfoDataManager()
setInfoDataManager(
manager):void
Parameters
• manager: IInfoDataManager
Returns
void
Source
tools/info/model/types/tool/IInfoToolState.ts:27
setLabel()
setLabel(
label):void
It sets the label property of the tool state.
Parameters
• label: string
Returns
void
Inherited from
Source
model/types/tool/IMapToolState.ts:56
setMarkdown()
setMarkdown(
md):void
Parameters
• md: IInfoData
Returns
void