ConnectionLayerToolState

geovisto-map • Readme | API

---

geovisto-map / ConnectionLayerToolState

Class: ConnectionLayerToolState

This class provide functions for using the state of the layer tool.

Author

Jiri Hynek

Extends

• LayerToolState

Implements

• IConnectionLayerToolState

Constructors

new ConnectionLayerToolState()

new ConnectionLayerToolState(tool): ConnectionLayerToolState

It creates a tool state.

Parameters

• tool: IConnectionLayerTool\<IConnectionLayerToolProps, IConnectionLayerToolDefaults, IConnectionLayerToolState\<IConnectionLayerToolProps, IConnectionLayerToolDefaults, IConnectionLayerToolConfig, object, object>, IConnectionLayerToolConfig, IMapToolInitProps\<IConnectionLayerToolConfig>>

Returns

ConnectionLayerToolState

Overrides

LayerToolState.constructor

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolState.ts:28

Properties

bucketData

private bucketData: object

connections

connections: Map\<string, IMapAggregationBucket>

nodes

nodes: Set\<string>

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolState.ts:23

---

svgLayer?

private optional svgLayer: any

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolState.ts:22

Methods

deserialize()

deserialize(config): void

The metod takes config and deserializes the values.

Parameters

• config: IConnectionLayerToolConfig

Returns

void

Implementation of

IConnectionLayerToolState.deserialize

Overrides

LayerToolState.deserialize

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolState.ts:70

---

deserializeDimensions()

deserializeDimensions(dimensionsConfig): void

It sets the map layer dimensions property of tool state.

Parameters

• dimensionsConfig

• dimensionsConfig.direction?: boolean

• dimensionsConfig.from?: string

• dimensionsConfig.geoData?: string

• dimensionsConfig.to?: string

Returns

void

Implementation of

IConnectionLayerToolState.deserializeDimensions

Overrides

LayerToolState.deserializeDimensions

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolState.ts:80

---

getBucketData()

getBucketData(): object

It returns work data for the force layout algorithm.

Returns

object

connections

connections: Map\<string, IMapAggregationBucket>

nodes

nodes: Set\<string>

Implementation of

IConnectionLayerToolState.getBucketData

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolState.ts:143

---

getDimensions()

getDimensions(): object

It returns the map layer dimensions property of the tool state.

Returns

object

direction

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

from

from: IMapDomainDimension\<IMapDataDomain>

geoData

geoData: IMapDomainDimension\<IGeoData>

to

to: IMapDomainDimension\<IMapDataDomain>

Implementation of

IConnectionLayerToolState.getDimensions

Overrides

LayerToolState.getDimensions

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolState.ts:111

---

getIcon()

getIcon(): string

It returns the icon property of the tool state.

Returns

string

Implementation of

IConnectionLayerToolState.getIcon

Inherited from

LayerToolState.getIcon

Source

model/internal/tool/MapToolState.ts:120

---

getId()

getId(): string

It returns the id property of the tool state.

Returns

string

Implementation of

IConnectionLayerToolState.getId

Inherited from

LayerToolState.getId

Source

model/internal/object/MapObjectState.ts:87

---

getLabel()

getLabel(): string

It returns the label property of the tool state.

Returns

string

Implementation of

IConnectionLayerToolState.getLabel

Inherited from

LayerToolState.getLabel

Source

model/internal/tool/MapToolState.ts:104

---

getLayerItems()

getLayerItems(): undefined | Layer[]

It returns the layer items property of the tool state.

Returns

undefined | Layer[]

Implementation of

IConnectionLayerToolState.getLayerItems

Inherited from

LayerToolState.getLayerItems

Source

model/internal/layer/LayerToolState.ts:104

---

getLayerName()

getLayerName(): string

It returns the layer name property of the tool state.

Returns

string

Implementation of

IConnectionLayerToolState.getLayerName

Inherited from

LayerToolState.getLayerName

Source

model/internal/layer/LayerToolState.ts:88

---

getMap()

getMap(): IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

It returns the map property of the tool state.

Returns

IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

Implementation of

IConnectionLayerToolState.getMap

Inherited from

LayerToolState.getMap

Source

model/internal/tool/MapToolState.ts:136

---

getMapObject()

protected getMapObject(): IMapObject\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectState\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>

It makes the map object visible to extended classes.

Returns

IMapObject\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectState\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>

Inherited from

LayerToolState.getMapObject

Source

model/internal/object/MapObjectState.ts:39

