Full Layer Reference

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
PropertyTypeDescription
columnModestringColumn Mode, currently only used in the TripLayer
dataIdstringThe id of the dataset from which this layer was created
columnsobjectName of columns from which this layer was created
labelstringThe displayed layer label
colorarrayLayer color as RGB. e.g. [255, 0, 0].
isVisiblebooleanLayer visiblity on the map.
hiddenbooleanHide layer from the layer panel. This will prevent user from editing the layer.
textLabelarray
visConfigobjectSettings for layer styles

config.columns

PropertyType
latstring
lngstring
altitudestring | null

config.visConfig

PropertyType
opacitynumber
colorRangeobject
sizeScalenumber
angleXnumber
angleYnumber
angleZnumber
config.visConfig.colorRange
PropertyType
namestring
typestring
categorystring
colorsarray
reversedboolean
colorMaparray
colorLegendsobject

visualChannels

An object detailing this layer's visual channels.

PropertyType
colorFieldobject | null
colorScalestring
sizeFieldobject | null
sizeScalestring
visualChannels.colorScale

Scale is based on colorField type. Supported scales are:

field typescale options
stringordinal
realquantize, quantile, jenks, custom
timestampquantize, quantile, jenks, custom
integerquantize, quantile, jenks, custom
booleanordinal
dateordinal
visualChannels.sizeScale

Scale is based on sizeField type. Supported scales are:

field typescale options
stringpoint
reallinear, sqrt, log
timestamplinear, sqrt, log
integerlinear, sqrt, log
booleanpoint
datepoint

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
PropertyTypeDescription
columnModestringColumn Mode, currently only used in the TripLayer
dataIdstringThe id of the dataset from which this layer was created
columnsobjectName of columns from which this layer was created
labelstringThe displayed layer label
colorarrayLayer color as RGB. e.g. [255, 0, 0].
isVisiblebooleanLayer visiblity on the map.
hiddenbooleanHide layer from the layer panel. This will prevent user from editing the layer.
textLabelarray
visConfigobjectSettings for layer styles

config.columns

PropertyType
lng0string
lat0string
lng1string
lat1string

config.visConfig

PropertyType
opacitynumber
thicknessnumber
colorRangeobject
sizeRangearray
targetColorarray
config.visConfig.colorRange
PropertyType
namestring
typestring
categorystring
colorsarray
reversedboolean
colorMaparray
colorLegendsobject

visualChannels

An object detailing this layer's visual channels.

PropertyType
colorFieldobject | null
colorScalestring
sizeFieldobject | null
sizeScalestring
visualChannels.colorScale

Scale is based on colorField type. Supported scales are:

field typescale options
stringordinal
realquantize, quantile, jenks, custom
timestampquantize, quantile, jenks, custom
integerquantize, quantile, jenks, custom
booleanordinal
dateordinal
visualChannels.sizeScale

Scale is based on sizeField type. Supported scales are:

field typescale options
stringpoint
reallinear, sqrt, log
timestamplinear, sqrt, log
integerlinear, sqrt, log
booleanpoint
datepoint

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
PropertyTypeDescription
columnModestringColumn Mode, currently only used in the TripLayer
dataIdstringThe id of the dataset from which this layer was created
columnsobjectName of columns from which this layer was created
labelstringThe displayed layer label
colorarrayLayer color as RGB. e.g. [255, 0, 0].
isVisiblebooleanLayer visibility on the map.
hiddenbooleanHide layer from the layer panel. This will prevent user from editing the layer.
textLabelarray
visConfigobjectSettings for layer styles

config.columns

PropertyType
latstring
lngstring

config.visConfig

PropertyType
opacitynumber
clusterRadiusnumber
colorRangeobject
radiusRangearray
colorAggregationstring
config.visConfig.colorRange
PropertyType
namestring
typestring
categorystring
colorsarray
reversedboolean
colorMaparray
colorLegendsobject

visualChannels

An object detailing this layer's visual channels.

