3D

Sample 3D layer config json

{
  "id": "layer_1",
  "type": "3D",
  "config": {
    "dataId": "data_1",
    "columns": {
      "lat": "point_lat",
      "lng": "point_lng",
      "altitude": "point_altitude"
    },
    "label": "my 3D layer",
    "isVisible": true,
    "visConfig": {
      "opacity": 0.8,
      "colorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "sizeScale": 10,
      "angleX": 0,
      "angleY": 0,
      "angleZ": 90
    }
  },
  "visualChannels": {
    "colorField": {
      "name": "value",
      "type": "real"
    },
    "colorScale": "quantile",
    "sizeField": null,
    "sizeScale": "linear"
  }
}

Layer Schema Parts

In the following sections we detail the necessary parts of this layer's configuration.

`id`

Layer id, use a string without space

required: true

`type`

This layer's type as a string. Must be "3D".

required: true

`config`

An object detailing this layer's main configuration.

Required properties:

dataId
columns

Property	Type	Description
`columnMode`	`string`	Column Mode, currently only used in the TripLayer
`dataId`	`string`	The id of the dataset from which this layer was created
`columns`	`object`	Name of columns from which this layer was created
`label`	`string`	The displayed layer label
`color`	`array`	Layer color as RGB. e.g. `[255, 0, 0]`.
`isVisible`	`boolean`	Layer visiblity on the map.
`hidden`	`boolean`	Hide layer from the layer panel. This will prevent user from editing the layer.
`textLabel`	`array`
`visConfig`	`object`	Settings for layer styles

`config.columns`

Property	Type
`lat`	`string`
`lng`	`string`
`altitude`	`string \| null`

`config.visConfig`

Property	Type
`opacity`	`number`
`colorRange`	`object`
`sizeScale`	`number`
`angleX`	`number`
`angleY`	`number`
`angleZ`	`number`

`config.visConfig.colorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`visualChannels`

An object detailing this layer's visual channels.

Property	Type
`colorField`	`object \| null`
`colorScale`	`string`
`sizeField`	`object \| null`
`sizeScale`	`string`

`visualChannels.colorScale`

Scale is based on colorField type. Supported scales are:

field type	scale options
string	ordinal
real	quantize, quantile, jenks, custom
timestamp	quantize, quantile, jenks, custom
integer	quantize, quantile, jenks, custom
boolean	ordinal
date	ordinal

`visualChannels.sizeScale`

Scale is based on sizeField type. Supported scales are:

field type	scale options
string	point
real	linear, sqrt, log
timestamp	linear, sqrt, log
integer	linear, sqrt, log
boolean	point
date	point

3D Tile

Sample 3d tile layer config json

{
  "id": "8ia7tpc",
  "type": "tile3d",
  "config": {
    "dataId": "40c72764-9de1-493a-b874-c50556964100",
    "label": "Google 3D Tiles",
    "color": [
      34,
      63,
      154
    ],
    "columns": {},
    "isVisible": true,
    "visConfig": {
      "opacity": 1
    },
    "hidden": false,
    "textLabel": [
      {
        "field": [],
        "color": [
          255,
          255,
          255
        ],
        "size": 18,
        "offset": [
          0,
          0
        ],
        "anchor": "start",
        "alignment": "center",
        "outlineWidth": 0,
        "outlineColor": [
          255,
          0,
          0,
          255
        ],
        "background": false,
        "backgroundColor": [
          0,
          0,
          200,
          255
        ]
      }
    ]
  },
  "visualChannels": {
    "colorField": null,
    "colorScale": "quantile",
    "sizeField": null,
    "sizeScale": "linear"
  }
}

Arc

Sample arc layer config json

{
  "id": "layer_1",
  "type": "arc",
  "config": {
    "dataId": "data_1",
    "columns": {
      "lng0": "point_lng0",
      "lat0": "point_lat0",
      "lng1": "point_lng1",
      "lat1": "point_lat1"
    },
    "label": "my arc layer",
    "isVisible": true,
    "visConfig": {
      "opacity": 0.8,
      "thickness": 2,
      "colorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "sizeRange": [0, 10],
      "targetColor": null
    }
  },
  "visualChannels": {
    "colorField": {
      "name": "value",
      "type": "real"
    },
    "colorScale": "quantile",
    "sizeField": null,
    "sizeScale": "linear"
  }
}

Layer Schema Parts

In the following sections we detail the necessary parts of this layer's configuration.

`id`

Layer id, use a string without space

required: true

`type`

This layer's type as a string. Must be "arc".

required: true

`config`

An object detailing this layer's main configuration.

Required properties:

dataId
columns

Property	Type	Description
`columnMode`	`string`	Column Mode, currently only used in the TripLayer
`dataId`	`string`	The id of the dataset from which this layer was created
`columns`	`object`	Name of columns from which this layer was created
`label`	`string`	The displayed layer label
`color`	`array`	Layer color as RGB. e.g. `[255, 0, 0]`.
`isVisible`	`boolean`	Layer visiblity on the map.
`hidden`	`boolean`	Hide layer from the layer panel. This will prevent user from editing the layer.
`textLabel`	`array`
`visConfig`	`object`	Settings for layer styles

`config.columns`

Property	Type
`lng0`	`string`
`lat0`	`string`
`lng1`	`string`
`lat1`	`string`

`config.visConfig`

Property	Type
`opacity`	`number`
`thickness`	`number`
`colorRange`	`object`
`sizeRange`	`array`
`targetColor`	`array`

`config.visConfig.colorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`visualChannels`

An object detailing this layer's visual channels.

Property	Type
`colorField`	`object \| null`
`colorScale`	`string`
`sizeField`	`object \| null`
`sizeScale`	`string`

`visualChannels.colorScale`

Scale is based on colorField type. Supported scales are:

field type	scale options
string	ordinal
real	quantize, quantile, jenks, custom
timestamp	quantize, quantile, jenks, custom
integer	quantize, quantile, jenks, custom
boolean	ordinal
date	ordinal

`visualChannels.sizeScale`

Scale is based on sizeField type. Supported scales are:

field type	scale options
string	point
real	linear, sqrt, log
timestamp	linear, sqrt, log
integer	linear, sqrt, log
boolean	point
date	point

Cluster

Sample cluster layer config json

{
  "id": "layer_1",
  "type": "cluster",
  "config": {
    "dataId": "data_1",
    "columns": {
      "lat": "point_lat",
      "lng": "point_lng"
    },
    "label": "my cluster layer",
    "isVisible": true,
    "visConfig": {
      "opacity": 0.8,
      "clusterRadius": 40,
      "colorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "radiusRange": [1, 40],
      "colorAggregation": "average"
    }
  },
  "visualChannels": {
    "colorField": {
      "name": "value",
      "type": "real"
    },
    "colorScale": "quantile"
  }
}

Layer Schema Parts

In the following sections we detail the necessary parts of this layer's configuration.

`id`

Layer id, use a string without space

required: true

`type`

This layer's type as a string. Must be "cluster".

required: true

`config`

An object detailing this layer's main configuration.

Required properties:

dataId
columns

Property	Type	Description
`columnMode`	`string`	Column Mode, currently only used in the TripLayer
`dataId`	`string`	The id of the dataset from which this layer was created
`columns`	`object`	Name of columns from which this layer was created
`label`	`string`	The displayed layer label
`color`	`array`	Layer color as RGB. e.g. `[255, 0, 0]`.
`isVisible`	`boolean`	Layer visibility on the map.
`hidden`	`boolean`	Hide layer from the layer panel. This will prevent user from editing the layer.
`textLabel`	`array`
`visConfig`	`object`	Settings for layer styles

`config.columns`

