Class: GoDensityTool

GoDensityTool

The GoDensityTool class represents a tool for generating density data using various methods such as hexbin, heatmap or isobands.

new GoDensityTool(map, idTool, type, src, layer, field, breaks, hexCase, resize, hexStyleColors)

Interactions/Analysis/interact/DensityTools/index.ts, line 36

Creates an instance of GoDensityTool.

Name Type Description
map GOStagingMap

The map on which the density data is displayed.
idTool string

The ID of the density tool.
type densityToolType

The type of density tool used for generating the data.
src string

The source of the data used for generating the density data.
layer string optional

The layer used to generate the density data.
field string optional

The field used for generating the density data.
breaks Array.<number> optional

The array of break values used for generating the density data.
hexCase module:types~HexConditions optional

Case of hexgrid selected
resize boolean optional

Resize hexgrid. Default: true
hexStyleColors module:types~hexStyleColors optional

Border color hexgrid and border width, Default: color hexgrid and width 0.5
Properties:
Name Type Description
layer GOVectorLayer | GOGeoJsonLayer

Protected - The layer used to generate the density data.
layerFeatures Feature.<Geometry>

Protected - The features used to generate the density data.
map GOStagingMap

Protected - The map on which the density data is displayed.
returnDensityData GoHexgridTool | GoHeatMapTool | GoIsobandsTool

Protected - The tool used to generate the density data.
densityLayer GoHexgridTool | GoHeatMapTool | GoIsobandsTool

The generated density data.
idTool string

The ID of the density tool.
type densityToolType

Protected - The type of density tool used for generating the data.
field string | undefined

Protected - The field used for generating the density data.
src string | null

Protected - The source of the data used for generating the density data.
breaks Array.<number>

The array of break values used for generating the density data.
extent Array.<number>

The extent of the density data.
hexCase module:types~HexConditions

Case of hexgrid selected

Methods

getDenstityLayer(){VectorLayer.<VectorSource>|VectorImageLayer.<VectorSource>}

Interactions/Analysis/interact/DensityTools/index.ts, line 124

Get the density of the layer

Returns:
Type Description
VectorLayer.<VectorSource> | VectorImageLayer.<VectorSource> Return vector layer

heatmapTool(features){module:types~GoHeatMapTool}

Interactions/Analysis/interact/DensityTools/index.ts, line 147

Heatmap density map

Name Type Description
features module:types~Feature.<Geometry>

Description of the condition
Returns:
Type Description
module:types~GoHeatMapTool Return GoHeatMapTool

hexgridTool(features){GoHexgridTool}

Interactions/Analysis/interact/DensityTools/index.ts, line 135

Hexgrid density map

Name Type Description
features module:types~Feature.<Geometry>

Description of the condition
Returns:
Type Description
GoHexgridTool Return DensityData

isobandTool(features){module:types~GoIsobandsTool}

Interactions/Analysis/interact/DensityTools/index.ts, line 169

Isoband density map

Name Type Description
features module:types~Feature.<Geometry>

Input features to new layer
Returns:
Type Description
module:types~GoIsobandsTool Return GoIsobandsTool

isolineTool(){void}

Interactions/Analysis/interact/DensityTools/index.ts, line 158

isoline tool

Throws:

Throws an error if the internal error handling setup fails.

Type
Error
Returns:
Type Description
void
  • This method does not return any value.