PropertyType
colorFieldobject | null
colorScalestring
visualChannels.colorScale

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

field typeaggregation typescale options
stringmodeordinal
stringcount uniquequantize, quantile
realaveragequantize, quantile
realmaximumquantize, quantile
realminimumquantize, quantile
realmedianquantize, quantile
realstdevquantize, quantile
realsumquantize, quantile
realvariancequantize, quantile
integeraveragequantize, quantile
integermaximumquantize, quantile
integerminimumquantize, quantile
integermedianquantize, quantile
integerstdevquantize, quantile
integersumquantize, quantile
integervariancequantize, quantile
booleanmodeordinal
booleancount uniquequantize, quantile
datemodeordinal
datecount uniquequantize, 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:

PropertyTypeRequiredDescription
dataIdstringYesThe id of the dataset from which this layer was created.
labelstringNoThe displayed layer label.
colorint arrayNoThe layer's color as an RGB value. For example: [255, 0, 0].
columnsobjectYesA list of columns used to create the layer.
isVisiblebooleanNoEnable/Disables the layer's visibility on the map.
visConfig objectNoLayer visualization settings.
hiddenbooleanNoEnable/Disables visibility of layer in the layer panel, preventing user edit.
config.columns
PropertyTypeRequiredDescription
lng0stringYesA column containing source/origin longitude.
lat0stringYesA column containing source/origin latitude.
lng1stringYesA column containing target/destination longitude.
lat1stringYesA column containing target/destination latitude.
countstringNoA 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.
sourceNamestringNoA column containing the names for sources.
If not defined, the latitude and longitude of source points are used as names.
targetNamestringNoA column containing the names for targets.
If not defined, the latitude and longitude of target points are used as names.
config.visConfig
PropertyTypeRequiredDescription
colorRangeobjectNoThe color range for the layer.
opacityintNoThe opacity of the layer on the map.
flowAnimationEnabledbooleanNoEnables/Disables animation of the flows. Use true to animate flows.
flowAdaptiveScalesEnabledbooleanNoEnables/Disables scaling of flow thickness based on flows inside the current viewport.
flowFadeEnabledbooleanNoEnables/Disables fading of flows with smaller counts.
flowFadeAmountintNoThe amount flows are faded. Increase to fade flows with smaller counts.
maxTopFlowsDisplayNumintNoThe max number of flows to displayed on the map.
flowLocationTotalsEnabledbooleanNoEnables/Disables flow location totals, circles with size based on the number of flows in and out of the location.
flowClusteringEnabledbooleanNoEnables/Disables flow clustering. Flow clustering groups neighboring source/target points.
darkBaseMapEnabledbooleanNoEnables/Disables dark base map mode. When enabled, flows on dark base maps are optimized.
config.visConfig.colorRange
PropertyTypeRequiredDescription
namestringNoThe name of the color range. For example, global warming.
typestringNoThe color range's type. For example, sequential.
colorsstring arrayNoAn array of hex strings containing colors used for the color range.
categorystringNoThe category of the color range. For example, uber.
reversedbooleanNoEnable/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
PropertyTypeDescription
columnModestringColumn Mode, currently only used in the TripLayer
dataIdstringThe id of the dataset from which this layer was created
columnsobjectName of columns from which this layer was created
labelstringThe displayed layer label
colorarrayLayer color as RGB. e.g. [255, 0, 0].
isVisiblebooleanLayer visibility on the map.
hiddenbooleanHide layer from the layer panel. This will prevent user from editing the layer.
textLabelarray
visConfigobjectSettings for layer styles

config.columns

PropertyType
geojsonstring

config.visConfig

PropertyType
opacitynumber
strokeOpacitynumber
thicknessnumber
strokeColorarray | null
colorRangeobject
strokeColorRangeobject
radiusnumber
sizeRangearray
radiusRangearray
heightRangearray
elevationScalenumber
strokedboolean
filledboolean
enable3dboolean
wireframeboolean
fixedHeightboolean
config.visConfig.colorRange
PropertyType
namestring
typestring
categorystring
colorsarray
reversedboolean
colorMaparray
colorLegendsobject
config.visConfig.strokeColorRange
PropertyType
namestring
typestring
categorystring
colorsarray
reversedboolean
colorMaparray
colorLegendsobject

