ChoroplethLayerToolDefaults

geovisto-map • Readme | API

---

geovisto-map / ChoroplethLayerToolDefaults

Class: ChoroplethLayerToolDefaults

This class provide functions which return the default state values.

Author

Jiri Hynek

Extends

• LayerToolDefaults

Implements

• IChoroplethLayerToolDefaults

Constructors

new ChoroplethLayerToolDefaults()

new ChoroplethLayerToolDefaults(): ChoroplethLayerToolDefaults

Returns

ChoroplethLayerToolDefaults

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-choropleth"

Static tool type constant.

Overrides

LayerToolDefaults.TYPE

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:41

---

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

---

getAggregationDimension()

getAggregationDimension(): IMapDomainDimension\<IMapAggregationFunction>

It returns the default aggregation function dimension.

Returns

IMapDomainDimension\<IMapAggregationFunction>

Implementation of

IChoroplethLayerToolDefaults.getAggregationDimension

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:130

---

getColorDimension()

getColorDimension(): IMapTypeDimension\<string, ITypeManager\<string>>

It returns the color dimension.

Returns

IMapTypeDimension\<string, ITypeManager\<string>>

Implementation of

IChoroplethLayerToolDefaults.getColorDimension

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:159

---

getConfig()

getConfig(): IMapToolConfig

By defaults it returns the config with undefined props.

Returns

IMapToolConfig

Implementation of

IChoroplethLayerToolDefaults.getConfig

Inherited from

LayerToolDefaults.getConfig

Source

model/internal/tool/MapToolDefaults.ts:34

---

getCustomColorDimension()

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

It returns the animate direction dimension.

Returns

IMapTypeDimension\<boolean, ITypeManager\<boolean>>

Implementation of

IChoroplethLayerToolDefaults.getCustomColorDimension

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:148

---

getCustomMinMaxDimension()

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

It returns the custom min-max dimension.

Returns

IMapTypeDimension\<boolean, ITypeManager\<boolean>>

Implementation of

IChoroplethLayerToolDefaults.getCustomMinMaxDimension

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:201

---

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

aggregation

aggregation: IMapDomainDimension\<IMapAggregationFunction>

color

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

customColor

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

customMinMax

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

geoData

geoData: IMapDomainDimension\<IGeoData>

geoId

geoId: IMapDomainDimension\<IMapDataDomain>

maxValue

maxValue: IMapTypeDimension\<number, ITypeManager\<number>>

minValue

minValue: IMapTypeDimension\<number, ITypeManager\<number>>

range

range: IMapTypeDimension\<number, IIntegerRangeManager>

round

round: IMapTypeDimension\<number, ITypeManager\<number>>

scaling

scaling: IMapDomainDimension\<IScale>

units

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

unitsDesc

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

unitsEnabled

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

value

value: IMapDomainDimension\<IMapDataDomain>

Implementation of

IChoroplethLayerToolDefaults.getDimensions

Overrides

LayerToolDefaults.getDimensions

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:74

---

getGeoData()

getGeoData(): IGeoData[]

It returns the default geo data.

Returns

IGeoData[]

Implementation of

IChoroplethLayerToolDefaults.getGeoData

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:278

---

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

IChoroplethLayerToolDefaults.getGeoDataDimension

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:97

---

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

---

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>

Implementation of

IChoroplethLayerToolDefaults.getGeoIdDimension

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:108

---

getIcon()

getIcon(): string

It returns the icon of the tool.

Returns

string

Implementation of

IChoroplethLayerToolDefaults.getIcon

Overrides

LayerToolDefaults.getIcon

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:67

---

getId()

getId(): string

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

Returns

string

Implementation of

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

IChoroplethLayerToolDefaults.getLabel

Overrides

LayerToolDefaults.getLabel

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:60

---

getLayerName()

getLayerName(): string

It returns the layer name.

Returns

string

Implementation of

IChoroplethLayerToolDefaults.getLayerName

Overrides

LayerToolDefaults.getLayerName

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:53

---

getMaxValueDimension()

getMaxValueDimension(): IMapTypeDimension\<number, ITypeManager\<number>>

It returns the max value dimension.

Returns

IMapTypeDimension\<number, ITypeManager\<number>>

Implementation of

IChoroplethLayerToolDefaults.getMaxValueDimension

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:223

---

getMinValueDimension()

getMinValueDimension(): IMapTypeDimension\<number, ITypeManager\<number>>

It returns the min value dimension.

Returns

IMapTypeDimension\<number, ITypeManager\<number>>

Implementation of

IChoroplethLayerToolDefaults.getMinValueDimension

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:212

---

getProps()

getProps(): IMapObjectProps

It returns default props if no props are given.

Returns

IMapObjectProps

Implementation of

IChoroplethLayerToolDefaults.getProps

Inherited from

LayerToolDefaults.getProps

Source

model/internal/object/MapObjectDefaults.ts:18

---

getRangeDimension()

getRangeDimension(): IMapTypeDimension\<number, IIntegerRangeManager>

It returns the range dimension.

Returns

IMapTypeDimension\<number, IIntegerRangeManager>

Implementation of

IChoroplethLayerToolDefaults.getRangeDimension

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:170

---

getRoundDimension()

getRoundDimension(): IMapTypeDimension\<number, ITypeManager\<number>>

It returns the round dimension.

Returns

IMapTypeDimension\<number, ITypeManager\<number>>

Implementation of

IChoroplethLayerToolDefaults.getRoundDimension

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:267

---

getScalingDimension()

getScalingDimension(): IMapDomainDimension\<IScale>

It returns the scaling dimension.

Returns

IMapDomainDimension\<IScale>

Implementation of

IChoroplethLayerToolDefaults.getScalingDimension

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:181

---

getType()

getType(): string

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

Returns

string

Implementation of

IChoroplethLayerToolDefaults.getType

Overrides

LayerToolDefaults.getType

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:46

---

getUnitsDescDimension()

getUnitsDescDimension(): IMapTypeDimension\<string, ITypeManager\<string>>

It returns the units description value dimension.

Returns

IMapTypeDimension\<string, ITypeManager\<string>>

Implementation of

IChoroplethLayerToolDefaults.getUnitsDescDimension

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:245

---

getUnitsDimension()

getUnitsDimension(): IMapTypeDimension\<string, ITypeManager\<string>>

It returns the units dimension.

Returns

IMapTypeDimension\<string, ITypeManager\<string>>

Implementation of

IChoroplethLayerToolDefaults.getUnitsDimension

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:234

---

getUnitsEnabledDimension()

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

It returns the units state value dimension.

Returns

IMapTypeDimension\<boolean, ITypeManager\<boolean>>

Implementation of

IChoroplethLayerToolDefaults.getUnitsEnabledDimension

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:256

---

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>

Implementation of

IChoroplethLayerToolDefaults.getValueDimension

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:119

---

getZIndex()

getZIndex(): number

It returns preferred z index for the choropoleth layer.

Returns

number

Implementation of

IChoroplethLayerToolDefaults.getZIndex

Source

tools/layers/choropleth/model/internal/tool/ChoroplethLayerToolDefaults.ts:287

---

isEnabled()

isEnabled(): boolean

By default, the tool is enabled.

Returns

boolean

Implementation of

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

IChoroplethLayerToolDefaults.isSingleton

Inherited from

LayerToolDefaults.isSingleton

Source

model/internal/tool/MapToolDefaults.ts:43