Property	Type
`lat`	`string`
`lng`	`string`

`config.visConfig`

Property	Type
`opacity`	`number`
`clusterRadius`	`number`
`colorRange`	`object`
`radiusRange`	`array`
`colorAggregation`	`string`

`config.visConfig.colorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`visualChannels`

An object detailing this layer's visual channels.

Property	Type
`colorField`	`object \| null`
`colorScale`	`string`

`visualChannels.colorScale`

Scale is based on colorField type and undefined type. Supported scales are:

field type	aggregation type	scale options
string	mode	ordinal
string	count unique	quantize, quantile
real	average	quantize, quantile
real	maximum	quantize, quantile
real	minimum	quantize, quantile
real	median	quantize, quantile
real	stdev	quantize, quantile
real	sum	quantize, quantile
real	variance	quantize, quantile
integer	average	quantize, quantile
integer	maximum	quantize, quantile
integer	minimum	quantize, quantile
integer	median	quantize, quantile
integer	stdev	quantize, quantile
integer	sum	quantize, quantile
integer	variance	quantize, quantile
boolean	mode	ordinal
boolean	count unique	quantize, quantile
date	mode	ordinal
date	count unique	quantize, quantile

Flow

Create a Flow Layer programmatically by following the JSON format specifications on this page.

Sample Flow Layer Config json

{
  "id": "layer_1",
  "type": "flow",
  "config": {
    "dataId": "data_1",
    "label": "Chi. Rideshare O-D Movement",
    "color": [255, 153, 31],
    "columns": {
      "lat0": "pickup_centroid_latitude",
      "lng0": "pickup_centroid_longitude",
      "lat1": "dropoff_centroid_latitude",
      "lng1": "dropoff_centroid_longitude",
      "count": "total_trips",
      "sourceName": "pickup_centroid_location",
      "targetName": "dropoff_centroid_location"
    },
    "isVisible": true,
    "visConfig": {
      "colorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "colors": [
          "#4C0035",
          "#880030",
          "#B72F15",
          "#D6610A",
          "#EF9100",
          "#FFC300"
        ],
        "category": "Uber",
        "reveresed": "true"
      },
      "opacity": 1,
      "flowAnimationEnabled": false,
      "flowAdaptiveScalesEnabled": true,
      "flowFadeEnabled": true,
      "flowFadeAmount": 49,
      "maxTopFlowsDisplayNum": 5435,
      "flowLocationTotalsEnabled": true,
      "flowClusteringEnabled": false,
      "darkBaseMapEnabled": true
    },
    "hidden": false
  }
}

Layer Schema Parts

`id`

Type: string
Required: Yes

The id for the flow layer. Must be a string containing no spaces.

`type`

Type: string
Required: Yes

This layer's type as a string. Must be be "flow" to generate a flow layer.

`config`

Type: object
Required: Yes

An object detailing the Flow Layer configuration.

Child attributes of `config`:

Property	Type	Required	Description
`dataId`	`string`	Yes	The id of the dataset from which this layer was created.
`label`	`string`	No	The displayed layer label.
`color`	`int array`	No	The layer's color as an RGB value. For example: `[255, 0, 0]`.
`columns`	`object`	Yes	A list of columns used to create the layer.
`isVisible`	`boolean`	No	Enable/Disables the layer's visibility on the map.
`visConfig`	`object`	No	Layer visualization settings.
`hidden`	`boolean`	No	Enable/Disables visibility of layer in the layer panel, preventing user edit.

`config.columns`

Property	Type	Required	Description
`lng0`	`string`	Yes	A column containing source/origin longitude.
`lat0`	`string`	Yes	A column containing source/origin latitude.
`lng1`	`string`	Yes	A column containing target/destination longitude.
`lat1`	`string`	Yes	A column containing target/destination latitude.
`count`	`string`	No	A column containing the count of trips between source/target pairs. If not defined, each row containing a source/target pair is counted as one trip.
`sourceName`	`string`	No	A column containing the names for sources. If not defined, the latitude and longitude of source points are used as names.
`targetName`	`string`	No	A column containing the names for targets. If not defined, the latitude and longitude of target points are used as names.

`config.visConfig`

Property	Type	Required	Description
`colorRange`	`object`	No	The color range for the layer.
`opacity`	`int`	No	The opacity of the layer on the map.
`flowAnimationEnabled`	`boolean`	No	Enables/Disables animation of the flows. Use `true` to animate flows.
`flowAdaptiveScalesEnabled`	`boolean`	No	Enables/Disables scaling of flow thickness based on flows inside the current viewport.
`flowFadeEnabled`	`boolean`	No	Enables/Disables fading of flows with smaller counts.
`flowFadeAmount`	`int`	No	The amount flows are faded. Increase to fade flows with smaller counts.
`maxTopFlowsDisplayNum`	`int`	No	The max number of flows to displayed on the map.
`flowLocationTotalsEnabled`	`boolean`	No	Enables/Disables flow location totals, circles with size based on the number of flows in and out of the location.
`flowClusteringEnabled`	`boolean`	No	Enables/Disables flow clustering. Flow clustering groups neighboring source/target points.
`darkBaseMapEnabled`	`boolean`	No	Enables/Disables dark base map mode. When enabled, flows on dark base maps are optimized.

`config.visConfig.colorRange`

Property	Type	Required	Description
`name`	`string`	No	The name of the color range. For example, `global warming`.
`type`	`string`	No	The color range's type. For example, `sequential`.
`colors`	`string array`	No	An array of hex strings containing colors used for the color range.
`category`	`string`	No	The category of the color range. For example, `uber`.
`reversed`	`boolean`	No	Enable/Disables reversing of the color range.

Geojson (Polygon)

Sample geojson layer config json

{
  "id": "layer_1",
  "type": "geojson",
  "config": {
    "dataId": "data_1",
    "columns": {
      "geojson": "point_geojson"
    },
    "label": "my geojson layer",
    "isVisible": true,
    "visConfig": {
      "opacity": 0.8,
      "strokeOpacity": 0.8,
      "thickness": 0.5,
      "strokeColor": null,
      "colorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "strokeColorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "radius": 10,
      "sizeRange": [0, 10],
      "radiusRange": [0, 50],
      "heightRange": [0, 500],
      "elevationScale": 5,
      "stroked": true,
      "filled": false,
      "enable3d": false,
      "wireframe": false,
      "fixedHeight": false
    }
  },
  "visualChannels": {
    "colorField": {
      "name": "value",
      "type": "real"
    },
    "colorScale": "quantile",
    "strokeColorField": {
      "name": "value",
      "type": "real"
    },
    "strokeColorScale": "quantile",
    "sizeField": null,
    "sizeScale": "linear",
    "heightField": null,
    "heightScale": "linear",
    "radiusField": null,
    "radiusScale": "linear"
  }
}

Layer Schema Parts

In the following sections we detail the necessary parts of this layer's configuration.

`id`

Layer id, use a string without space

required: true

`type`

This layer's type as a string. Must be "geojson".

required: true

`config`

An object detailing this layer's main configuration.

Required properties:

dataId
columns

Property	Type	Description
`columnMode`	`string`	Column Mode, currently only used in the TripLayer
`dataId`	`string`	The id of the dataset from which this layer was created
`columns`	`object`	Name of columns from which this layer was created
`label`	`string`	The displayed layer label
`color`	`array`	Layer color as RGB. e.g. `[255, 0, 0]`.
`isVisible`	`boolean`	Layer visibility on the map.
`hidden`	`boolean`	Hide layer from the layer panel. This will prevent user from editing the layer.
`textLabel`	`array`
`visConfig`	`object`	Settings for layer styles

`config.columns`

Property	Type
`geojson`	`string`

`config.visConfig`

Property	Type
`opacity`	`number`
`strokeOpacity`	`number`
`thickness`	`number`
`strokeColor`	`array \| null`
`colorRange`	`object`
`strokeColorRange`	`object`
`radius`	`number`
`sizeRange`	`array`
`radiusRange`	`array`
`heightRange`	`array`
`elevationScale`	`number`
`stroked`	`boolean`
`filled`	`boolean`
`enable3d`	`boolean`
`wireframe`	`boolean`
`fixedHeight`	`boolean`

`config.visConfig.colorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`config.visConfig.strokeColorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`visualChannels`

An object detailing this layer's visual channels.

Property	Type
`colorField`	`object \| null`
`colorScale`	`string`
`strokeColorField`	`object \| null`
`strokeColorScale`	`string`
`sizeField`	`object \| null`
`sizeScale`	`string`
`heightField`	`object \| null`
`heightScale`	`string`
`radiusField`	`object \| null`
`radiusScale`	`string`

`visualChannels.colorScale`

Scale is based on colorField type. Supported scales are:

field type	scale options
string	ordinal
real	quantize, quantile, jenks, custom
timestamp	quantize, quantile, jenks, custom
integer	quantize, quantile, jenks, custom
boolean	ordinal
date	ordinal

`visualChannels.strokeColorScale`

Scale is based on strokeColorField type. Supported scales are:

field type	scale options
string	ordinal
real	quantize, quantile, jenks, custom
timestamp	quantize, quantile, jenks, custom
integer	quantize, quantile, jenks, custom
boolean	ordinal
date	ordinal

`visualChannels.sizeScale`

Scale is based on sizeField type. Supported scales are:

field type	scale options
string	point
real	linear, sqrt, log
timestamp	linear, sqrt, log
integer	linear, sqrt, log
boolean	point
date	point

`visualChannels.heightScale`

Scale is based on heightField type. Supported scales are:

field type	scale options
string	point
real	linear, sqrt, log
timestamp	linear, sqrt, log
integer	linear, sqrt, log
boolean	point
date	point

`visualChannels.radiusScale`

Scale is based on radiusField type. Supported scales are:

field type	scale options
string	point
real	sqrt
timestamp	sqrt
integer	sqrt
boolean	point
date	point

Grid

Sample grid layer config json

{
  "id": "layer_1",
  "type": "grid",
  "config": {
    "dataId": "data_1",
    "columns": {
      "lat": "point_lat",
      "lng": "point_lng"
    },
    "label": "my grid layer",
    "isVisible": true,
    "visConfig": {
      "opacity": 0.8,
      "worldUnitSize": 1,
      "colorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "coverage": 1,
      "sizeRange": [0, 500],
      "percentile": [0, 100],
      "elevationPercentile": [0, 100],
      "elevationScale": 5,
      "enableElevationZoomFactor": true,
      "colorAggregation": "average",
      "sizeAggregation": "average",
      "enable3d": false
    }
  },
  "visualChannels": {
    "colorField": {
      "name": "value",
      "type": "real"
    },
    "colorScale": "quantile",
    "sizeField": null,
    "sizeScale": "linear"
  }
}

Layer Schema Parts

In the following sections we detail the necessary parts of this layer's configuration.

`id`

Layer id, use a string without space

required: true

`type`

This layer's type as a string. Must be "grid".

required: true

`config`

An object detailing this layer's main configuration.

Required properties:

dataId
columns

Property	Type	Description
`columnMode`	`string`	Column Mode, currently only used in the TripLayer
`dataId`	`string`	The id of the dataset from which this layer was created
`columns`	`object`	Name of columns from which this layer was created
`label`	`string`	The displayed layer label
`color`	`array`	Layer color as RGB. e.g. `[255, 0, 0]`.
`isVisible`	`boolean`	Layer visiblity on the map.
`hidden`	`boolean`	Hide layer from the layer panel. This will prevent user from editing the layer.
`textLabel`	`array`
`visConfig`	`object`	Settings for layer styles

`config.columns`

Property	Type
`lat`	`string`
`lng`	`string`

`config.visConfig`

Property	Type
`opacity`	`number`
`worldUnitSize`	`number`
`colorRange`	`object`
`coverage`	`number`
`sizeRange`	`array`
`percentile`	`array`
`elevationPercentile`	`array`
`elevationScale`	`number`
`enableElevationZoomFactor`	`boolean`
`colorAggregation`	`string`
`sizeAggregation`	`string`
`enable3d`	`boolean`

`config.visConfig.colorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`visualChannels`