visualChannels

An object detailing this layer's visual channels.

PropertyType
colorFieldobject | null
colorScalestring
strokeColorFieldobject | null
strokeColorScalestring
sizeFieldobject | null
sizeScalestring
heightFieldobject | null
heightScalestring
radiusFieldobject | null
radiusScalestring
visualChannels.colorScale

Scale is based on colorField type. Supported scales are:

field typescale options
stringordinal
realquantize, quantile, jenks, custom
timestampquantize, quantile, jenks, custom
integerquantize, quantile, jenks, custom
booleanordinal
dateordinal
visualChannels.strokeColorScale

Scale is based on strokeColorField type. Supported scales are:

field typescale options
stringordinal
realquantize, quantile, jenks, custom
timestampquantize, quantile, jenks, custom
integerquantize, quantile, jenks, custom
booleanordinal
dateordinal
visualChannels.sizeScale

Scale is based on sizeField type. Supported scales are:

field typescale options
stringpoint
reallinear, sqrt, log
timestamplinear, sqrt, log
integerlinear, sqrt, log
booleanpoint
datepoint
visualChannels.heightScale

Scale is based on heightField type. Supported scales are:

field typescale options
stringpoint
reallinear, sqrt, log
timestamplinear, sqrt, log
integerlinear, sqrt, log
booleanpoint
datepoint
visualChannels.radiusScale

Scale is based on radiusField type. Supported scales are:

field typescale options
stringpoint
realsqrt
timestampsqrt
integersqrt
booleanpoint
datepoint

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
PropertyTypeDescription
columnModestringColumn Mode, currently only used in the TripLayer
dataIdstringThe id of the dataset from which this layer was created
columnsobjectName of columns from which this layer was created
labelstringThe displayed layer label
colorarrayLayer color as RGB. e.g. [255, 0, 0].
isVisiblebooleanLayer visiblity on the map.
hiddenbooleanHide layer from the layer panel. This will prevent user from editing the layer.
textLabelarray
visConfigobjectSettings for layer styles

config.columns

PropertyType
latstring
lngstring

config.visConfig

PropertyType
opacitynumber
worldUnitSizenumber
colorRangeobject
coveragenumber
sizeRangearray
percentilearray
elevationPercentilearray
elevationScalenumber
enableElevationZoomFactorboolean
colorAggregationstring
sizeAggregationstring
enable3dboolean
config.visConfig.colorRange
PropertyType
namestring
typestring
categorystring
colorsarray
reversedboolean
colorMaparray
colorLegendsobject

visualChannels

An object detailing this layer's visual channels.

PropertyType
colorFieldobject | null
colorScalestring
sizeFieldobject | null
sizeScalestring
visualChannels.colorScale

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

field typeaggregation typescale options
stringmodeordinal
stringcount uniquequantize, quantile
realaveragequantize, quantile
realmaximumquantize, quantile
realminimumquantize, quantile
realmedianquantize, quantile
realstdevquantize, quantile
realsumquantize, quantile
realvariancequantize, quantile
integeraveragequantize, quantile
integermaximumquantize, quantile
integerminimumquantize, quantile
integermedianquantize, quantile
integerstdevquantize, quantile
integersumquantize, quantile
integervariancequantize, quantile
booleanmodeordinal
booleancount uniquequantize, quantile
datemodeordinal
datecount uniquequantize, quantile
visualChannels.sizeScale

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

