IGeoDownloaderTool
geovisto-map / IGeoDownloaderTool
Interface: IGeoDownloaderTool
Interface of GeoDownloaderTool.
Authorβ
VojtΔch MalΓ½
Extendsβ
Methodsβ
copy()β
copy():
IGeoDownloaderTool
It creates copy of the uninitialized tool.
Returnsβ
Overridesβ
Sourceβ
tools/geo-downloader/model/types/tool/IGeoDownloaderTool.ts:8
create()β
create():
this
It creates a tool.
Returnsβ
this
Inherited fromβ
Sourceβ
model/types/tool/IMapTool.ts:47
getAPIGetter()β
getAPIGetter():
undefined
|IMapToolAPIGetter
\<IMapToolAPI
>
It returns the tool API.
Returnsβ
undefined
| IMapToolAPIGetter
\<IMapToolAPI
>
Inherited fromβ
Sourceβ
model/types/tool/IMapTool.ts:32
getDefaults()β
getDefaults():
IMapToolDefaults
It returns default values of the state properties.
Returnsβ
Inherited fromβ
Sourceβ
model/types/object/IMapObject.ts:27
getId()β
getId():
string
Help function which returns the id of the object.
Returnsβ
string
Inherited fromβ
Sourceβ
model/types/object/IMapObject.ts:42
getMap()β
getMap():
undefined
|IMap
\<IMapProps
,IMapDefaults
,IMapState
\<IMapProps
,IMapDefaults
,IMapConfig
>,IMapConfig
,IMapInitProps
\<IMapConfig
>>
Help function which returns map which uses this tool.
Returnsβ
undefined
| IMap
\<IMapProps
, IMapDefaults
, IMapState
\<IMapProps
, IMapDefaults
, IMapConfig
>, IMapConfig
, IMapInitProps
\<IMapConfig
>>
Inherited fromβ
Sourceβ
model/types/tool/IMapTool.ts:42
getProps()β
getProps():
IMapToolProps
It returns the props given by the programmer.
Returnsβ
Inherited fromβ
Sourceβ
model/types/object/IMapObject.ts:22
getState()β
getState():
IMapToolState
\<IMapToolProps
,IMapToolDefaults
,IMapToolConfig
,IMapToolInitProps
\<IMapToolConfig
>>
It returns the map object state.
Returnsβ
IMapToolState
\<IMapToolProps
, IMapToolDefaults
, IMapToolConfig
, IMapToolInitProps
\<IMapToolConfig
>>
Inherited fromβ
Sourceβ
model/types/object/IMapObject.ts:32
getType()β
getType():
string
Help function which returns the type of the object.
Returnsβ
string
Inherited fromβ
Sourceβ
model/types/object/IMapObject.ts:37
initialize()β
initialize(
initProps
):this
It initializes the state of the object. It processes the serialized config and sets further objects.
This cannot be done in the object constructor since the object can be created before the Geovisto map is created.
Parametersβ
β’ initProps: IMapToolInitProps
\<IMapToolConfig
>
Returnsβ
this
Inherited fromβ
Sourceβ
model/types/object/IMapObject.ts:53
isEnabled()β
isEnabled():
boolean
Help getter which returns enabled property of state.
Returnsβ
boolean
Inherited fromβ
Sourceβ
model/types/tool/IMapTool.ts:52
isSingleton()β
isSingleton():
boolean
It returns a logical value whether the tool type is singleton.
Returnsβ
boolean
Inherited fromβ
Sourceβ
model/types/tool/IMapTool.ts:37
setEnabled()β
setEnabled(
enabled
):void
Some tools might be dynamicaly enabled/disabled. This function is called externally when the tool is enabled/disabled.
Parametersβ
β’ enabled: boolean
Returnsβ
void
Inherited fromβ
Sourceβ
model/types/tool/IMapTool.ts:60
switchEnabled()β
switchEnabled():
void
Help function which switches the enabled state (enabled/disabled).
Returnsβ
void