An object detailing this layer's visual channels.

Property	Type
`colorField`	`object \| null`
`colorScale`	`string`
`sizeField`	`object \| null`
`sizeScale`	`string`

`visualChannels.colorScale`

Scale is based on colorField type and undefined type. Supported scales are:

field type	aggregation type	scale options
string	mode	ordinal
string	count unique	quantize, quantile
real	average	quantize, quantile
real	maximum	quantize, quantile
real	minimum	quantize, quantile
real	median	quantize, quantile
real	stdev	quantize, quantile
real	sum	quantize, quantile
real	variance	quantize, quantile
integer	average	quantize, quantile
integer	maximum	quantize, quantile
integer	minimum	quantize, quantile
integer	median	quantize, quantile
integer	stdev	quantize, quantile
integer	sum	quantize, quantile
integer	variance	quantize, quantile
boolean	mode	ordinal
boolean	count unique	quantize, quantile
date	mode	ordinal
date	count unique	quantize, quantile

`visualChannels.sizeScale`

Scale is based on sizeField type and undefined type. Supported scales are:

field type	aggregation type	scale options
real	average	linear, sqrt, log
real	maximum	linear, sqrt, log
real	minimum	linear, sqrt, log
real	median	linear, sqrt, log
real	stdev	linear, sqrt, log
real	sum	linear, sqrt, log
real	variance	linear, sqrt, log
integer	average	linear, sqrt, log
integer	maximum	linear, sqrt, log
integer	minimum	linear, sqrt, log
integer	median	linear, sqrt, log
integer	stdev	linear, sqrt, log
integer	sum	linear, sqrt, log
integer	variance	linear, sqrt, log

H3

Sample hexagonId layer config json

{
  "id": "layer_1",
  "type": "hexagonId",
  "config": {
    "dataId": "data_1",
    "columns": {
      "hex_id": "point_hex_id"
    },
    "label": "my hexagonId layer",
    "isVisible": true,
    "visConfig": {
      "opacity": 0.8,
      "colorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "coverage": 1,
      "enable3d": false,
      "sizeRange": [0, 500],
      "coverageRange": [0, 1],
      "elevationScale": 5,
      "enableElevationZoomFactor": true
    }
  },
  "visualChannels": {
    "colorField": {
      "name": "value",
      "type": "real"
    },
    "colorScale": "quantile",
    "sizeField": null,
    "sizeScale": "linear",
    "coverageField": null,
    "coverageScale": "linear"
  }
}

Layer Schema Parts

In the following sections we detail the necessary parts of this layer's configuration.

`id`

Layer id, use a string without space

required: true

`type`

This layer's type as a string. Must be "hexagonId".

required: true

`config`

An object detailing this layer's main configuration.

Required properties:

dataId
columns

Property	Type	Description
`columnMode`	`string`	Column Mode, currently only used in the TripLayer
`dataId`	`string`	The id of the dataset from which this layer was created
`columns`	`object`	Name of columns from which this layer was created
`label`	`string`	The displayed layer label
`color`	`array`	Layer color as RGB. e.g. `[255, 0, 0]`.
`isVisible`	`boolean`	Layer visibility on the map.
`hidden`	`boolean`	Hide layer from the layer panel. This will prevent user from editing the layer.
`textLabel`	`array`
`visConfig`	`object`	Settings for layer styles