field typeaggregation typescale options
realaveragelinear, sqrt, log
realmaximumlinear, sqrt, log
realminimumlinear, sqrt, log
realmedianlinear, sqrt, log
realstdevlinear, sqrt, log
realsumlinear, sqrt, log
realvariancelinear, sqrt, log
integeraveragelinear, sqrt, log
integermaximumlinear, sqrt, log
integerminimumlinear, sqrt, log
integermedianlinear, sqrt, log
integerstdevlinear, sqrt, log
integersumlinear, sqrt, log
integervariancelinear, 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
PropertyTypeDescription
columnModestringColumn Mode, currently only used in the TripLayer
dataIdstringThe id of the dataset from which this layer was created
columnsobjectName of columns from which this layer was created
labelstringThe displayed layer label
colorarrayLayer color as RGB. e.g. [255, 0, 0].
isVisiblebooleanLayer visibility on the map.
hiddenbooleanHide layer from the layer panel. This will prevent user from editing the layer.
textLabelarray
visConfigobjectSettings for layer styles

config.columns

PropertyType
hex_idstring

config.visConfig

PropertyType
opacitynumber
colorRangeobject
coveragenumber
enable3dboolean
sizeRangearray
coverageRangearray
elevationScalenumber
enableElevationZoomFactorboolean
config.visConfig.colorRange
PropertyType
namestring
typestring
categorystring
colorsarray
reversedboolean
colorMaparray
colorLegendsobject

visualChannels

An object detailing this layer's visual channels.

PropertyType
colorFieldobject | null
colorScalestring
sizeFieldobject | null
sizeScalestring
coverageFieldobject | null
coverageScalestring
visualChannels.colorScale

Scale is based on colorField type. Supported scales are:

field typescale options
stringordinal
realquantize, quantile, jenks, custom
timestampquantize, quantile, jenks, custom
integerquantize, quantile, jenks, custom
booleanordinal
dateordinal
visualChannels.sizeScale

Scale is based on sizeField type. Supported scales are:

field typescale options
stringpoint
reallinear, sqrt, log
timestamplinear, sqrt, log
integerlinear, sqrt, log
booleanpoint
datepoint
visualChannels.coverageScale

Scale is based on coverageField type. Supported scales are:

field typescale options
stringpoint
realsqrt
timestampsqrt
integersqrt
booleanpoint
datepoint

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
PropertyTypeDescription
columnModestringColumn Mode, currently only used in the TripLayer
dataIdstringThe id of the dataset from which this layer was created
columnsobjectName of columns from which this layer was created
labelstringThe displayed layer label
colorarrayLayer color as RGB. e.g. [255, 0, 0].
isVisiblebooleanLayer visibility on the map.
hiddenbooleanHide layer from the layer panel. This will prevent user from editing the layer.
textLabelarray
visConfigobjectSettings for layer styles

config.columns

PropertyType
latstring
lngstring

config.visConfig

PropertyType
opacitynumber
colorRangeobject
radiusnumber
config.visConfig.colorRange
PropertyType
namestring
typestring
categorystring
colorsarray
reversedboolean
colorMaparray
colorLegendsobject

visualChannels

An object detailing this layer's visual channels.

PropertyType
weightFieldobject | null
weightScalestring
visualChannels.weightScale

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

field typeaggregation typescale options
stringpoint
reallinear, sqrt, log
timestamplinear, sqrt, log
integerlinear, sqrt, log
booleanpoint
datepoint

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
PropertyTypeDescription
columnModestringColumn Mode, currently only used in the TripLayer
dataIdstringThe id of the dataset from which this layer was created
columnsobjectName of columns from which this layer was created
labelstringThe displayed layer label
colorarrayLayer color as RGB. e.g. [255, 0, 0].
isVisiblebooleanLayer visibility on the map.
hiddenbooleanHide layer from the layer panel. This will prevent user from editing the layer.
textLabelarray
visConfigobjectSettings for layer styles

config.columns

PropertyType
latstring
lngstring

config.visConfig

