ConnectionLayerToolDefaults

geovisto-map • Readme | API

---

geovisto-map / ConnectionLayerToolDefaults

Class: ConnectionLayerToolDefaults

This class provide functions which return the default state values.

Author

Jiri Hynek

Extends

• LayerToolDefaults

Implements

• IConnectionLayerToolDefaults

Constructors

new ConnectionLayerToolDefaults()

new ConnectionLayerToolDefaults(): ConnectionLayerToolDefaults

Returns

ConnectionLayerToolDefaults

Inherited from

LayerToolDefaults.constructor

Properties

idString?

protected optional idString: string

Inherited from

LayerToolDefaults.idString

Source

model/internal/object/MapObjectDefaults.ts:13

---

TYPE

static TYPE: string = "geovisto-tool-layer-connection"

Static tool type constant.

Overrides

LayerToolDefaults.TYPE

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolDefaults.ts:26

---

id

static protected id: number

Inherited from

LayerToolDefaults.id

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

LayerToolDefaults.generateId

Source

model/internal/object/MapObjectDefaults.ts:54

---

getConfig()

getConfig(): IMapToolConfig

By defaults it returns the config with undefined props.

Returns

IMapToolConfig

Implementation of

IConnectionLayerToolDefaults.getConfig

Inherited from

LayerToolDefaults.getConfig

Source

model/internal/tool/MapToolDefaults.ts:34

---

getDataManager()

getDataManager(): IMapDataManager

It returns default map data manager.

Returns

IMapDataManager

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

direction

direction: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

from

from: IMapDomainDimension\<IMapDataDomain>

geoData

geoData: IMapDomainDimension\<IGeoData>

to

to: IMapDomainDimension\<IMapDataDomain>

Implementation of

IConnectionLayerToolDefaults.getDimensions

Overrides

LayerToolDefaults.getDimensions

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolDefaults.ts:59

---

getDirectionDimension()

getDirectionDimension(): IMapTypeDimension\<boolean, ITypeManager\<boolean>>

It returns the animate direction dimension.

Returns

IMapTypeDimension\<boolean, ITypeManager\<boolean>>

Implementation of

IConnectionLayerToolDefaults.getDirectionDimension

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolDefaults.ts:104

---

getFromDimension()

getFromDimension(map?): IMapDomainDimension\<IMapDataDomain>

It returns the source geo ID dimension.

Parameters

• map?: IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

Returns

IMapDomainDimension\<IMapDataDomain>

Implementation of

IConnectionLayerToolDefaults.getFromDimension

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolDefaults.ts:82

---

getGeoData()

getGeoData(): IGeoData[]

It returns the default geo data.

Returns

IGeoData[]

Implementation of

IConnectionLayerToolDefaults.getGeoData

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolDefaults.ts:122

---

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

IConnectionLayerToolDefaults.getGeoDataDimension

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolDefaults.ts:71

---

getGeoDataManager()

getGeoDataManager(geoDataArray): IGeoDataManager

It returns default geo data manager.

Parameters

• geoDataArray: undefined | IGeoData[]

Returns

IGeoDataManager

Inherited from

LayerToolDefaults.getGeoDataManager

Source

model/internal/tool/MapToolDefaults.ts:27

---

getIcon()

getIcon(): string

It returns the icon of the tool.

Returns

string

Implementation of

IConnectionLayerToolDefaults.getIcon

Overrides

LayerToolDefaults.getIcon

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolDefaults.ts:52

---

getId()

getId(): string

It returns identifier which is used when no identifier is specified.

Returns

string

Implementation of

IConnectionLayerToolDefaults.getId

Inherited from

LayerToolDefaults.getId

Source

model/internal/object/MapObjectDefaults.ts:44

---

getLabel()

getLabel(): string

It returns the label of the tool.

Returns

string

Implementation of

IConnectionLayerToolDefaults.getLabel

Overrides

LayerToolDefaults.getLabel

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolDefaults.ts:45

---

getLayerName()

getLayerName(): string

It returns the layer name.

Returns

string

Implementation of

IConnectionLayerToolDefaults.getLayerName

Overrides

LayerToolDefaults.getLayerName

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolDefaults.ts:38

---

getProjectionZoom()

getProjectionZoom(): number

It returns optiomal zoom for D3 projections.

Returns

number

Implementation of

IConnectionLayerToolDefaults.getProjectionZoom

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolDefaults.ts:115

---

getProps()

getProps(): IMapObjectProps

It returns default props if no props are given.

Returns

IMapObjectProps

Implementation of

IConnectionLayerToolDefaults.getProps

Inherited from

LayerToolDefaults.getProps

Source

model/internal/object/MapObjectDefaults.ts:18

---

getToDimension()

getToDimension(map?): IMapDomainDimension\<IMapDataDomain>

It returns the target geo ID dimension.

Parameters

• map?: IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

Returns

IMapDomainDimension\<IMapDataDomain>

Implementation of

IConnectionLayerToolDefaults.getToDimension

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolDefaults.ts:93

---

getType()

getType(): string

It returns a unique type string of the tool which is based on the layer it wraps.

Returns

string

Implementation of

IConnectionLayerToolDefaults.getType

Overrides

LayerToolDefaults.getType

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolDefaults.ts:31

---

isEnabled()

isEnabled(): boolean

By default, the tool is enabled.

Returns

boolean

Implementation of

IConnectionLayerToolDefaults.isEnabled

Inherited from

LayerToolDefaults.isEnabled

Source

model/internal/tool/MapToolDefaults.ts:50

---

isSingleton()

isSingleton(): boolean

By default, the tool is singleton

Returns

boolean

Implementation of

IConnectionLayerToolDefaults.isSingleton

Inherited from

LayerToolDefaults.isSingleton

Source

model/internal/tool/MapToolDefaults.ts:43