`config.columns`

Property	Type
`hex_id`	`string`

`config.visConfig`

Property	Type
`opacity`	`number`
`colorRange`	`object`
`coverage`	`number`
`enable3d`	`boolean`
`sizeRange`	`array`
`coverageRange`	`array`
`elevationScale`	`number`
`enableElevationZoomFactor`	`boolean`

`config.visConfig.colorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`visualChannels`

An object detailing this layer's visual channels.

Property	Type
`colorField`	`object \| null`
`colorScale`	`string`
`sizeField`	`object \| null`
`sizeScale`	`string`
`coverageField`	`object \| null`
`coverageScale`	`string`

`visualChannels.colorScale`

Scale is based on colorField type. Supported scales are:

field type	scale options
string	ordinal
real	quantize, quantile, jenks, custom
timestamp	quantize, quantile, jenks, custom
integer	quantize, quantile, jenks, custom
boolean	ordinal
date	ordinal

`visualChannels.sizeScale`

Scale is based on sizeField type. Supported scales are:

field type	scale options
string	point
real	linear, sqrt, log
timestamp	linear, sqrt, log
integer	linear, sqrt, log
boolean	point
date	point

`visualChannels.coverageScale`

Scale is based on coverageField type. Supported scales are:

field type	scale options
string	point
real	sqrt
timestamp	sqrt
integer	sqrt
boolean	point
date	point

Heatmap

Sample heatmap layer config json

{
  "id": "layer_1",
  "type": "heatmap",
  "config": {
    "dataId": "data_1",
    "columns": {
      "lat": "point_lat",
      "lng": "point_lng"
    },
    "label": "my heatmap layer",
    "isVisible": true,
    "visConfig": {
      "opacity": 0.8,
      "colorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "radius": 20
    }
  },
  "visualChannels": {
    "weightField": null,
    "weightScale": "linear"
  }
}

Layer Schema Parts

In the following sections we detail the necessary parts of this layer's configuration.

`id`

Layer id, use a string without space

required: true

`type`

This layer's type as a string. Must be "heatmap".

required: true

`config`

An object detailing this layer's main configuration.

Required properties:

dataId
columns

Property	Type	Description
`columnMode`	`string`	Column Mode, currently only used in the TripLayer
`dataId`	`string`	The id of the dataset from which this layer was created
`columns`	`object`	Name of columns from which this layer was created
`label`	`string`	The displayed layer label
`color`	`array`	Layer color as RGB. e.g. `[255, 0, 0]`.
`isVisible`	`boolean`	Layer visibility on the map.
`hidden`	`boolean`	Hide layer from the layer panel. This will prevent user from editing the layer.
`textLabel`	`array`
`visConfig`	`object`	Settings for layer styles

`config.columns`

Property	Type
`lat`	`string`
`lng`	`string`

`config.visConfig`

Property	Type
`opacity`	`number`
`colorRange`	`object`
`radius`	`number`

`config.visConfig.colorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`visualChannels`

An object detailing this layer's visual channels.

Property	Type
`weightField`	`object \| null`
`weightScale`	`string`

`visualChannels.weightScale`

Scale is based on weightField type and undefined type. Supported scales are:

field type	aggregation type	scale options
string	point
real	linear, sqrt, log
timestamp	linear, sqrt, log
integer	linear, sqrt, log
boolean	point
date	point

Hexagon

Sample hexagon layer config json

{
  "id": "layer_1",
  "type": "hexagon",
  "config": {
    "dataId": "data_1",
    "columns": {
      "lat": "point_lat",
      "lng": "point_lng"
    },
    "label": "my hexagon layer",
    "isVisible": true,
    "visConfig": {
      "opacity": 0.8,
      "worldUnitSize": 1,
      "resolution": 8,
      "colorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "coverage": 1,
      "sizeRange": [0, 500],
      "percentile": [0, 100],
      "elevationPercentile": [0, 100],
      "elevationScale": 5,
      "enableElevationZoomFactor": true,
      "colorAggregation": "average",
      "sizeAggregation": "average",
      "enable3d": false
    }
  },
  "visualChannels": {
    "colorField": {
      "name": "value",
      "type": "real"
    },
    "colorScale": "quantile",
    "sizeField": null,
    "sizeScale": "linear"
  }
}

Layer Schema Parts

In the following sections we detail the necessary parts of this layer's configuration.

`id`

Layer id, use a string without space

required: true

`type`

This layer's type as a string. Must be "hexagon".

required: true

`config`

An object detailing this layer's main configuration.

Required properties:

dataId
columns

Property	Type	Description
`columnMode`	`string`	Column Mode, currently only used in the TripLayer
`dataId`	`string`	The id of the dataset from which this layer was created
`columns`	`object`	Name of columns from which this layer was created
`label`	`string`	The displayed layer label
`color`	`array`	Layer color as RGB. e.g. `[255, 0, 0]`.
`isVisible`	`boolean`	Layer visibility on the map.
`hidden`	`boolean`	Hide layer from the layer panel. This will prevent user from editing the layer.
`textLabel`	`array`
`visConfig`	`object`	Settings for layer styles

`config.columns`

Property	Type
`lat`	`string`
`lng`	`string`

`config.visConfig`

Property	Type
`opacity`	`number`
`worldUnitSize`	`number`
`resolution`	`number`
`colorRange`	`object`
`coverage`	`number`
`sizeRange`	`array`
`percentile`	`array`
`elevationPercentile`	`array`
`elevationScale`	`number`
`enableElevationZoomFactor`	`boolean`
`colorAggregation`	`string`
`sizeAggregation`	`string`
`enable3d`	`boolean`

