ChoroplethLayerToolMapForm

geovisto-map • Readme | API

---

geovisto-map / ChoroplethLayerToolMapForm

Class: ChoroplethLayerToolMapForm

This class provides controls for management of the layer sidebar tab.

Author

Jiri Hynek

Extends

• MapLayerToolForm\<IChoroplethLayerTool>

Implements

• IMapForm

Constructors

new ChoroplethLayerToolMapForm()

new ChoroplethLayerToolMapForm(tool): ChoroplethLayerToolMapForm

It creates new map form with respect to the given props.

Parameters

• tool: IChoroplethLayerTool\<IChoroplethLayerToolProps, IChoroplethLayerToolDefaults, IChoroplethLayerToolState\<IChoroplethLayerToolProps, IChoroplethLayerToolDefaults, IChoroplethLayerToolConfig, object, object>, IChoroplethLayerToolConfig, IMapToolInitProps\<IChoroplethLayerToolConfig>>

Returns

ChoroplethLayerToolMapForm

Overrides

MapLayerToolForm.constructor

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:49

Properties

htmlContent

private htmlContent: HTMLDivElement

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:25

---

inputs?

private optional inputs: object

aggregation

aggregation: IMapFormInput

color

color: IMapFormInput

customColor

customColor: IMapFormInput

customMinMax

customMinMax: IMapFormInput

geoData

geoData: IMapFormInput

geoId

geoId: IMapFormInput

maxValue

maxValue: IMapFormInput

minValue

minValue: IMapFormInput

range

range: IMapFormInput

scaling

scaling: IMapFormInput

units

units: IMapFormInput

unitsDesc

unitsDesc: IMapFormInput

unitsEnabled

unitsEnabled: IMapFormInput

value

value: IMapFormInput

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:27

Methods

getAutocompleteInput()

protected getAutocompleteInput(dimension, formAction?): IMapFormInput

Help method which returns a new universal autocomplete input for the any map domain dimension.

Parameters

• dimension: IMapDomainDimension\<IMapDomain>

• formAction?

Returns

IMapFormInput

Inherited from

MapLayerToolForm.getAutocompleteInput

Source

model/internal/form/MapLayerToolForm.ts:43

---

getCheckboxInput()

protected getCheckboxInput(dimension, formAction?): IMapFormInput

Help method which returns a new universal checkbox input for the any map boolean dimension.

Parameters

• dimension: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

• formAction?

Returns

IMapFormInput

Inherited from

MapLayerToolForm.getCheckboxInput

Source

model/internal/form/MapLayerToolForm.ts:78

---

getColorInput()

protected getColorInput(dimension, formAction?): IMapFormInput

Help method which returns a new universal color input for the any map string dimension.

Parameters

• dimension: IMapTypeDimension\<string, ITypeManager\<string>>

• formAction?

Returns

IMapFormInput

Inherited from

MapLayerToolForm.getColorInput

Source

model/internal/form/MapLayerToolForm.ts:96

---

getContent()

getContent(): HTMLDivElement

It returns the sidebar tab pane.

Returns

HTMLDivElement

Implementation of

IMapForm.getContent

Overrides

MapLayerToolForm.getContent

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:87

---

getInputAggregation()

getInputAggregation(dimension): IMapFormInput

It returns new input for the geo dimension.

Parameters

• dimension: IMapDomainDimension\<IMapAggregationFunction>

Returns

IMapFormInput

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:169

---

getInputColor()

getInputColor(dimension): IMapFormInput

It returns new input for the color dimension.

Parameters

• dimension: IMapTypeDimension\<string, ITypeManager\<string>>

Returns

IMapFormInput

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:219

---

getInputCustomColor()

getInputCustomColor(dimension): IMapFormInput

It returns new input for the custom color dimension.

Parameters

• dimension: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

Returns

IMapFormInput

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:178

---

getInputCustomMinMax()

getInputCustomMinMax(dimension): IMapFormInput

It returns new input for the custom min-max dimension.

Parameters

• dimension: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

Returns

IMapFormInput

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:246

---

getInputGeoData()

getInputGeoData(dimension): IMapFormInput

It returns new input for the geo data dimension.

Parameters

• dimension: IMapDomainDimension\<IGeoData>

Returns

IMapFormInput

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:142

---

getInputGeoId()

getInputGeoId(dimension): IMapFormInput

It returns new input for the geo id dimension.

Parameters

• dimension: IMapDomainDimension\<IMapDataDomain>

Returns

IMapFormInput

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:151

---

getInputMaxValue()

getInputMaxValue(dimension): IMapFormInput

It returns new input for the max value dimension.

Parameters

• dimension: IMapTypeDimension\<number, ITypeManager\<number>>

Returns

IMapFormInput

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:268

---

getInputMinValue()

getInputMinValue(dimension): IMapFormInput

It returns new input for the min value dimension.

