MarkerLayerToolDefaults
geovisto-map / MarkerLayerToolDefaults
Class: MarkerLayerToolDefaults
This class provide functions which return the default state values.
Author
Jiri Hynek
Extends
Implements
Constructors
new MarkerLayerToolDefaults()
new MarkerLayerToolDefaults():
MarkerLayerToolDefaults
Returns
Inherited from
Properties
idString?
protected
optional
idString:string
Inherited from
Source
model/internal/object/MapObjectDefaults.ts:13
TYPE
static
TYPE:string
="geovisto-tool-layer-marker"
Static tool type constant.
Overrides
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:45
id
static
protected
id:number
Inherited from
Source
model/internal/object/MapObjectDefaults.ts:12
Methods
generateId()
protected
generateId():string
It returns identifier which is used when no identifier is specified.
Returns
string
Inherited from
Source
model/internal/object/MapObjectDefaults.ts:54
getAggregationDimension()
getAggregationDimension():
IMapDomainDimension
\<IMapAggregationFunction
>
It returns the default aggregation function dimension.
Returns
IMapDomainDimension
\<IMapAggregationFunction
>
Implementation of
IMarkerLayerToolDefaults
.getAggregationDimension
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:128
getCategoryDimension()
getCategoryDimension(
map
?):IMapDomainDimension
\<IMapDataDomain
>
It returns the default category dimension.
Parameters
• map?: IMap
\<IMapProps
, IMapDefaults
, IMapState
\<IMapProps
, IMapDefaults
, IMapConfig
>, IMapConfig
, IMapInitProps
\<IMapConfig
>>
Returns
IMapDomainDimension
\<IMapDataDomain
>
Implementation of
IMarkerLayerToolDefaults
.getCategoryDimension
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:146
getConfig()
getConfig():
IMapToolConfig
By defaults it returns the config with undefined props.
Returns
Implementation of
IMarkerLayerToolDefaults
.getConfig
Inherited from
Source
model/internal/tool/MapToolDefaults.ts:34
getDataManager()
getDataManager():
IMapDataManager
It returns default map data manager.
Returns
Inherited from
LayerToolDefaults
.getDataManager
Source
model/internal/tool/MapToolDefaults.ts:20
getDimensions()
getDimensions(
map
?):object
It returns the map of layer dimensions.
Parameters
• map?: IMap
\<IMapProps
, IMapDefaults
, IMapState
\<IMapProps
, IMapDefaults
, IMapConfig
>, IMapConfig
, IMapInitProps
\<IMapConfig
>>
Returns
object
aggregation
aggregation:
IMapDomainDimension
\<IMapAggregationFunction
>
category
category:
IMapDomainDimension
\<IMapDataDomain
>
geoData
geoData:
IMapDomainDimension
\<IGeoData
>
geoId
geoId:
IMapDomainDimension
\<IMapDataDomain
>
round
round:
IMapTypeDimension
\<number
,ITypeManager
\<number
>>
units
units:
IMapTypeDimension
\<string
,ITypeManager
\<string
>>
unitsDesc
unitsDesc:
IMapTypeDimension
\<string
,ITypeManager
\<string
>>
unitsEnabled
unitsEnabled:
IMapTypeDimension
\<boolean
,ITypeManager
\<boolean
>>
value
value:
IMapDomainDimension
\<IMapDataDomain
>
Implementation of
IMarkerLayerToolDefaults
.getDimensions
Overrides
LayerToolDefaults
.getDimensions
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:78
getGeoData()
getGeoData():
IGeoData
[]
It returns the default geo data.
Returns
IGeoData
[]
Implementation of
IMarkerLayerToolDefaults
.getGeoData
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:201
getGeoDataDimension()
getGeoDataDimension(
map
?):IMapDomainDimension
\<IGeoData
>
It returns the default geo ID dimension.
Parameters
• map?: IMap
\<IMapProps
, IMapDefaults
, IMapState
\<IMapProps
, IMapDefaults
, IMapConfig
>, IMapConfig
, IMapInitProps
\<IMapConfig
>>
Returns
IMapDomainDimension
\<IGeoData
>
Implementation of
IMarkerLayerToolDefaults
.getGeoDataDimension
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:95
getGeoDataManager()
getGeoDataManager(
geoDataArray
):IGeoDataManager
It returns default geo data manager.
Parameters
• geoDataArray: undefined
| IGeoData
[]
Returns
Inherited from
LayerToolDefaults
.getGeoDataManager
Source
model/internal/tool/MapToolDefaults.ts:27
getGeoIdDimension()
getGeoIdDimension(
map
?):IMapDomainDimension
\<IMapDataDomain
>
It returns the default geo ID dimension.
Parameters
• map?: IMap
\<IMapProps
, IMapDefaults
, IMapState
\<IMapProps
, IMapDefaults
, IMapConfig
>, IMapConfig
, IMapInitProps
\<IMapConfig
>>
Returns
IMapDomainDimension
\<IMapDataDomain
>
Implementation of
IMarkerLayerToolDefaults
.getGeoIdDimension
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:106
getIcon()
getIcon():
string
It returns the icon of the tool.
Returns
string
Implementation of
IMarkerLayerToolDefaults
.getIcon
Overrides
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:71
getId()
getId():
string
It returns identifier which is used when no identifier is specified.
Returns
string
Implementation of
IMarkerLayerToolDefaults
.getId
Inherited from
Source
model/internal/object/MapObjectDefaults.ts:44
getLabel()
getLabel():
string
It returns the label of the tool.
Returns
string
Implementation of
IMarkerLayerToolDefaults
.getLabel
Overrides
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:64
getLayerName()
getLayerName():
string
It returns the layer name.
Returns
string
Implementation of
IMarkerLayerToolDefaults
.getLayerName
Overrides
LayerToolDefaults
.getLayerName
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:57
getMarker()
getMarker(
latlng
,options
?):IMarker
\<IMarkerIcon
\<any
>>
It returns new marker for the given options.
Parameters
• latlng: LatLngExpression
• options?: any
Returns
IMarker
\<IMarkerIcon
\<any
>>
Implementation of
IMarkerLayerToolDefaults
.getMarker
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:213
getMarkerIcon()
getMarkerIcon(
options
):IMarkerIcon
\<any
>
It returns new icon for the given options.
Parameters
• options: any
Returns
IMarkerIcon
\<any
>
Implementation of
IMarkerLayerToolDefaults
.getMarkerIcon
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:222
getProps()
getProps():
IMapObjectProps
It returns default props if no props are given.
Returns
Implementation of
IMarkerLayerToolDefaults
.getProps
Inherited from
Source
model/internal/object/MapObjectDefaults.ts:18
getRoundDimension()
getRoundDimension():
IMapTypeDimension
\<number
,ITypeManager
\<number
>>
It returns the max value dimension.
Returns
IMapTypeDimension
\<number
, ITypeManager
\<number
>>
Implementation of
IMarkerLayerToolDefaults
.getRoundDimension
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:190
getType()
getType():
string
It returns a unique type string of the tool which is based on the layer it wraps.
Returns
string
Implementation of
IMarkerLayerToolDefaults
.getType
Overrides
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:50
getUnitsDescDimension()
getUnitsDescDimension():
IMapTypeDimension
\<string
,ITypeManager
\<string
>>
It returns the units description value dimension.
Returns
IMapTypeDimension
\<string
, ITypeManager
\<string
>>
Implementation of
IMarkerLayerToolDefaults
.getUnitsDescDimension
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:168
getUnitsDimension()
getUnitsDimension():
IMapTypeDimension
\<string
,ITypeManager
\<string
>>
It returns the max value dimension.
Returns
IMapTypeDimension
\<string
, ITypeManager
\<string
>>
Implementation of
IMarkerLayerToolDefaults
.getUnitsDimension
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:157
getUnitsEnabledDimension()
getUnitsEnabledDimension():
IMapTypeDimension
\<boolean
,ITypeManager
\<boolean
>>
It returns the units state value dimension.
Returns
IMapTypeDimension
\<boolean
, ITypeManager
\<boolean
>>
Implementation of
IMarkerLayerToolDefaults
.getUnitsEnabledDimension
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:179
getValueDimension()
getValueDimension(
map
?):IMapDomainDimension
\<IMapDataDomain
>
It returns the default value dimension.
Parameters
• map?: IMap
\<IMapProps
, IMapDefaults
, IMapState
\<IMapProps
, IMapDefaults
, IMapConfig
>, IMapConfig
, IMapInitProps
\<IMapConfig
>>
Returns
IMapDomainDimension
\<IMapDataDomain
>
Implementation of
IMarkerLayerToolDefaults
.getValueDimension
Source
tools/layers/marker/model/internal/tool/MarkerLayerToolDefaults.ts:117
isEnabled()
isEnabled():
boolean
By default, the tool is enabled.
Returns
boolean
Implementation of
IMarkerLayerToolDefaults
.isEnabled
Inherited from
Source
model/internal/tool/MapToolDefaults.ts:50
isSingleton()
isSingleton():
boolean
By default, the tool is singleton
Returns
boolean
Implementation of
IMarkerLayerToolDefaults
.isSingleton