`config.visConfig.colorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`visualChannels`

An object detailing this layer's visual channels.

Property	Type
`colorField`	`object \| null`
`colorScale`	`string`
`sizeField`	`object \| null`
`sizeScale`	`string`

`visualChannels.colorScale`

Scale is based on colorField type and undefined type. Supported scales are:

field type	aggregation type	scale options
string	mode	ordinal
string	count unique	quantize, quantile
real	average	quantize, quantile
real	maximum	quantize, quantile
real	minimum	quantize, quantile
real	median	quantize, quantile
real	stdev	quantize, quantile
real	sum	quantize, quantile
real	variance	quantize, quantile
integer	average	quantize, quantile
integer	maximum	quantize, quantile
integer	minimum	quantize, quantile
integer	median	quantize, quantile
integer	stdev	quantize, quantile
integer	sum	quantize, quantile
integer	variance	quantize, quantile
boolean	mode	ordinal
boolean	count unique	quantize, quantile
date	mode	ordinal
date	count unique	quantize, quantile

`visualChannels.sizeScale`

Scale is based on sizeField type and undefined type. Supported scales are:

field type	aggregation type	scale options
real	average	linear, sqrt, log
real	maximum	linear, sqrt, log
real	minimum	linear, sqrt, log
real	median	linear, sqrt, log
real	stdev	linear, sqrt, log
real	sum	linear, sqrt, log
real	variance	linear, sqrt, log
integer	average	linear, sqrt, log
integer	maximum	linear, sqrt, log
integer	minimum	linear, sqrt, log
integer	median	linear, sqrt, log
integer	stdev	linear, sqrt, log
integer	sum	linear, sqrt, log
integer	variance	linear, sqrt, log

Hex Tile

Sample Config

{
  "id": "rksdbx",
  "type": "hexTile",
  "config": {
    "dataId": "29a455af-26db-42f9-9d75-f918270d38de",
    "label": "sum_Forest",
    "color": [179, 173, 158],
    "columns": {},
    "isVisible": true,
    "visConfig": {
      "tileUrl": "",
      "strokeColor": null,
      "strokeOpacity": 0.8,
      "radius": 0.1,
      "enable3d": true,
      "transition": false,
      "heightRange": [0, 500],
      "elevationScale": 5,
      "opacity": 0.8,
      "colorRange": {
        "name": "YlGn",
        "type": "sequential",
        "colors": [
          "#FFFFE5",
          "#F8FCC6",
          "#E9F6B0",
          "#D0EC9F",
          "#B0DE90",
          "#8BCE80",
          "#64BC6F",
          "#41A65B",
          "#288C49",
          "#11753D",
          "#025E33",
          "#004529"
        ],
        "category": "ColorBrewer"
      },
      "radiusByZoom": {
        "enabled": false,
        "stops": null
      },
      "tileQuery": "",
      "showOutlines": false,
      "showPoints": false,
      "dynamicColor": false,
      "cellPerTileThreshold": 2,
      "usePercentileRange": false,
      "percentileRange": [0, 99]
    },
    "hidden": false,
    "textLabel": [
      {
        "field": [],
        "color": [255, 255, 255],
        "size": 18,
        "offset": [0, 0],
        "anchor": "start",
        "alignment": "center"
      }
    ]
  },
  "visualChannels": {
    "colorField": {
      "name": "sum_Forest",
      "type": "real"
    },
    "colorScale": "quantile",
    "heightField": {
      "name": "sum_Forest",
      "type": "real"
    },
    "heightScale": "linear"
  }
}

Icon

Sample icon layer config json

{
  "id": "layer_1",
  "type": "icon",
  "config": {
    "dataId": "data_1",
    "columns": {
      "lat": "point_lat",
      "lng": "point_lng",
      "icon": "point_icon",
      "altitude": "point_altitude"
    },
    "label": "my icon layer",
    "isVisible": true,
    "visConfig": {
      "radius": 10,
      "fixedRadius": false,
      "opacity": 0.8,
      "colorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "radiusRange": [0, 50],
      "billboard": false
    }
  },
  "visualChannels": {
    "colorField": {
      "name": "value",
      "type": "real"
    },
    "colorScale": "quantile",
    "sizeField": null,
    "sizeScale": "linear"
  }
}

Layer Schema Parts

In the following sections we detail the necessary parts of this layer's configuration.

`id`

Layer id, use a string without space

required: true

`type`

This layer's type as a string. Must be "icon".

required: true

`config`

An object detailing this layer's main configuration.

Required properties:

dataId
columns

Property	Type	Description
`columnMode`	`string`	Column Mode, currently only used in the TripLayer
`dataId`	`string`	The id of the dataset from which this layer was created
`columns`	`object`	Name of columns from which this layer was created
`label`	`string`	The displayed layer label
`color`	`array`	Layer color as RGB. e.g. `[255, 0, 0]`.
`isVisible`	`boolean`	Layer visiblity on the map.
`hidden`	`boolean`	Hide layer from the layer panel. This will prevent user from editing the layer.
`textLabel`	`array`
`visConfig`	`object`	Settings for layer styles

`config.columns`

Property	Type
`lat`	`string`
`lng`	`string`
`icon`	`string`
`altitude`	`string \| null`

`config.visConfig`

Property	Type
`radius`	`number`
`fixedRadius`	`boolean`
`opacity`	`number`
`colorRange`	`object`
`radiusRange`	`array`
`billboard`	`boolean`

`config.visConfig.colorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`visualChannels`

An object detailing this layer's visual channels.

Property	Type
`colorField`	`object \| null`
`colorScale`	`string`
`sizeField`	`object \| null`
`sizeScale`	`string`

`visualChannels.colorScale`

Scale is based on colorField type. Supported scales are:

field type	scale options
string	ordinal
real	quantize, quantile, jenks, custom
timestamp	quantize, quantile, jenks, custom
integer	quantize, quantile, jenks, custom
boolean	ordinal
date	ordinal

`visualChannels.sizeScale`

Scale is based on sizeField type. Supported scales are:

field type	scale options
string	point
real	sqrt
timestamp	sqrt
integer	sqrt
boolean	point
date	point

Line

Sample line layer config json

{
  "id": "layer_1",
  "type": "line",
  "config": {
    "dataId": "data_1",
    "columns": {
      "lat0": "point_lat0",
      "lng0": "point_lng0",
      "lat1": "point_lat1",
      "lng1": "point_lng1",
      "alt0": "point_alt0",
      "alt1": "point_alt1"
    },
    "label": "my line layer",
    "isVisible": true,
    "visConfig": {
      "opacity": 0.8,
      "thickness": 2,
      "colorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "sizeRange": [0, 10],
      "targetColor": null,
      "elevationScale": 1
    }
  },
  "visualChannels": {
    "colorField": {
      "name": "value",
      "type": "real"
    },
    "colorScale": "quantile",
    "sizeField": null,
    "sizeScale": "linear"
  }
}

Layer Schema Parts

In the following sections we detail the necessary parts of this layer's configuration.

`id`

Layer id, use a string without space

required: true

`type`

This layer's type as a string. Must be "line".

required: true

`config`

An object detailing this layer's main configuration.

Required properties:

dataId
columns

Property	Type	Description
`columnMode`	`string`	Column Mode, currently only used in the TripLayer
`dataId`	`string`	The id of the dataset from which this layer was created
`columns`	`object`	Name of columns from which this layer was created
`label`	`string`	The displayed layer label
`color`	`array`	Layer color as RGB. e.g. `[255, 0, 0]`.
`isVisible`	`boolean`	Layer visiblity on the map.
`hidden`	`boolean`	Hide layer from the layer panel. This will prevent user from editing the layer.
`textLabel`	`array`
`visConfig`	`object`	Settings for layer styles

`config.columns`

Property	Type
`lat0`	`string`
`lng0`	`string`
`lat1`	`string`
`lng1`	`string`
`alt0`	`string`
`alt1`	`string`

`config.visConfig`

Property	Type
`opacity`	`number`
`thickness`	`number`
`colorRange`	`object`
`sizeRange`	`array`
`targetColor`	`array`
`elevationScale`	`number`

