Skip to main content

BubbleLayerToolState

geovisto-mapReadme | API


geovisto-map / BubbleLayerToolState

Class: BubbleLayerToolState

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

Author

Vladimir Korencik

Extends

Implements

Constructors

new BubbleLayerToolState()

new BubbleLayerToolState(tool): BubbleLayerToolState

Parameters

tool: IBubbleLayerTool\<IBubbleLayerToolProps, IBubbleLayerToolDefaults, IBubbleLayerToolState\<IBubbleLayerToolProps, IBubbleLayerToolDefaults, IBubbleLayerToolConfig, object, object>, IBubbleLayerToolConfig, IMapToolInitProps\<IBubbleLayerToolConfig>>

Returns

BubbleLayerToolState

Overrides

LayerToolState.constructor

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:36

Properties

categoryColorRules

private categoryColorRules: ICategoryColorRules[]

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:33


layer?

private optional layer: any

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:30


manager

private manager: IMapFilterManager

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:34


markers

private markers: Marker[]

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:31


workData

private workData: any[]

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:32

Methods

deserialize()

deserialize(config): void

The metod takes config and deserializes the values.

Parameters

config: IBubbleLayerToolConfig

Returns

void

Implementation of

IBubbleLayerToolState.deserialize

Overrides

LayerToolState.deserialize

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:101


deserializeDimensions()

deserializeDimensions(dimensionsConfig): void

It sets the marker layer dimensions property of tool state.

Parameters

dimensionsConfig

dimensionsConfig.aggregation?: string

dimensionsConfig.bubbleSize?: number

dimensionsConfig.category?: string

dimensionsConfig.categoryColor?: string

dimensionsConfig.categoryColorOp?: string

dimensionsConfig.categoryColorValue?: string

dimensionsConfig.color?: string

dimensionsConfig.latitude?: string

dimensionsConfig.longitude?: string

dimensionsConfig.value?: string

Returns

void

Implementation of

IBubbleLayerToolState.deserializeDimensions

Overrides

LayerToolState.deserializeDimensions

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:128


getCategoryColorRules()

getCategoryColorRules(): ICategoryColorRules[]

Returns

ICategoryColorRules[]

Implementation of

IBubbleLayerToolState.getCategoryColorRules

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:253


getDimensions()

getDimensions(): object

It returns the layer dimensions property of the tool state.

Returns

object

aggregation

aggregation: IMapDomainDimension\<IMapAggregationFunction>

bubbleSize

bubbleSize: IMapTypeDimension\<number, IIntegerRangeManager>

category

category: IMapDomainDimension\<IMapDataDomain>

categoryColor

categoryColor: IMapTypeDimension\<string, ITypeManager\<string>>

categoryColorOp

categoryColorOp: IMapDomainDimension\<IMapFilterOperation>

categoryColorValue

categoryColorValue: IMapTypeDimension\<string, ITypeManager\<string>>

color

color: IMapTypeDimension\<string, ITypeManager\<string>>

latitude

latitude: IMapDomainDimension\<IMapDataDomain>

longitude

longitude: IMapDomainDimension\<IMapDataDomain>

value

value: IMapDomainDimension\<IMapDataDomain>

Implementation of

IBubbleLayerToolState.getDimensions

Overrides

LayerToolState.getDimensions

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:225


getFiltersManager()

getFiltersManager(): IMapFilterManager

Returns

IMapFilterManager

Implementation of

IBubbleLayerToolState.getFiltersManager

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:215


getIcon()

getIcon(): string

It returns the icon property of the tool state.

Returns

string

Implementation of

IBubbleLayerToolState.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

IBubbleLayerToolState.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

IBubbleLayerToolState.getLabel

Inherited from

LayerToolState.getLabel

Source

model/internal/tool/MapToolState.ts:104


getLayer()

getLayer(): any

Returns

any

Implementation of

IBubbleLayerToolState.getLayer

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:233


getLayerItems()

getLayerItems(): undefined | Layer[]

It returns the layer items property of the tool state.

Returns

undefined | Layer[]

Implementation of

IBubbleLayerToolState.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

IBubbleLayerToolState.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

IBubbleLayerToolState.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


getMarkers()

getMarkers(): Marker[]

Returns

Marker[]