PropertyType
opacitynumber
worldUnitSizenumber
resolutionnumber
colorRangeobject
coveragenumber
sizeRangearray
percentilearray
elevationPercentilearray
elevationScalenumber
enableElevationZoomFactorboolean
colorAggregationstring
sizeAggregationstring
enable3dboolean
config.visConfig.colorRange
PropertyType
namestring
typestring
categorystring
colorsarray
reversedboolean
colorMaparray
colorLegendsobject

visualChannels

An object detailing this layer's visual channels.

PropertyType
colorFieldobject | null
colorScalestring
sizeFieldobject | null
sizeScalestring
visualChannels.colorScale

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

field typeaggregation typescale options
stringmodeordinal
stringcount uniquequantize, quantile
realaveragequantize, quantile
realmaximumquantize, quantile
realminimumquantize, quantile
realmedianquantize, quantile
realstdevquantize, quantile
realsumquantize, quantile
realvariancequantize, quantile
integeraveragequantize, quantile
integermaximumquantize, quantile
integerminimumquantize, quantile
integermedianquantize, quantile
integerstdevquantize, quantile
integersumquantize, quantile
integervariancequantize, quantile
booleanmodeordinal
booleancount uniquequantize, quantile
datemodeordinal
datecount uniquequantize, quantile
visualChannels.sizeScale

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

field typeaggregation typescale options
realaveragelinear, sqrt, log
realmaximumlinear, sqrt, log
realminimumlinear, sqrt, log
realmedianlinear, sqrt, log
realstdevlinear, sqrt, log
realsumlinear, sqrt, log
realvariancelinear, sqrt, log
integeraveragelinear, sqrt, log
integermaximumlinear, sqrt, log
integerminimumlinear, sqrt, log
integermedianlinear, sqrt, log
integerstdevlinear, sqrt, log
integersumlinear, sqrt, log
integervariancelinear, 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
PropertyTypeDescription
columnModestringColumn Mode, currently only used in the TripLayer
dataIdstringThe id of the dataset from which this layer was created
columnsobjectName of columns from which this layer was created
labelstringThe displayed layer label
colorarrayLayer color as RGB. e.g. [255, 0, 0].
isVisiblebooleanLayer visiblity on the map.
hiddenbooleanHide layer from the layer panel. This will prevent user from editing the layer.
textLabelarray
visConfigobjectSettings for layer styles

config.columns

PropertyType
latstring
lngstring
iconstring
altitudestring | null

config.visConfig

PropertyType
radiusnumber
fixedRadiusboolean
opacitynumber
colorRangeobject
radiusRangearray
billboardboolean
config.visConfig.colorRange
PropertyType
namestring
typestring
categorystring
colorsarray
reversedboolean
colorMaparray
colorLegendsobject

visualChannels

An object detailing this layer's visual channels.

PropertyType
colorFieldobject | null
colorScalestring
sizeFieldobject | null
sizeScalestring
visualChannels.colorScale

Scale is based on colorField type. Supported scales are:

field typescale options
stringordinal
realquantize, quantile, jenks, custom
timestampquantize, quantile, jenks, custom
integerquantize, quantile, jenks, custom
booleanordinal
dateordinal
visualChannels.sizeScale

Scale is based on sizeField type. Supported scales are:

field typescale options
stringpoint
realsqrt
timestampsqrt
integersqrt
booleanpoint
datepoint

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
PropertyTypeDescription
columnModestringColumn Mode, currently only used in the TripLayer
dataIdstringThe id of the dataset from which this layer was created
columnsobjectName of columns from which this layer was created
labelstringThe displayed layer label
colorarrayLayer color as RGB. e.g. [255, 0, 0].
isVisiblebooleanLayer visiblity on the map.
hiddenbooleanHide layer from the layer panel. This will prevent user from editing the layer.
textLabelarray
visConfigobjectSettings for layer styles

config.columns

PropertyType
lat0string
lng0string
lat1string
lng1string
alt0string
alt1string

config.visConfig

PropertyType
opacitynumber
thicknessnumber
colorRangeobject
sizeRangearray
targetColorarray
elevationScalenumber
config.visConfig.colorRange
PropertyType
namestring
typestring
categorystring
colorsarray
reversedboolean
colorMaparray
colorLegendsobject