`config.visConfig.colorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`visualChannels`

An object detailing this layer's visual channels.

Property	Type
`colorField`	`object \| null`
`colorScale`	`string`
`sizeField`	`object \| null`
`sizeScale`	`string`

`visualChannels.colorScale`

Scale is based on colorField type. Supported scales are:

field type	scale options
string	ordinal
real	quantize, quantile, jenks, custom
timestamp	quantize, quantile, jenks, custom
integer	quantize, quantile, jenks, custom
boolean	ordinal
date	ordinal

`visualChannels.sizeScale`

Scale is based on sizeField type. Supported scales are:

field type	scale options
string	point
real	linear, sqrt, log
timestamp	linear, sqrt, log
integer	linear, sqrt, log
boolean	point
date	point

Point

Sample point layer config json

{
  "id": "layer_1",
  "type": "point",
  "config": {
    "dataId": "data_1",
    "columns": {
      "lat": "point_lat",
      "lng": "point_lng",
      "altitude": "point_altitude"
    },
    "label": "my point layer",
    "isVisible": true,
    "visConfig": {
      "radius": 10,
      "fixedRadius": false,
      "opacity": 0.8,
      "outline": false,
      "thickness": 2,
      "strokeColor": null,
      "colorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "strokeColorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "radiusRange": [0, 50],
      "filled": true,
      "billboard": false
    }
  },
  "visualChannels": {
    "colorField": {
      "name": "value",
      "type": "real"
    },
    "colorScale": "quantile",
    "strokeColorField": {
      "name": "value",
      "type": "real"
    },
    "strokeColorScale": "quantile",
    "sizeField": null,
    "sizeScale": "linear"
  }
}

Layer Schema Parts

In the following sections we detail the necessary parts of this layer's configuration.

`id`

Layer id, use a string without space

required: true

`type`

This layer's type as a string. Must be "point".

required: true

`config`

An object detailing this layer's main configuration.

Required properties:

dataId
columns

Property	Type	Description
`columnMode`	`string`	Column Mode, currently only used in the TripLayer
`dataId`	`string`	The id of the dataset from which this layer was created
`columns`	`object`	Name of columns from which this layer was created
`label`	`string`	The displayed layer label
`color`	`array`	Layer color as RGB. e.g. `[255, 0, 0]`.
`isVisible`	`boolean`	Layer visiblity on the map.
`hidden`	`boolean`	Hide layer from the layer panel. This will prevent user from editing the layer.
`textLabel`	`array`
`visConfig`	`object`	Settings for layer styles

`config.columns`

Property	Type
`lat`	`string`
`lng`	`string`
`altitude`	`string \| null`

`config.visConfig`

Property	Type
`radius`	`number`
`fixedRadius`	`boolean`
`opacity`	`number`
`outline`	`boolean`
`thickness`	`number`
`strokeColor`	`array \| null`
`colorRange`	`object`
`strokeColorRange`	`object`
`radiusRange`	`array`
`filled`	`boolean`
`billboard`	`boolean`

`config.visConfig.colorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`config.visConfig.strokeColorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`visualChannels`

An object detailing this layer's visual channels.

Property	Type
`colorField`	`object \| null`
`colorScale`	`string`
`strokeColorField`	`object \| null`
`strokeColorScale`	`string`
`sizeField`	`object \| null`
`sizeScale`	`string`

`visualChannels.colorScale`

Scale is based on colorField type. Supported scales are:

field type	scale options
string	ordinal
real	quantize, quantile, jenks, custom
timestamp	quantize, quantile, jenks, custom
integer	quantize, quantile, jenks, custom
boolean	ordinal
date	ordinal

`visualChannels.strokeColorScale`

Scale is based on strokeColorField type. Supported scales are:

field type	scale options
string	ordinal
real	quantize, quantile, jenks, custom
timestamp	quantize, quantile, jenks, custom
integer	quantize, quantile, jenks, custom
boolean	ordinal
date	ordinal

`visualChannels.sizeScale`

Scale is based on sizeField type. Supported scales are:

field type	scale options
string	point
real	sqrt
timestamp	sqrt
integer	sqrt
boolean	point
date	point

Raster Tile

Sample

{
  "id": "layer_1",
  "type": "rasterTile",
  "config": {
    "dataId": "data_1",
    "columns": {},
    "label": "my rasterTile layer",
    "isVisible": true,
    "visConfig": {
      "preset": "trueColor",
      "mosaicId": null,
      "useSTACSearching": false,
      "stacSearchProvider": "earth-search",
      "startDate": "2019-02-02",
      "endDate": "2019-03-02",
      "colormapId": "cfastie",
      "colorRange": {
        "name": "Categorical",
        "type": "categorical",
        "category": "custom",
        "colors": [],
        "colorMap": [
          [4, "#00FF00"], // Vegetation
          [11, "#FFFFFF"], // Snow_ice
          [8, "#AAAAAA"], //
          [9, "#AAAAAA"],
          [10, "#AAAAAA"],
          [6, "#0000FF"]
        ],
        "colorLegends": {
          "#00FF00": "Vegetation",
          "#FFFFFF": "Snow_ice",
          "#0000FF": "Water",
          "#AAAAAA": "Clouds"
        }
      },
      "linearRescalingFactor": [0, 1],
      "nonLinearRescaling": true,
      "gammaContrastFactor": 1,
      "sigmoidalContrastFactor": 0,
      "sigmoidalBiasFactor": 0.5,
      "saturationValue": 1,
      "filterEnabled": false,
      "filterRange": [-1, 1],
      "opacity": 1
    }
  },
  "visualChannels": {}
}

Layer Schema Parts

In the following sections we detail the necessary parts of this layer's configuration.

Property	Type	Description
`id`	`string`	Required. The layer's identification string. Must not contain spaces.
`type`	`string`	Required. The layer's type as a string. Must be `"rasterTile`".
`config`	`object`	Required. An object detailing this layer's main configuration.
`config.dataId`	`string`	Required. The id of the dataset used by this layer.
`config.columns`	`object`	Name of columns from which this layer was created. Empty for raster layer.
`config.label`	`string`	Name of the user-facing label displayed in the sidebar.
`config.isVisible`	`boolean`	Layer visibility on the map. When `true`, display label on the map.
`config.hidden`	`boolean`	Hide layer visibility from the layer panel. When `true`, prevent the user from editing the layer.
`config.visConfig`	`object`	Settings for layer styles. Contains crucial raster configuration fields.
`config.visConfig.preset`	`string`	A preset band combination to use for the raster layer. Options available depend on the bands available in the dataset.
`config.visConfig.mosaicId`	`string`	An ID mapping to a valid raster mosaic to use. A raster mosaic is a combination of images formed into a single raster image set. If no mosaic is present in a given dataset, this field should be `null`.
`config.visConfig.useSTACSearching`	`bool`	Whether or not to use STAC searching, which, if available, allows users to query raster imagery from a given date range.
`config.visConfig.stacSearchProvider`	`string`	The name of the STAC searching provider to use, if available.
`config.visConfig.startDate`	`string`	The start date range for STAC searching.
`config.visConfig.endDate`	`string`	The end date range for STAC searching.
`config.visConfig.dynamicColor`	`bool`	Whether to use dynamic color scale optimized for raster tiles within the viewport. For example, when viewing a "bright" spot on earth (such as ice caps or sandy deserts), the color scale will automatically adjust to best display Earth's features.
`config.visConfig.colormapId`	`string`	The ID for the color mapping to use. Supports all default rio-tiler colormaps as a one-word, lowercase string with underscores for spaces.
`config.visConfig.colorRange`	`color-range-select`	In Raster Tile this property can be used to set custom color map for categorical data representation (see `config.visConfig.colorRange.colorMap`).
`config.visConfig.colorRange.colorMap`	`array`	Array of couples `[value, color]`, where `value` is categorical image pixel value, `color` is color in hex string format.
`config.visConfig.colorRange.colorLegends`	`object`	Colors from `config.visConfig.colorRange.colorMap` mapped to strings to be displayed in the legend. See the example above.
`config.visConfig.linearRescalingFactor`	`array`	An array containing values assigning to mapped colors. Defaults to `[0,1]`. The leftmost color will be mapped to `0`, and the rightmost color mapped to `1`. Only available when `nonLinearRescaling` is disabled.
`config.visConfig.nonLinearRescaling`	`bool`	Whether to use non-linear color map rescaling. When enabled, the below gamma and sigmoidal options can be customized. Only available on certain band combinations, such as `true_color` or `infrared` presets.
`config.visConfig.gammaContrastFactor`	`number`	The factor by which gamma is applied to the dataset. Gamma affects the degree of light applied to the dataset, changing how bright the landscape appears.
`config.visConfig.sigmoidalContrastFactor`	`number`	A factor by which to apply sigmoidal contrast. Sigmoidal contrast is a type of contrast control that adjusts the contrast without saturating highlights or shadows. Effectively enhances the intensity differences between the lighter and darker elements of the image. For example, 0 is none, 3 is typical and 20 is a lot.
`config.visConfig.sigmoidalBiasFactor`	`number`	A factor controlling the level for the contrast function to center on. Must be a `float` between `0` and `1`. Typically centered at 0.5
`config.visConfig.saturationValue`	`number`	Adjust the saturation of colors on the map. `0` is black and white, while `2` doubles the intensity of color values. )
`config.visConfig.filterEnabled`	`bool`	Whether or not to apply a filter to the map. When enabled, only displayed data in a given range.
`config.visConfig.filterRange`	`array`	The range by which to display raster data. All values falling outside the range are hidden from the map.
`config.visConfig.opacity`	`array`	The opacity of the raster layer. When `0`, the layer is invisible. at `1`, the layer is fully opaque.
`config.visConfig.singleBandName`	`string`	The name of a single band to display. Note: `config.visConfig.preset` must be set to `"single-band"`.

