HeatLayerTool
geovisto-map / HeatLayerTool
Class: HeatLayerTool
This class represents Heat layer tool. It works with leaflet.heat plugin provided for Leaflet
Author
Vladimir Korencik
Author
Petr Kaspar
Extends
Implements
Constructors
new HeatLayerTool()
new HeatLayerTool(
props
?):HeatLayerTool
Parameters
• props?: IHeatLayerToolProps
Returns
Overrides
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:57
Properties
mapForm
private
mapForm:IMapForm
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:54
maxValue
private
maxValue:undefined
|number
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:55
selectionToolAPI
private
selectionToolAPI:undefined
|ISelectionToolAPI
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:53
Methods
changeHeatRadius()
changeHeatRadius():
void
Returns
void
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:287
copy()
copy():
IHeatLayerTool
\<IHeatLayerToolProps
,IHeatLayerToolDefaults
,IHeatLayerToolState
\<IHeatLayerToolProps
,IHeatLayerToolDefaults
,IHeatLayerToolConfig
,object
,object
>,IHeatLayerToolConfig
,IMapToolInitProps
\<IHeatLayerToolConfig
>>
It creates a copy of the uninitialized tool.
Returns
IHeatLayerTool
\<IHeatLayerToolProps
, IHeatLayerToolDefaults
, IHeatLayerToolState
\<IHeatLayerToolProps
, IHeatLayerToolDefaults
, IHeatLayerToolConfig
, object
, object
>, IHeatLayerToolConfig
, IMapToolInitProps
\<IHeatLayerToolConfig
>>
Implementation of
Overrides
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:63
create()
create():
this
It creates new layer with respect to configuration
Returns
this
Implementation of
Inherited from
Source
model/internal/layer/AbstractLayerTool.ts:89
createDefaults()
protected
createDefaults():IHeatLayerToolDefaults
It creates new defaults of the layer tool.
Returns
Overrides
AbstractLayerTool
.createDefaults
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:79
createHeatLayers()
protected
createHeatLayers():void
Returns
void
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:260
createLayerItems()
protected
createLayerItems():LayerGroup
[]
It creates layer items.
Override this function.
Returns
LayerGroup
[]
Overrides
AbstractLayerTool
.createLayerItems
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:116
createMapForm()
protected
createMapForm():IMapForm
Returns
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:106
createState()
protected
createState():IHeatLayerToolState
\<IHeatLayerToolProps
,IHeatLayerToolDefaults
,IHeatLayerToolConfig
,object
,object
>
It creates new defaults of the layer tool.
Returns
IHeatLayerToolState
\<IHeatLayerToolProps
, IHeatLayerToolDefaults
, IHeatLayerToolConfig
, object
, object
>
Overrides
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:83
getAPIGetter()
getAPIGetter():
undefined
|IMapToolAPIGetter
It returns the tool API
Returns
undefined
| IMapToolAPIGetter
Implementation of
Inherited from
AbstractLayerTool
.getAPIGetter
Source
model/internal/tool/MapTool.ts:74
getDefaults()
getDefaults():
IHeatLayerToolDefaults
It returns default values of the state properties.
Returns
Implementation of
Overrides
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:71
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
getLayerItems()
getLayerItems():
Layer
[]
It returns layer items which should be rendered.
Returns
Layer
[]
Implementation of
Inherited from
AbstractLayerTool
.getLayerItems
Source
model/internal/layer/AbstractLayerTool.ts:163
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/layers/heat/model/internal/tool/HeatLayerTool.ts:99
getProps()
getProps():
IHeatLayerToolProps
It returns the props given by the programmer.
Returns
Implementation of
Overrides
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:67
getRadius()
getRadius(
zoom
):undefined
|number
Parameters
• zoom: undefined
| number
Returns
undefined
| number
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:312
getSelectionTool()
private
getSelectionTool():undefined
|ISelectionToolAPI
Returns
undefined
| ISelectionToolAPI
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:87
getState()
getState():
IHeatLayerToolState
\<IHeatLayerToolProps
,IHeatLayerToolDefaults
,IHeatLayerToolConfig
,object
,object
>
It returns the map object state.
Returns
IHeatLayerToolState
\<IHeatLayerToolProps
, IHeatLayerToolDefaults
, IHeatLayerToolConfig
, object
, object
>
Implementation of
Overrides
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:75
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
Overrides
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:350
hideLayerItems()
protected
hideLayerItems():void
Help function which hides layer items
This function is meant to be private.
Returns
void
Inherited from
AbstractLayerTool
.hideLayerItems
Source
model/internal/layer/AbstractLayerTool.ts:147
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
\<IHeatLayerToolConfig
>
Returns
this
Implementation of
Overrides
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:110
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
Inherited from
Source
model/internal/tool/MapTool.ts:81
prepareHeatmapOptions()
protected
prepareHeatmapOptions():void
Returns
void
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:132
prepareMapData()
protected
prepareMapData():void
Returns
void
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:154
render()
render(
type
):void
It reloads data and redraw the layer with respect to the type.
By default it works with LayerRedrawType
Parameters
• type: number
Returns
void
Implementation of
Overrides
Source
tools/layers/heat/model/internal/tool/HeatLayerTool.ts:236
setEnabled()
setEnabled(
enabled
):void
It changes layer state to enabled/disabled.
Parameters
• enabled: boolean
Returns
void
Implementation of
Inherited from
Source
model/internal/layer/AbstractLayerTool.ts:102
setProps()
protected
setProps(props
):void
It updates the props.
Parameters
• props: IMapObjectProps
Returns
void
Inherited from
Source
model/internal/object/MapObject.ts:38
showLayerItems()
protected
showLayerItems():void
Help function which shows layer items.
This function is meant to be private.
Returns
void
Inherited from
AbstractLayerTool
.showLayerItems
Source
model/internal/layer/AbstractLayerTool.ts:126
switchEnabled()
switchEnabled():
void
Help function which switches enabled state (enabled/disabled).
Do not override this function. Use setEnabled instead.
Returns
void
Implementation of
Inherited from
AbstractLayerTool
.switchEnabled
Source
model/internal/tool/MapTool.ts:158
updateDimension()
updateDimension(
dimension
,value
,redraw
):void
It updates the dimension.
Parameters
• dimension: IMapDomainDimension
\<IMapDomain
>
• value: string
• redraw: undefined
| number
Returns
void
Implementation of
IHeatLayerTool
.updateDimension
Overrides
AbstractLayerTool
.updateDimension