---

getSVGLayer()

getSVGLayer(): any

It returns a Leaflet SVG layer.

Returns

any

Implementation of

IConnectionLayerToolState.getSVGLayer

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolState.ts:127

---

getType()

getType(): string

It returns the type property of the tool state.

Returns

string

Implementation of

IConnectionLayerToolState.getType

Inherited from

LayerToolState.getType

Source

model/internal/object/MapObjectState.ts:80

---

initialize()

initialize(defaults, props, initProps): void

It resets state with respect to initial props.

Parameters

• defaults: IConnectionLayerToolDefaults

• props: IConnectionLayerToolProps

• initProps: IMapToolInitProps\<IConnectionLayerToolConfig>

Returns

void

Implementation of

IConnectionLayerToolState.initialize

Overrides

LayerToolState.initialize

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolState.ts:39

---

isEnabled()

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns

boolean

Implementation of

IConnectionLayerToolState.isEnabled

Inherited from

LayerToolState.isEnabled

Source

model/internal/tool/MapToolState.ts:88

---

serialize()

serialize(defaults): IConnectionLayerToolConfig

The method serializes the tool state. Optionally, defaults can be set if property is undefined.

Parameters

• defaults: undefined | IConnectionLayerToolDefaults

Returns

IConnectionLayerToolConfig

Implementation of

IConnectionLayerToolState.serialize

Overrides

LayerToolState.serialize

Source

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

---

setBucketData()

setBucketData(bucketData): void

It sets the work data for the force layout algorithm.

Parameters

• bucketData

• bucketData.connections: Map\<string, IMapAggregationBucket>

• bucketData.nodes: Set\<string>

Returns

void

Implementation of

IConnectionLayerToolState.setBucketData

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolState.ts:152

---

setDimensions()

setDimensions(dimensions): void

It sets the map layer dimensions property of tool state.

Parameters

• dimensions

• dimensions.direction: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

• dimensions.from: IMapDomainDimension\<IMapDataDomain>

• dimensions.geoData: IMapDomainDimension\<IGeoData>

• dimensions.to: IMapDomainDimension\<IMapDataDomain>

Returns

void

Implementation of

IConnectionLayerToolState.setDimensions

Overrides

LayerToolState.setDimensions

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolState.ts:120

---

setEnabled()

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters

• enabled: boolean

Returns

void

Implementation of

IConnectionLayerToolState.setEnabled

Inherited from

LayerToolState.setEnabled

Source

model/internal/tool/MapToolState.ts:97

---

setIcon()

setIcon(icon): void

It sets the icon property of the tool state.

Parameters

• icon: string

Returns

void

Implementation of

IConnectionLayerToolState.setIcon

Inherited from

LayerToolState.setIcon

Source

model/internal/tool/MapToolState.ts:129

---

setId()

setId(id): void

It sets the id property of the tool state.

Parameters

• id: string

Returns

void

Implementation of

IConnectionLayerToolState.setId

Inherited from

LayerToolState.setId

Source

model/internal/object/MapObjectState.ts:96

---

setLabel()

setLabel(label): void

It sets the label property of the tool state.

Parameters

• label: string

Returns

void

Implementation of

IConnectionLayerToolState.setLabel

Inherited from

LayerToolState.setLabel

Source

model/internal/tool/MapToolState.ts:113

---

setLayerItems()

setLayerItems(layerItems): void

It sets the layer items property of tool state.

Parameters

• layerItems: Layer[]

Returns

void

Implementation of

IConnectionLayerToolState.setLayerItems

Inherited from

LayerToolState.setLayerItems

Source

model/internal/layer/LayerToolState.ts:113

---

setLayerName()

setLayerName(layerName): void

It sets the layer name property of the tool state.

Parameters

• layerName: string

Returns

void

Implementation of

IConnectionLayerToolState.setLayerName

Inherited from

LayerToolState.setLayerName

Source

model/internal/layer/LayerToolState.ts:97

---

setMap()

protected setMap(map): void

It sets the map property of the tool state.

Parameters

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

Returns

void

Inherited from

LayerToolState.setMap

Source

model/internal/tool/MapToolState.ts:145

---

setSVGLayer()

setSVGLayer(svgLayer): void

It sets a Leaflet SVG layer.

Parameters

• svgLayer: SVG

Returns

void

Implementation of

IConnectionLayerToolState.setSVGLayer

Source

tools/layers/connection/model/internal/tool/ConnectionLayerToolState.ts:136