`config`

An object detailing this layer's main configuration.

Required properties:

dataId
columns

Property	Type	Description
`columnMode`	`string`	Column Mode, currently only used in the TripLayer
`dataId`	`string`	The id of the dataset from which this layer was created
`columns`	`object`	Name of columns from which this layer was created
`label`	`string`	The displayed layer label
`color`	`array`	Layer color as RGB. e.g. `[255, 0, 0]`.
`isVisible`	`boolean`	Layer visibility on the map.
`hidden`	`boolean`	Hide layer from the layer panel. This will prevent the user from editing the layer.

S2

Sample s2 layer config json

{
  "id": "layer_1",
  "type": "s2",
  "config": {
    "dataId": "data_1",
    "columns": {
      "token": "point_token"
    },
    "label": "my s2 layer",
    "isVisible": true,
    "visConfig": {
      "opacity": 0.8,
      "colorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "filled": true,
      "thickness": 0.5,
      "strokeColor": null,
      "strokeColorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "sizeRange": [0, 10],
      "stroked": true,
      "enable3d": false,
      "elevationScale": 5,
      "enableElevationZoomFactor": true,
      "heightRange": [0, 500],
      "wireframe": false
    }
  },
  "visualChannels": {
    "colorField": {
      "name": "value",
      "type": "real"
    },
    "colorScale": "quantile",
    "sizeField": null,
    "sizeScale": "linear",
    "strokeColorField": {
      "name": "value",
      "type": "real"
    },
    "strokeColorScale": "quantile",
    "heightField": null,
    "heightScale": "linear"
  }
}

Layer Schema Parts

In the following sections we detail the necessary parts of this layer's configuration.

`id`

Layer id, use a string without space

required: true

`type`

This layer's type as a string. Must be "s2".

required: true

`config`

An object detailing this layer's main configuration.

Required properties:

dataId
columns

Property	Type	Description
`columnMode`	`string`	Column Mode, currently only used in the TripLayer
`dataId`	`string`	The id of the dataset from which this layer was created
`columns`	`object`	Name of columns from which this layer was created
`label`	`string`	The displayed layer label
`color`	`array`	Layer color as RGB. e.g. `[255, 0, 0]`.
`isVisible`	`boolean`	Layer visibility on the map.
`hidden`	`boolean`	Hide layer from the layer panel. This will prevent user from editing the layer.
`textLabel`	`array`
`visConfig`	`object`	Settings for layer styles

`config.columns`

Property	Type
`token`	`string`

`config.visConfig`

Property	Type
`opacity`	`number`
`colorRange`	`object`
`filled`	`boolean`
`thickness`	`number`
`strokeColor`	`array \| null`
`strokeColorRange`	`object`
`sizeRange`	`array`
`stroked`	`boolean`
`enable3d`	`boolean`
`elevationScale`	`number`
`enableElevationZoomFactor`	`boolean`
`heightRange`	`array`
`wireframe`	`boolean`

`config.visConfig.colorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`config.visConfig.strokeColorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`visualChannels`

An object detailing this layer's visual channels.

Property	Type
`colorField`	`object \| null`
`colorScale`	`string`
`sizeField`	`object \| null`
`sizeScale`	`string`
`strokeColorField`	`object \| null`
`strokeColorScale`	`string`
`heightField`	`object \| null`
`heightScale`	`string`

`visualChannels.colorScale`

Scale is based on colorField type. Supported scales are:

field type	scale options
string	ordinal
real	quantize, quantile, jenks, custom
timestamp	quantize, quantile, jenks, custom
integer	quantize, quantile, jenks, custom
boolean	ordinal
date	ordinal

`visualChannels.sizeScale`

Scale is based on sizeField type. Supported scales are:

field type	scale options
string	point
real	linear, sqrt, log
timestamp	linear, sqrt, log
integer	linear, sqrt, log
boolean	point
date	point

`visualChannels.strokeColorScale`

Scale is based on strokeColorField type. Supported scales are:

field type	scale options
string	ordinal
real	quantize, quantile, jenks, custom
timestamp	quantize, quantile, jenks, custom
integer	quantize, quantile, jenks, custom
boolean	ordinal
date	ordinal

`visualChannels.heightScale`

Scale is based on heightField type. Supported scales are:

field type	scale options
string	point
real	linear, sqrt, log
timestamp	linear, sqrt, log
integer	linear, sqrt, log
boolean	point
date	point

Trip

Sample trip layer config json

{
  "id": "layer_1",
  "type": "trip",
  "config": {
    "dataId": "data_1",
    "columns": {
      "geojson": "point_geojson",
      "id": "point_id",
      "lat": "point_lat",
      "lng": "point_lng",
      "timestamp": "point_timestamp",
      "altitude": "point_altitude"
    },
    "label": "my trip layer",
    "isVisible": true,
    "visConfig": {
      "opacity": 0.8,
      "thickness": 0.5,
      "colorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "trailLength": 180,
      "fadeTrail": true,
      "billboard": false,
      "sizeRange": [0, 10]
    }
  },
  "visualChannels": {
    "colorField": {
      "name": "value",
      "type": "real"
    },
    "colorScale": "quantile",
    "sizeField": null,
    "sizeScale": "linear"
  }
}

Layer Schema Parts

In the following sections we detail the necessary parts of this layer's configuration.

`id`

Layer id, use a string without space

required: true

`type`

This layer's type as a string. Must be "trip".

required: true

`config`

An object detailing this layer's main configuration.

Required properties:

dataId
columns

Property	Type	Description
`columnMode`	`string`	Column Mode, currently only used in the TripLayer
`dataId`	`string`	The id of the dataset from which this layer was created
`columns`	`object`	Name of columns from which this layer was created
`label`	`string`	The displayed layer label
`color`	`array`	Layer color as RGB. e.g. `[255, 0, 0]`.
`isVisible`	`boolean`	Layer visibility on the map.
`hidden`	`boolean`	Hide layer from the layer panel. This will prevent user from editing the layer.
`textLabel`	`array`
`visConfig`	`object`	Settings for layer styles

`config.columns`

Property	Type
`geojson`	`string`
`id`	`string`
`lat`	`string`
`lng`	`string`
`timestamp`	`string`
`altitude`	`string \| null`

`config.visConfig`

Property	Type
`opacity`	`number`
`thickness`	`number`
`colorRange`	`object`
`trailLength`	`number`
`fadeTrail`	`boolean`
`billboard`	`boolean`
`sizeRange`	`array`

