IMarkerLayerToolDefaults
geovisto-map / IMarkerLayerToolDefaults
Interface: IMarkerLayerToolDefaults
This interface provides functions which return the default state values.
Author
Jiri Hynek
Extends
Methods
getAggregationDimension()
getAggregationDimension():
IMapDomainDimension\<IMapAggregationFunction>
It returns the default aggregation function dimension.
Returns
IMapDomainDimension\<IMapAggregationFunction>
Source
tools/layers/marker/model/types/tool/IMarkerLayerToolDefaults.ts:52
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>
Source
tools/layers/marker/model/types/tool/IMarkerLayerToolDefaults.ts:57
getConfig()
getConfig():
IMapToolConfig
It returns default config if no config is given.
Returns
Inherited from
Source
model/types/tool/IMapToolDefaults.ts:14
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>
Overrides
ILayerToolDefaults.getDimensions
Source
tools/layers/marker/model/types/tool/IMarkerLayerToolDefaults.ts:32
getGeoData()
getGeoData():
IGeoData[]
It returns the default geo data.
Returns
IGeoData[]
Source
tools/layers/marker/model/types/tool/IMarkerLayerToolDefaults.ts:82
getGeoDataDimension()
getGeoDataDimension(
map?):IMapDomainDimension\<IGeoData>
It returns the default geo data dimension.
Parameters
• map?: IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>
Returns
IMapDomainDimension\<IGeoData>
Source
tools/layers/marker/model/types/tool/IMarkerLayerToolDefaults.ts:37
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>
Source
tools/layers/marker/model/types/tool/IMarkerLayerToolDefaults.ts:42
getIcon()
getIcon():
string
It returns the icon of the tool.
Returns
string
Inherited from
Source
model/types/tool/IMapToolDefaults.ts:36
getId()
getId():
string
It returns identifier which is used when no identifier is specified.
Returns
string
Inherited from
Source
model/types/object/IMapObjectDefaults.ts:32
getLabel()
getLabel():
string
It returns the label of the tool.
Returns
string
Inherited from
Source
model/types/tool/IMapToolDefaults.ts:31
getLayerName()
getLayerName():
string
It returns the layer name.
Returns
string
Inherited from
ILayerToolDefaults.getLayerName
Source
model/types/layer/ILayerToolDefaults.ts:15
getMarker()
getMarker(
latlng,options?):IMarker\<IMarkerIcon\<any>>
It returns new marker for the given options.
Parameters
• latlng: LatLngExpression
• options?: any
Returns
IMarker\<IMarkerIcon\<any>>
Source
tools/layers/marker/model/types/tool/IMarkerLayerToolDefaults.ts:90
getMarkerIcon()
getMarkerIcon(
options):IMarkerIcon\<any>
It returns new icon for the given options.
Parameters
• options: any
Returns
IMarkerIcon\<any>
Source
tools/layers/marker/model/types/tool/IMarkerLayerToolDefaults.ts:97
getProps()
getProps():
IMapObjectProps
It returns default props if no props are given.
Returns
Inherited from
Source
model/types/object/IMapObjectDefaults.ts:17
getRoundDimension()
getRoundDimension():
IMapTypeDimension\<number,ITypeManager\<number>>
It returns the round dimension.
Returns
IMapTypeDimension\<number, ITypeManager\<number>>
Source
tools/layers/marker/model/types/tool/IMarkerLayerToolDefaults.ts:77
getType()
getType():
string
It returns a unique type string of the map object.
Returns
string
Inherited from
Source
model/types/object/IMapObjectDefaults.ts:27
getUnitsDescDimension()
getUnitsDescDimension():
IMapTypeDimension\<string,ITypeManager\<string>>
It returns the units description value dimension.
Returns
IMapTypeDimension\<string, ITypeManager\<string>>
Source
tools/layers/marker/model/types/tool/IMarkerLayerToolDefaults.ts:67
getUnitsDimension()
getUnitsDimension():
IMapTypeDimension\<string,ITypeManager\<string>>
It returns the units dimension.
Returns
IMapTypeDimension\<string, ITypeManager\<string>>
Source
tools/layers/marker/model/types/tool/IMarkerLayerToolDefaults.ts:62
getUnitsEnabledDimension()
getUnitsEnabledDimension():
IMapTypeDimension\<boolean,ITypeManager\<boolean>>
It returns the units state value dimension.
Returns
IMapTypeDimension\<boolean, ITypeManager\<boolean>>
Source
tools/layers/marker/model/types/tool/IMarkerLayerToolDefaults.ts:72
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>
Source
tools/layers/marker/model/types/tool/IMarkerLayerToolDefaults.ts:47
isEnabled()
isEnabled():
boolean
By default, the tool is enabled.
Returns
boolean
Inherited from
Source
model/types/tool/IMapToolDefaults.ts:26
isSingleton()
isSingleton():
boolean
It returns a logical value whether the tool type is singleton.
Returns
boolean
Inherited from
ILayerToolDefaults.isSingleton