visualChannels

An object detailing this layer's visual channels.

PropertyType
colorFieldobject | null
colorScalestring
sizeFieldobject | null
sizeScalestring
visualChannels.colorScale

Scale is based on colorField type. Supported scales are:

field typescale options
stringordinal
realquantize, quantile, jenks, custom
timestampquantize, quantile, jenks, custom
integerquantize, quantile, jenks, custom
booleanordinal
dateordinal
visualChannels.sizeScale

Scale is based on sizeField type. Supported scales are:

field typescale options
stringpoint
reallinear, sqrt, log
timestamplinear, sqrt, log
integerlinear, sqrt, log
booleanpoint
datepoint

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
PropertyTypeDescription
columnModestringColumn Mode, currently only used in the TripLayer
dataIdstringThe id of the dataset from which this layer was created
columnsobjectName of columns from which this layer was created
labelstringThe displayed layer label
colorarrayLayer color as RGB. e.g. [255, 0, 0].
isVisiblebooleanLayer visiblity on the map.
hiddenbooleanHide layer from the layer panel. This will prevent user from editing the layer.
textLabelarray
visConfigobjectSettings for layer styles

config.columns

PropertyType
latstring
lngstring
altitudestring | null

config.visConfig

PropertyType
radiusnumber
fixedRadiusboolean
opacitynumber
outlineboolean
thicknessnumber
strokeColorarray | null
colorRangeobject
strokeColorRangeobject
radiusRangearray
filledboolean
billboardboolean
config.visConfig.colorRange
PropertyType
namestring
typestring
categorystring
colorsarray
reversedboolean
colorMaparray
colorLegendsobject
config.visConfig.strokeColorRange
PropertyType
namestring
typestring
categorystring
colorsarray
reversedboolean
colorMaparray
colorLegendsobject

visualChannels

An object detailing this layer's visual channels.

PropertyType
colorFieldobject | null
colorScalestring
strokeColorFieldobject | null
strokeColorScalestring
sizeFieldobject | null
sizeScalestring
visualChannels.colorScale

Scale is based on colorField type. Supported scales are:

field typescale options
stringordinal
realquantize, quantile, jenks, custom
timestampquantize, quantile, jenks, custom
integerquantize, quantile, jenks, custom
booleanordinal
dateordinal
visualChannels.strokeColorScale

Scale is based on strokeColorField type. Supported scales are:

field typescale options
stringordinal
realquantize, quantile, jenks, custom
timestampquantize, quantile, jenks, custom
integerquantize, quantile, jenks, custom
booleanordinal
dateordinal
visualChannels.sizeScale

Scale is based on sizeField type. Supported scales are:

field typescale options
stringpoint
realsqrt
timestampsqrt
integersqrt
booleanpoint
datepoint

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.

