GeoDownloaderTool
geovisto-map / GeoDownloaderTool
Class: GeoDownloaderTool
GeoDownladerTool -- Tool providing basic user interface for downloading GeoJSON objects from OverpassAPI. Objects can be downloaded for more than one administrative level of country. Can be also used for generating hierarchy definition in case of downloading polygons.
Authorβ
VojtΔch MalΓ½
Extendsβ
Implementsβ
Constructorsβ
new GeoDownloaderTool()β
new GeoDownloaderTool(
props?):GeoDownloaderTool
Parametersβ
β’ props?: IMapToolProps
Returnsβ
Overridesβ
Sourceβ
tools/geo-downloader/model/internal/tool/GeoDownloaderTool.ts:28
Propertiesβ
mapFormβ
privatemapForm:GeoDownloaderToolMapForm
Sourceβ
tools/geo-downloader/model/internal/tool/GeoDownloaderTool.ts:26
Methodsβ
changeForm()β
privatechangeForm():void
Update displayed zoom level in form.
Returnsβ
void
Sourceβ
tools/geo-downloader/model/internal/tool/GeoDownloaderTool.ts:78
copy()β
copy():
IGeoDownloaderTool
It creates copy of the uninitialized tool.
Returnsβ
Implementation ofβ
Overridesβ
Sourceβ
tools/geo-downloader/model/internal/tool/GeoDownloaderTool.ts:63
create()β
create():
this
It creates a tool.
Returnsβ
this
Implementation ofβ
Overridesβ
Sourceβ
tools/geo-downloader/model/internal/tool/GeoDownloaderTool.ts:67
createDefaults()β
createDefaults():
IGeoDownloaderToolDefaults
It creates new defaults of the tool.
Returnsβ
Overridesβ
Sourceβ
tools/geo-downloader/model/internal/tool/GeoDownloaderTool.ts:43
createMapForm()β
protectedcreateMapForm():IMapForm
Returnsβ
Sourceβ
tools/geo-downloader/model/internal/tool/GeoDownloaderTool.ts:47
createState()β
createState():
IGeoDownloaderToolState
It creates new defaults of the tool.
Returnsβ
Overridesβ
Sourceβ
tools/geo-downloader/model/internal/tool/GeoDownloaderTool.ts:59
getAPIGetter()β
getAPIGetter():
undefined|IMapToolAPIGetter
It returns the tool API
Returnsβ
undefined | IMapToolAPIGetter
Implementation ofβ
IGeoDownloaderTool.getAPIGetter
Inherited fromβ
Sourceβ
model/internal/tool/MapTool.ts:74
getDefaults()β
getDefaults():
IGeoDownloaderToolDefaults
It returns default values of the state properties.
Returnsβ
Implementation ofβ
IGeoDownloaderTool.getDefaults
Overridesβ
Sourceβ
tools/geo-downloader/model/internal/tool/GeoDownloaderTool.ts:39
getId()β
getId():
string
Help function which returns the id of the object.
Returnsβ
string
Implementation ofβ
Inherited fromβ
Sourceβ
model/internal/object/MapObject.ts:93
getMap()β
getMap():
undefined|IMap\<IMapProps,IMapDefaults,IMapState\<IMapProps,IMapDefaults,IMapConfig>,IMapConfig,IMapInitProps\<IMapConfig>>
Help function returns map which uses this tool.
Do not override this function. Use the state class instead.
Returnsβ
undefined | IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>
Implementation ofβ
Inherited fromβ
Sourceβ
model/internal/tool/MapTool.ts:112
getMapForm()β
getMapForm():
IMapForm
It returns a map control.
Returnsβ
Implementation ofβ
Sourceβ
tools/geo-downloader/model/internal/tool/GeoDownloaderTool.ts:32
getProps()β
getProps():
IMapToolProps
Help function which returns the props given by the programmer.
Returnsβ
Implementation ofβ
Inherited fromβ
Sourceβ
model/internal/tool/MapTool.ts:39
getState()β
getState():
IGeoDownloaderToolState
It returns the map object state.
Returnsβ
Implementation ofβ
Overridesβ
Sourceβ
tools/geo-downloader/model/internal/tool/GeoDownloaderTool.ts:55
getType()β
getType():
string
Help function which returns the type of the object.
Returnsβ
string
Implementation ofβ
Inherited fromβ
Sourceβ
model/internal/object/MapObject.ts:86
handleEvent()β
handleEvent(
event):void
This function is called when a custom event is invoked.
Override this function, if needed.
Parametersβ
β’ event: IMapEvent\<IMapObject\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectState\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>>
Returnsβ
void
Inherited fromβ
Sourceβ
model/internal/tool/MapTool.ts:171
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
Implementation ofβ
Overridesβ
Sourceβ
tools/geo-downloader/model/internal/tool/GeoDownloaderTool.ts:51
isEnabled()β
isEnabled():
boolean
Help getter which returns enabled property of state.
Do not override this function. Use the state class instead.
Returnsβ
boolean
Implementation ofβ
Inherited fromβ
Sourceβ
model/internal/tool/MapTool.ts:130
isSingleton()β
isSingleton():
boolean
Help getter which returns a logtical value whether the tool type is singleton.
Returnsβ
boolean
Implementation ofβ
IGeoDownloaderTool.isSingleton
Inherited fromβ
Sourceβ
model/internal/tool/MapTool.ts:81
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
Implementation ofβ
Overridesβ
Sourceβ
tools/geo-downloader/model/internal/tool/GeoDownloaderTool.ts:87
setProps()β
protectedsetProps(props):void
It updates the props.
Parametersβ
β’ props: IMapObjectProps
Returnsβ
void
Inherited fromβ
Sourceβ
model/internal/object/MapObject.ts:38
switchEnabled()β
switchEnabled():
void
Help function which switches enabled state (enabled/disabled).
Do not override this function. Use setEnabled instead.
Returnsβ
void
Implementation ofβ
IGeoDownloaderTool.switchEnabled