Implementation of

IBubbleLayerToolState.getMarkers

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:241


getType()

getType(): string

It returns the type property of the tool state.

Returns

string

Implementation of

IBubbleLayerToolState.getType

Inherited from

LayerToolState.getType

Source

model/internal/object/MapObjectState.ts:80


getWorkData()

getWorkData(): any[]

Returns

any[]

Implementation of

IBubbleLayerToolState.getWorkData

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:261


initialize()

initialize(defaults, props, initProps): void

It resets the state with respect to the initial props.

Parameters

defaults: IBubbleLayerToolDefaults

props: IBubbleLayerToolProps

initProps: IMapToolInitProps\<IBubbleLayerToolConfig>

Returns

void

Implementation of

IBubbleLayerToolState.initialize

Overrides

LayerToolState.initialize

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:44


isEnabled()

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns

boolean

Implementation of

IBubbleLayerToolState.isEnabled

Inherited from

LayerToolState.isEnabled

Source

model/internal/tool/MapToolState.ts:88


serialize()

serialize(defaults): IBubbleLayerToolConfig

The method serializes the map object state. Optionally, a serialized value can be let undefined if it equals the default value.

Parameters

defaults: undefined | IBubbleLayerToolDefaults

Returns

IBubbleLayerToolConfig

Implementation of

IBubbleLayerToolState.serialize

Overrides

LayerToolState.serialize

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:180


setCategoryColorRules()

setCategoryColorRules(rules): void

Parameters

rules: ICategoryColorRules[]

Returns

void

Implementation of

IBubbleLayerToolState.setCategoryColorRules

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:249


setDimensions()

setDimensions(dimensions): void

It sets the layer dimensions property of tool state.

Parameters

dimensions

dimensions.aggregation: IMapDomainDimension\<IMapAggregationFunction>

dimensions.bubbleSize: IMapTypeDimension\<number, IIntegerRangeManager>

dimensions.category: IMapDomainDimension\<IMapDataDomain>

dimensions.categoryColor: IMapTypeDimension\<string, ITypeManager\<string>>

dimensions.categoryColorOp: IMapDomainDimension\<IMapFilterOperation>

dimensions.categoryColorValue: IMapTypeDimension\<string, ITypeManager\<string>>

dimensions.color: IMapTypeDimension\<string, ITypeManager\<string>>

dimensions.latitude: IMapDomainDimension\<IMapDataDomain>

dimensions.longitude: IMapDomainDimension\<IMapDataDomain>

dimensions.value: IMapDomainDimension\<IMapDataDomain>

Returns

void

Implementation of

IBubbleLayerToolState.setDimensions

Overrides

LayerToolState.setDimensions

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:229


setEnabled()

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters

enabled: boolean

Returns

void

Implementation of

IBubbleLayerToolState.setEnabled

Inherited from

LayerToolState.setEnabled

Source

model/internal/tool/MapToolState.ts:97


setFiltersManager()

setFiltersManager(manager): void

Parameters

manager: IMapFilterManager

Returns

void

Implementation of

IBubbleLayerToolState.setFiltersManager

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:220


setIcon()

setIcon(icon): void

It sets the icon property of the tool state.

Parameters

icon: string

Returns

void

Implementation of

IBubbleLayerToolState.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

IBubbleLayerToolState.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

IBubbleLayerToolState.setLabel

Inherited from

LayerToolState.setLabel

Source

model/internal/tool/MapToolState.ts:113


setLayer()

setLayer(layer): void

Parameters

layer: LayerGroup

Returns

void

Implementation of

IBubbleLayerToolState.setLayer

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:237


setLayerItems()

setLayerItems(layerItems): void

It sets the layer items property of tool state.

Parameters

layerItems: Layer[]

Returns

void

Implementation of

IBubbleLayerToolState.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

IBubbleLayerToolState.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


setMarkers()

setMarkers(markers): void

Parameters

markers: Marker[]

Returns

void

Implementation of

IBubbleLayerToolState.setMarkers

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:245


setWorkData()

setWorkData(workData): void

Parameters

workData: any[]

Returns

void

Implementation of

IBubbleLayerToolState.setWorkData

Source

tools/layers/bubble/model/internal/tool/BubbleLayerToolState.ts:257