Skip to main content

IChoroplethLayerTool

geovisto-map • Readme | API

geovisto-map / IChoroplethLayerTool

Interface: IChoroplethLayerTool\<TProps, TDefaults, TState, TConfig, TInitProps>

This interface declares the choropleth layer tool.

Author​

Jiri Hynek

Extends​

  • ILayerTool\<TProps, TDefaults, TState, TConfig, TInitProps>

Type parameters​

• TProps extends IChoroplethLayerToolProps = IChoroplethLayerToolProps

• TDefaults extends IChoroplethLayerToolDefaults = IChoroplethLayerToolDefaults

• TState extends IChoroplethLayerToolState = IChoroplethLayerToolState

• TConfig extends IChoroplethLayerToolConfig = IChoroplethLayerToolConfig

• TInitProps extends IMapToolInitProps\<TConfig> = IMapToolInitProps\<TConfig>

Methods​

computeColorIntensity()​

computeColorIntensity(val, scale): number

It returns color intensity for the current scale and given value.

Parameters​

• val: number

• scale: number[]

Returns​

number

Source​

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

copy()​

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

It creates a copy of the uninitialized tool.

Returns​

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

Overrides​

ILayerTool.copy

Source​

tools/layers/choropleth/model/types/tool/IChoroplethLayerTool.ts:28

create()​

create(): this

It creates a tool.

Returns​

this

Inherited from​

ILayerTool.create

Source​

model/types/tool/IMapTool.ts:47

getAPIGetter()​

getAPIGetter(): undefined | IMapToolAPIGetter\<IMapToolAPI>

It returns the tool API.

Returns​

undefined | IMapToolAPIGetter\<IMapToolAPI>

Inherited from​

ILayerTool.getAPIGetter

Source​

model/types/tool/IMapTool.ts:32

getDefaults()​

getDefaults(): TDefaults

It returns default values of the state properties.

Returns​

TDefaults

Inherited from​

ILayerTool.getDefaults

Source​

model/types/object/IMapObject.ts:27

getId()​

getId(): string

Help function which returns the id of the object.

Returns​

string

Inherited from​

ILayerTool.getId

Source​

model/types/object/IMapObject.ts:42

getLayerItems()​

getLayerItems(): Layer[]

It returns layer items which should be rendered.

Returns​

Layer[]

Inherited from​

ILayerTool.getLayerItems

Source​

model/types/layer/ILayerTool.ts:31

getMap()​

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

Help function which returns map which uses this tool.

Returns​

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

Inherited from​

ILayerTool.getMap

Source​

model/types/tool/IMapTool.ts:42

getProps()​

getProps(): TProps

It returns the props given by the programmer.

Returns​

TProps

Inherited from​

ILayerTool.getProps

Source​

model/types/object/IMapObject.ts:22

getScale()​

getScale(): undefined | number[]

Help function which returns a scale which can be used to distinguish value levels in choropleth.

Returns​

undefined | number[]

Source​

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

getState()​

getState(): TState

It returns the map object state.

Returns​

TState

Inherited from​

ILayerTool.getState

Source​

model/types/object/IMapObject.ts:32

getType()​

getType(): string

Help function which returns the type of the object.

Returns​

string

Inherited from​

ILayerTool.getType

Source​

model/types/object/IMapObject.ts:37

initialize()​

initialize(initProps): this

It initializes the state of the object. It processes the serialized config and sets further objects.

This cannot be done in the object constructor since the object can be created before the Geovisto map is created.

Parameters​

• initProps: TInitProps

Returns​

this

Inherited from​

ILayerTool.initialize

Source​

model/types/object/IMapObject.ts:53

isEnabled()​

isEnabled(): boolean

Help getter which returns enabled property of state.

Returns​

boolean

Inherited from​

ILayerTool.isEnabled

Source​

model/types/tool/IMapTool.ts:52

isSingleton()​

isSingleton(): boolean

It returns a logical value whether the tool type is singleton.

Returns​

boolean

Inherited from​

ILayerTool.isSingleton

Source​

model/types/tool/IMapTool.ts:37

render()​

render(type, animateOptions?): void

It reloads data and redraw the layer with respect to the type.

By default it works with LayerRedrawType

Parameters​

• type: number

• animateOptions?: IDataChangeAnimateOptions

Returns​

void

Inherited from​

ILayerTool.render

Source​

model/types/layer/ILayerTool.ts:40

setEnabled()​

setEnabled(enabled): void

Some tools might be dynamicaly enabled/disabled. This function is called externally when the tool is enabled/disabled.

Parameters​

• enabled: boolean

Returns​

void

Inherited from​

ILayerTool.setEnabled

Source​

model/types/tool/IMapTool.ts:60

switchEnabled()​

switchEnabled(): void

Help function which switches the enabled state (enabled/disabled).

Returns​

void

Inherited from​

ILayerTool.switchEnabled

Source​

model/types/tool/IMapTool.ts:65

updateDimension()​

updateDimension(dimension, value, renderType): void

It updates the dimension.

Parameters​

• dimension: IMapDimension\<unknown>

• value: string

• renderType: undefined | number

Returns​

void

Inherited from​

ILayerTool.updateDimension

Source​

model/types/layer/ILayerTool.ts:49