Parameters

• dimension: IMapTypeDimension\<number, ITypeManager\<number>>

Returns

IMapFormInput

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:259

---

getInputRange()

getInputRange(dimension): IMapFormInput

It returns new input for the range dimension.

Parameters

• dimension: IMapTypeDimension\<number, IIntegerRangeManager>

Returns

IMapFormInput

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:228

---

getInputScaling()

getInputScaling(dimension): IMapFormInput

It returns new input for the scaling dimension.

Parameters

• dimension: IMapDomainDimension\<IScale>

Returns

IMapFormInput

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:237

---

getInputUnits()

getInputUnits(dimension): IMapFormInput

It returns new input for the units dimension.

Parameters

• dimension: IMapTypeDimension\<string, ITypeManager\<string>>

Returns

IMapFormInput

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:201

---

getInputUnitsDesc()

getInputUnitsDesc(dimension): IMapFormInput

It returns new input for the units description dimension.

Parameters

• dimension: IMapTypeDimension\<string, ITypeManager\<string>>

Returns

IMapFormInput

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:210

---

getInputUnitsEnabled()

getInputUnitsEnabled(dimension): IMapFormInput

It returns new input for the enabling inputs dimension.

Parameters

• dimension: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

Returns

IMapFormInput

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:189

---

getInputValue()

getInputValue(dimension): IMapFormInput

It returns new input for the geo dimension.

Parameters

• dimension: IMapDomainDimension\<IMapDataDomain>

Returns

IMapFormInput

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:160

---

getMapObject()

protected getMapObject(): IChoroplethLayerTool\<IChoroplethLayerToolProps, IChoroplethLayerToolDefaults, IChoroplethLayerToolState\<IChoroplethLayerToolProps, IChoroplethLayerToolDefaults, IChoroplethLayerToolConfig, object, object>, IChoroplethLayerToolConfig, IMapToolInitProps\<IChoroplethLayerToolConfig>>

Returns

IChoroplethLayerTool\<IChoroplethLayerToolProps, IChoroplethLayerToolDefaults, IChoroplethLayerToolState\<IChoroplethLayerToolProps, IChoroplethLayerToolDefaults, IChoroplethLayerToolConfig, object, object>, IChoroplethLayerToolConfig, IMapToolInitProps\<IChoroplethLayerToolConfig>>

Inherited from

MapLayerToolForm.getMapObject

Source

model/internal/form/MapObjectForm.ts:16

---

getNumberInput()

protected getNumberInput(dimension, formAction?): IMapFormInput

Help method which returns a new universal number input for the any map number dimension.

Parameters

• dimension: IMapTypeDimension\<number, ITypeManager\<number>>

• formAction?

Returns

IMapFormInput

Inherited from

MapLayerToolForm.getNumberInput

Source

model/internal/form/MapLayerToolForm.ts:133

---

getSliderInput()

protected getSliderInput(dimension, formAction?): IMapFormInput

Help method which returns a new universal slider input for the any map range integer dimension.

Parameters

• dimension: IMapTypeDimension\<number, IIntegerRangeManager>

• formAction?

Returns

IMapFormInput

Inherited from

MapLayerToolForm.getSliderInput

Source

model/internal/form/MapLayerToolForm.ts:113

---

getTextInput()

protected getTextInput(dimension, formAction?): IMapFormInput

Help method which returns a new universal text input for the any map domain dimension.

Parameters

• dimension: IMapTypeDimension\<string, ITypeManager\<string>>

• formAction?

Returns

IMapFormInput

Inherited from

MapLayerToolForm.getTextInput

Source

model/internal/form/MapLayerToolForm.ts:61

---

setInputValues()

setInputValues(dimensions): void

It updates selected input values according to the given dimensions.

Parameters

• dimensions

• dimensions.aggregation: IMapDomainDimension\<IMapAggregationFunction>

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

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

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

• dimensions.geoData: IMapDomainDimension\<IGeoData>

• dimensions.geoId: IMapDomainDimension\<IMapDataDomain>

• dimensions.maxValue: IMapTypeDimension\<number, ITypeManager\<number>>

• dimensions.minValue: IMapTypeDimension\<number, ITypeManager\<number>>

• dimensions.range: IMapTypeDimension\<number, IIntegerRangeManager>

• dimensions.round: IMapTypeDimension\<number, ITypeManager\<number>>

• dimensions.scaling: IMapDomainDimension\<IScale>

• dimensions.units: IMapTypeDimension\<string, ITypeManager\<string>>

• dimensions.unitsDesc: IMapTypeDimension\<string, ITypeManager\<string>>

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

• dimensions.value: IMapDomainDimension\<IMapDataDomain>

Returns

void

Overrides

MapLayerToolForm.setInputValues

Source

tools/layers/choropleth/model/internal/form/ChoroplethLayerToolMapForm.ts:58