PropertyTypeDescription
idstringRequired. The layer's identification string. Must not contain spaces.
typestringRequired. The layer's type as a string. Must be "rasterTile".
configobjectRequired. An object detailing this layer's main configuration.
config.dataIdstringRequired. The id of the dataset used by this layer.
config.columnsobjectName of columns from which this layer was created. Empty for raster layer.
config.labelstringName of the user-facing label displayed in the sidebar.
config.isVisiblebooleanLayer visibility on the map. When true, display label on the map.
config.hiddenbooleanHide layer visibility from the layer panel. When true, prevent the user from editing the layer.
config.visConfigobjectSettings for layer styles. Contains crucial raster configuration fields.
config.visConfig.presetstringA preset band combination to use for the raster layer. Options available depend on the bands available in the dataset.
config.visConfig.mosaicIdstringAn 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.useSTACSearchingboolWhether or not to use STAC searching, which, if available, allows users to query raster imagery from a given date range.
config.visConfig.stacSearchProviderstringThe name of the STAC searching provider to use, if available.
config.visConfig.startDatestringThe start date range for STAC searching.
config.visConfig.endDatestringThe end date range for STAC searching.
config.visConfig.dynamicColorboolWhether 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.colormapIdstringThe 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.colorRangecolor-range-selectIn Raster Tile this property can be used to set custom color map for categorical data representation (see config.visConfig.colorRange.colorMap).
config.visConfig.colorRange.colorMaparrayArray of couples [value, color], where value is categorical image pixel value, color is color in hex string format.
config.visConfig.colorRange.colorLegendsobjectColors from config.visConfig.colorRange.colorMap mapped to strings to be displayed in the legend. See the example above.
config.visConfig.linearRescalingFactorarrayAn 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.nonLinearRescalingboolWhether 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.gammaContrastFactornumberThe 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.sigmoidalContrastFactornumberA 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.sigmoidalBiasFactornumberA 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.saturationValuenumberAdjust the saturation of colors on the map. 0 is black and white, while 2 doubles the intensity of color values. )
config.visConfig.filterEnabledboolWhether or not to apply a filter to the map. When enabled, only displayed data in a given range.
config.visConfig.filterRangearrayThe range by which to display raster data. All values falling outside the range are hidden from the map.
config.visConfig.opacityarrayThe opacity of the raster layer. When 0, the layer is invisible. at 1, the layer is fully opaque.
config.visConfig.singleBandNamestringThe 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
PropertyTypeDescription
columnModestringColumn Mode, currently only used in the TripLayer
dataIdstringThe id of the dataset from which this layer was created
columnsobjectName of columns from which this layer was created
labelstringThe displayed layer label
colorarrayLayer color as RGB. e.g. [255, 0, 0].
isVisiblebooleanLayer visibility on the map.
hiddenbooleanHide 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
PropertyTypeDescription
columnModestringColumn Mode, currently only used in the TripLayer
dataIdstringThe id of the dataset from which this layer was created
columnsobjectName of columns from which this layer was created
labelstringThe displayed layer label
colorarrayLayer color as RGB. e.g. [255, 0, 0].
isVisiblebooleanLayer visibility on the map.
hiddenbooleanHide layer from the layer panel. This will prevent user from editing the layer.
textLabelarray
visConfigobjectSettings for layer styles

config.columns

PropertyType
tokenstring

config.visConfig

PropertyType
opacitynumber
colorRangeobject
filledboolean
thicknessnumber
strokeColorarray | null
strokeColorRangeobject
sizeRangearray
strokedboolean
enable3dboolean
elevationScalenumber
enableElevationZoomFactorboolean
heightRangearray
wireframeboolean
config.visConfig.colorRange
PropertyType
namestring
typestring
categorystring
colorsarray
reversedboolean
colorMaparray
colorLegendsobject
config.visConfig.strokeColorRange
PropertyType
namestring
typestring
categorystring
colorsarray
reversedboolean
colorMaparray
colorLegendsobject

visualChannels

An object detailing this layer's visual channels.

PropertyType
colorFieldobject | null
colorScalestring
sizeFieldobject | null
sizeScalestring
strokeColorFieldobject | null
strokeColorScalestring
heightFieldobject | null
heightScalestring
visualChannels.colorScale

Scale is based on colorField type. Supported scales are:

field typescale options
stringordinal
realquantize, quantile, jenks, custom
timestampquantize, quantile, jenks, custom
integerquantize, quantile, jenks, custom
booleanordinal
dateordinal
visualChannels.sizeScale

Scale is based on sizeField type. Supported scales are:

field typescale options
stringpoint
reallinear, sqrt, log
timestamplinear, sqrt, log
integerlinear, sqrt, log
booleanpoint
datepoint
visualChannels.strokeColorScale

Scale is based on strokeColorField type. Supported scales are:

field typescale options
stringordinal
realquantize, quantile, jenks, custom
timestampquantize, quantile, jenks, custom
integerquantize, quantile, jenks, custom
booleanordinal
dateordinal