IConnectionLayerToolDefaults
geovisto-map / IConnectionLayerToolDefaults
Interface: IConnectionLayerToolDefaults
This interface declares functions which return the default state values.
Author
Jiri Hynek
Extends
Methods
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
direction
direction:
IMapTypeDimension
\<boolean
,ITypeManager
\<boolean
>>
from
from:
IMapDomainDimension
\<IMapDataDomain
>
geoData
geoData:
IMapDomainDimension
\<IGeoData
>
to
Overrides
ILayerToolDefaults
.getDimensions
Source
tools/layers/connection/model/types/tool/IConnectionLayerToolDefaults.ts:22
getDirectionDimension()
getDirectionDimension():
IMapTypeDimension
\<boolean
,ITypeManager
\<boolean
>>
It returns the animate direction dimension.
Returns
IMapTypeDimension
\<boolean
, ITypeManager
\<boolean
>>
Source
tools/layers/connection/model/types/tool/IConnectionLayerToolDefaults.ts:42
getFromDimension()
getFromDimension(
map
?):IMapDomainDimension
\<IMapDataDomain
>
It returns the default geo source ID dimension.
Parameters
• map?: IMap
\<IMapProps
, IMapDefaults
, IMapState
\<IMapProps
, IMapDefaults
, IMapConfig
>, IMapConfig
, IMapInitProps
\<IMapConfig
>>
Returns
IMapDomainDimension
\<IMapDataDomain
>
Source
tools/layers/connection/model/types/tool/IConnectionLayerToolDefaults.ts:32
getGeoData()
getGeoData():
IGeoData
[]
It returns the default geo data.
Returns
IGeoData
[]
Source
tools/layers/connection/model/types/tool/IConnectionLayerToolDefaults.ts:52
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/connection/model/types/tool/IConnectionLayerToolDefaults.ts:27
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
getProjectionZoom()
getProjectionZoom():
number
It returns optiomal zoom for D3 projections.
Returns
number
Source
tools/layers/connection/model/types/tool/IConnectionLayerToolDefaults.ts:47
getProps()
getProps():
IMapObjectProps
It returns default props if no props are given.
Returns
Inherited from
Source
model/types/object/IMapObjectDefaults.ts:17
getToDimension()
getToDimension(
map
?):IMapDomainDimension
\<IMapDataDomain
>
It returns the default geo target ID dimension.
Parameters
• map?: IMap
\<IMapProps
, IMapDefaults
, IMapState
\<IMapProps
, IMapDefaults
, IMapConfig
>, IMapConfig
, IMapInitProps
\<IMapConfig
>>
Returns
IMapDomainDimension
\<IMapDataDomain
>
Source
tools/layers/connection/model/types/tool/IConnectionLayerToolDefaults.ts:37
getType()
getType():
string
It returns a unique type string of the map object.
Returns
string
Inherited from
Source
model/types/object/IMapObjectDefaults.ts:27
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