IChoroplethLayerToolDefaults

geovisto-map • Readme | API

---

geovisto-map / IChoroplethLayerToolDefaults

Interface: IChoroplethLayerToolDefaults

This interface declares functions which return the default state values.

Author

Jiri Hynek

Extends

• ILayerToolDefaults

Methods

getAggregationDimension()

getAggregationDimension(): IMapDomainDimension\<IMapAggregationFunction>

It returns the default aggregation function dimension.

Returns

IMapDomainDimension\<IMapAggregationFunction>

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:46

---

getColorDimension()

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

It returns the color dimension.

Returns

IMapTypeDimension\<string, ITypeManager\<string>>

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:56

---

getConfig()

getConfig(): IMapToolConfig

It returns default config if no config is given.

Returns

IMapToolConfig

Inherited from

ILayerToolDefaults.getConfig

Source

model/types/tool/IMapToolDefaults.ts:14

---

getCustomColorDimension()

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

It returns the animate direction dimension.

Returns

IMapTypeDimension\<boolean, ITypeManager\<boolean>>

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:51

---

getCustomMinMaxDimension()

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

It returns the custom min-max dimension.

Returns

IMapTypeDimension\<boolean, ITypeManager\<boolean>>

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:71

---

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>

Overrides

ILayerToolDefaults.getDimensions

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:26

---

getGeoData()

getGeoData(): IGeoData[]

It returns the default geo data.

Returns

IGeoData[]

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:106

---

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/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:31

---

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>

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:36

---

getIcon()

getIcon(): string

It returns the icon of the tool.

Returns

string

Inherited from

ILayerToolDefaults.getIcon

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

ILayerToolDefaults.getId

Source

model/types/object/IMapObjectDefaults.ts:32

---

getLabel()

getLabel(): string

It returns the label of the tool.

Returns

string

Inherited from

ILayerToolDefaults.getLabel

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

---

getMaxValueDimension()

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

It returns the max value dimension.

Returns

IMapTypeDimension\<number, ITypeManager\<number>>

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:81

---

getMinValueDimension()

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

It returns the min value dimension.

Returns

IMapTypeDimension\<number, ITypeManager\<number>>

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:76

---

getProps()

getProps(): IMapObjectProps

It returns default props if no props are given.

Returns

IMapObjectProps

Inherited from

ILayerToolDefaults.getProps

Source

model/types/object/IMapObjectDefaults.ts:17

---

getRangeDimension()

getRangeDimension(): IMapTypeDimension\<number, IIntegerRangeManager>

It returns the range dimension.

Returns

IMapTypeDimension\<number, IIntegerRangeManager>

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:61

---

getRoundDimension()

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

It returns the round dimension.

Returns

IMapTypeDimension\<number, ITypeManager\<number>>

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:101

---

getScalingDimension()

getScalingDimension(): IMapDomainDimension\<IScale>

It returns the scaling dimension.

Returns

IMapDomainDimension\<IScale>

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:66

---

getType()

getType(): string

It returns a unique type string of the map object.

Returns

string

Inherited from

ILayerToolDefaults.getType

Source

model/types/object/IMapObjectDefaults.ts:27

---

getUnitsDescDimension()

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

It returns the units description value dimension.

Returns

IMapTypeDimension\<string, ITypeManager\<string>>

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:91

---

getUnitsDimension()

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

It returns the units dimension.

Returns

IMapTypeDimension\<string, ITypeManager\<string>>

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:86

---

getUnitsEnabledDimension()

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

It returns the units state value dimension.

Returns

IMapTypeDimension\<boolean, ITypeManager\<boolean>>

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:96

---

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>

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:41

---

getZIndex()

getZIndex(): number

It returns preferred z index for the choropoleth layer

Returns

number

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolDefaults.ts:111

---

isEnabled()

isEnabled(): boolean

By default, the tool is enabled.

Returns

boolean

Inherited from

ILayerToolDefaults.isEnabled

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

Source

model/types/tool/IMapToolDefaults.ts:19