`config.visConfig.colorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`visualChannels`

An object detailing this layer's visual channels.

Property	Type
`colorField`	`object \| null`
`colorScale`	`string`
`sizeField`	`object \| null`
`sizeScale`	`string`

`visualChannels.colorScale`

Scale is based on colorField type. Supported scales are:

field type	scale options
string	ordinal
real	quantize, quantile, jenks, custom
timestamp	quantize, quantile, jenks, custom
integer	quantize, quantile, jenks, custom
boolean	ordinal
date	ordinal

`visualChannels.sizeScale`

Scale is based on sizeField type. Supported scales are:

field type	scale options
string	point
real	linear, sqrt, log
timestamp	linear, sqrt, log
integer	linear, sqrt, log
boolean	point
date	point

Vector Tile

Sample vectorTile layer config json

{
  "id": "layer_1",
  "type": "vectorTile",
  "config": {
    "dataId": "data_1",
    "columns": {},
    "label": "my vectorTile layer",
    "isVisible": true,
    "visConfig": {
      "tileUrl": "",
      "strokeColor": null,
      "strokeOpacity": 0.8,
      "radius": 0.1,
      "enable3d": false,
      "transition": false,
      "heightRange": [0, 500],
      "elevationScale": 5,
      "opacity": 0.8,
      "colorRange": {
        "name": "Global Warming",
        "type": "sequential",
        "category": "Uber",
        "colors": [
          "#5A1846",
          "#900C3F",
          "#C70039",
          "#E3611C",
          "#F1920E",
          "#FFC300"
        ]
      },
      "radiusByZoom": {
        "enabled": false,
        "stops": null
      }
    }
  },
  "visualChannels": {
    "colorField": {
      "name": "value",
      "type": "real"
    },
    "colorScale": "quantize",
    "heightField": null,
    "heightScale": "linear"
  }
}

Layer Schema Parts

In the following sections we detail the necessary parts of this layer's configuration.

`id`

Layer id, use a string without space

required: true

`type`

This layer's type as a string. Must be "vectorTile".

required: true

`config`

An object detailing this layer's main configuration.

Required properties:

dataId
columns

Property	Type	Description
`columnMode`	`string`	Column Mode, currently only used in the TripLayer
`dataId`	`string`	The id of the dataset from which this layer was created
`columns`	`object`	Name of columns from which this layer was created
`label`	`string`	The displayed layer label
`color`	`array`	Layer color as RGB. e.g. `[255, 0, 0]`.
`isVisible`	`boolean`	Layer visibility on the map.
`hidden`	`boolean`	Hide layer from the layer panel. This will prevent user from editing the layer.
`textLabel`	`array`
`visConfig`	`object`	Settings for layer styles

`config.columns`

Property	Type

`config.visConfig`

Property	Type
`tileUrl`	`string`
`strokeColor`	`array \| null`
`strokeOpacity`	`number`
`radius`	`number`
`enable3d`	`boolean`
`transition`	`boolean`
`heightRange`	`array`
`elevationScale`	`number`
`opacity`	`number`
`colorRange`	`object`
`radiusByZoom`	`object`

`config.visConfig.colorRange`

Property	Type
`name`	`string`
`type`	`string`
`category`	`string`
`colors`	`array`
`reversed`	`boolean`
`colorMap`	`array`
`colorLegends`	`object`

`config.visConfig.radiusByZoom`

Property	Type
`enabled`	`boolean`
`stops`	`null \| array`

`visualChannels`

An object detailing this layer's visual channels.

Property	Type
`colorField`	`object \| null`
`colorScale`	`string`
`heightField`	`object \| null`
`heightScale`	`string`

`visualChannels.colorScale`

Scale is based on colorField type. Supported scales are:

field type	scale options
string	ordinal
real	quantize, quantile, jenks, custom
timestamp	quantize, quantile, jenks, custom
integer	quantize, quantile, jenks, custom
boolean	ordinal
date	ordinal

`visualChannels.heightScale`

Scale is based on heightField type. Supported scales are:

field type	scale options
string	point
real	linear, sqrt, log
timestamp	linear, sqrt, log
integer	linear, sqrt, log
boolean	point
date	point

WMS Tiles

Sample

{
  "id": "cgig2",
  "type": "WMS",
  "config": {
    "dataId": "dd4200fe-3d05-422b-8316-216145cbc6c6",
    "label": "DWD GeoServer WMS",
    "color": [130, 154, 227],
    "columns": {},
    "isVisible": true,
    "visConfig": {
      "opacity": 0.8,
      "serviceLayers": "Natural_Earth_Map"
    },
    "hidden": false,
    "textLabel": [
      {
        "field": [],
        "color": [255, 255, 255],
        "size": 18,
        "offset": [0, 0],
        "anchor": "start",
        "alignment": "center"
      }
    ]
  },
  "visualChannels": {
    "colorField": null,
    "colorScale": "quantile",
    "sizeField": null,
    "sizeScale": "linear"
  }
}

3D

Sample 3D layer config json

Layer Schema Parts

id

type

config

config.columns

config.visConfig

config.visConfig.colorRange

visualChannels

visualChannels.colorScale

visualChannels.sizeScale

3D Tile

Sample 3d tile layer config json

Arc

Sample arc layer config json

Layer Schema Parts

id

type

config

config.columns

config.visConfig

config.visConfig.colorRange

visualChannels

visualChannels.colorScale

visualChannels.sizeScale

Cluster

Sample cluster layer config json

Layer Schema Parts

id

type

config

config.columns

config.visConfig

config.visConfig.colorRange

visualChannels

visualChannels.colorScale

Flow

Sample Flow Layer Config json

Layer Schema Parts

id

type

config

Child attributes of config:

config.columns

config.visConfig

config.visConfig.colorRange

Geojson (Polygon)

Sample geojson layer config json

Layer Schema Parts

id

type

config

config.columns

config.visConfig

config.visConfig.colorRange

config.visConfig.strokeColorRange

visualChannels

visualChannels.colorScale

visualChannels.strokeColorScale

visualChannels.sizeScale

visualChannels.heightScale

visualChannels.radiusScale

Grid

Sample grid layer config json

Layer Schema Parts

id

type

config

config.columns

config.visConfig

config.visConfig.colorRange

visualChannels

visualChannels.colorScale

visualChannels.sizeScale

H3

Sample hexagonId layer config json

Layer Schema Parts

id

type

`id`

`type`

`config`

`config.columns`

`config.visConfig`

`config.visConfig.colorRange`

`visualChannels`

`visualChannels.colorScale`

`visualChannels.sizeScale`

`id`

`type`

`config`

`config.columns`

`config.visConfig`

`config.visConfig.colorRange`

`visualChannels`

`visualChannels.colorScale`

`visualChannels.sizeScale`

`id`

`type`

`config`

`config.columns`

`config.visConfig`

`config.visConfig.colorRange`

`visualChannels`

`visualChannels.colorScale`

`id`

`type`

`config`

Child attributes of `config`:

`config.columns`

`config.visConfig`

`config.visConfig.colorRange`

`id`

`type`

`config`

`config.columns`

`config.visConfig`

`config.visConfig.colorRange`

`config.visConfig.strokeColorRange`

`visualChannels`

`visualChannels.colorScale`

`visualChannels.strokeColorScale`

`visualChannels.sizeScale`

`visualChannels.heightScale`

`visualChannels.radiusScale`

`id`

`type`

`config`

`config.columns`

`config.visConfig`

`config.visConfig.colorRange`

`visualChannels`

`visualChannels.colorScale`

`visualChannels.sizeScale`

`id`

`type`

`config`

`config.columns`

`config.visConfig`

`config.visConfig.colorRange`

`visualChannels`

`visualChannels.colorScale`

`visualChannels.sizeScale`

`visualChannels.coverageScale`

`id`

`type`

`config`

`config.columns`

`config.visConfig`

`config.visConfig.colorRange`

`visualChannels`

`visualChannels.weightScale`

`id`

`type`

`config`

`config.columns`

`config.visConfig`

`config.visConfig.colorRange`

`visualChannels`