TilesLayerTool
geovisto-map / TilesLayerTool
Class: TilesLayerTool
This class represents Map layer tool. It use tile layer and OSM maps.
Author
Jiri Hynek
Extends
Implements
Constructors
new TilesLayerTool()
new TilesLayerTool(
props
?):TilesLayerTool
It creates a new tool with respect to the props.
Parameters
• props?: ITilesLayerToolProps
Returns
Overrides
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:47
Properties
mapForm
private
mapForm:IMapForm
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:40
themesToolAPI
private
themesToolAPI:undefined
|IThemesToolAPI
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:39
Methods
copy()
copy():
ITilesLayerTool
\<ITilesLayerToolProps
,ITilesLayerToolDefaults
,ITilesLayerToolState
\<ITilesLayerToolProps
,ITilesLayerToolDefaults
,ILayerToolConfig
,ILayerToolDimensionsConfig
,ILayerToolDimensions
>,ILayerToolConfig
,IMapToolInitProps
\<ILayerToolConfig
>>
It creates a copy of the uninitialized tool.
Returns
ITilesLayerTool
\<ITilesLayerToolProps
, ITilesLayerToolDefaults
, ITilesLayerToolState
\<ITilesLayerToolProps
, ITilesLayerToolDefaults
, ILayerToolConfig
, ILayerToolDimensionsConfig
, ILayerToolDimensions
>, ILayerToolConfig
, IMapToolInitProps
\<ILayerToolConfig
>>
Implementation of
Overrides
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:54
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():ITilesLayerToolDefaults
It creates new defaults of the layer tool.
Returns
Overrides
AbstractLayerTool
.createDefaults
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:75
createLayerItems()
protected
createLayerItems():Layer
[]
It creates layer items.
Returns
Layer
[]
Overrides
AbstractLayerTool
.createLayerItems
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:136
createMapForm()
protected
createMapForm():IMapForm
It creates new tab control.
Returns
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:106
createState()
protected
createState():ITilesLayerToolState
\<ITilesLayerToolProps
,ITilesLayerToolDefaults
,ILayerToolConfig
,ILayerToolDimensionsConfig
,ILayerToolDimensions
>
It creates new defaults of the layer tool.
Returns
ITilesLayerToolState
\<ITilesLayerToolProps
, ITilesLayerToolDefaults
, ILayerToolConfig
, ILayerToolDimensionsConfig
, ILayerToolDimensions
>
Overrides
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:89
createTileLayer()
protected
createTileLayer(tilesModel
):TileLayer
Creates new tile layer
Parameters
• tilesModel: IMapTilesModel
Returns
TileLayer
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:151
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():
ITilesLayerToolDefaults
It returns default values of the state properties.
Returns
Implementation of
Overrides
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:68
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 sidebar tab with respect to the configuration.
Returns
Implementation of
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:96
getProps()
getProps():
ITilesLayerToolProps
Help function which returns the props given by the programmer.
Returns
Implementation of
Overrides
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:61
getState()
getState():
ITilesLayerToolState
\<ITilesLayerToolProps
,ITilesLayerToolDefaults
,ILayerToolConfig
,ILayerToolDimensionsConfig
,ILayerToolDimensions
>
It returns the layer tool state.
Returns
ITilesLayerToolState
\<ITilesLayerToolProps
, ITilesLayerToolDefaults
, ILayerToolConfig
, ILayerToolDimensionsConfig
, ILayerToolDimensions
>
Implementation of
Overrides
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:82
getThemesTool()
private
getThemesTool():undefined
|IThemesToolAPI
Help function which acquires and returns the themes tool if available.
Returns
undefined
| IThemesToolAPI
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:114
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.
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/tiles/model/internal/tool/TilesLayerTool.ts:173
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
Overrides the super method.
Parameters
• initProps: IMapToolInitProps
\<ILayerToolConfig
>
Returns
this
Implementation of
Overrides
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:129
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
onThemeChange()
protected
onThemeChange(theme
):void
This function updates theme used in the tool.
Parameters
• theme: IMapTheme
Returns
void
Source
tools/layers/tiles/model/internal/tool/TilesLayerTool.ts:182
render()
render(
type
,animateOptions
?):void
It reloads data and redraw the layer with respect to the type.
By default it works with LayerRedrawType
Parameters
• type: number
• animateOptions?: IDataChangeAnimateOptions
Returns
void
Implementation of
Inherited from
Source
model/internal/layer/AbstractLayerTool.ts:189
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
,renderType
):void
It updates the dimension.
Parameters
• dimension: IMapDimension
\<unknown
>
• value: string
• renderType: undefined
| number
= undefined
Returns
void
Implementation of
ITilesLayerTool
.updateDimension
Inherited from
AbstractLayerTool
.updateDimension