Skip to content

Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.

feat: A5 layer (#3625)

Igor Dykhtadead655a3dc9
diff --git a/SUMMARY.md b/SUMMARY.md
index d96fa7f4d..d469506fd 100644
--- a/SUMMARY.md
+++ b/SUMMARY.md
@@ -15,6 +15,7 @@
* [Layers](docs/user-guides/c-types-of-layers/README.md)
* [Point](docs/user-guides/c-types-of-layers/a-point.md)
* [S2 Layer](docs/user-guides/c-types-of-layers/l-s2.md)
+ * [A5 Layer](docs/user-guides/c-types-of-layers/q-a5.md)
* [Icon](docs/user-guides/c-types-of-layers/g-icon.md)
* [Line](docs/user-guides/c-types-of-layers/c-line.md)
* [Cluster](docs/user-guides/c-types-of-layers/f-cluster.md)
diff --git a/docs/table-of-contents.json b/docs/table-of-contents.json
index 13786438c..df0385283 100644
--- a/docs/table-of-contents.json
+++ b/docs/table-of-contents.json
@@ -46,7 +46,8 @@
{"entry": "docs/user-guides/c-types-of-layers/h-hexbin"},
{"entry": "docs/user-guides/c-types-of-layers/i-heatmap"},
{"entry": "docs/user-guides/c-types-of-layers/j-h3"},
- {"entry": "docs/user-guides/c-types-of-layers/k.trip"}
+ {"entry": "docs/user-guides/c-types-of-layers/k.trip"},
+ {"entry": "docs/user-guides/c-types-of-layers/q-a5"}
]
}
]
diff --git a/docs/user-guides/README.md b/docs/user-guides/README.md
index df8e66665..0be2b5f2a 100644
--- a/docs/user-guides/README.md
+++ b/docs/user-guides/README.md
@@ -37,6 +37,7 @@ This guide will teach you how to perform data analysis in Kepler.gl by adding da
* [H3](./c-types-of-layers/j-h3.md)
* [Trip](./c-types-of-layers/k-trip.md)
* [S2](./c-types-of-layers/l-s2.md)
+* [A5](./c-types-of-layers/q-a5.md)
* [Vector Tile Layer](./c-types-of-layers/m-vector-tile-layer.md)
* [Raster Tile Layer](./c-types-of-layers/n-raster-tile-layer.md)
* [WMS Layer](./c-types-of-layers/o-wms-layer.md)
diff --git a/docs/user-guides/c-types-of-layers/README.md b/docs/user-guides/c-types-of-layers/README.md
index fdc254fdc..940873a78 100644
--- a/docs/user-guides/c-types-of-layers/README.md
+++ b/docs/user-guides/c-types-of-layers/README.md
@@ -94,6 +94,12 @@ To use H3 layer, you need a `hex_id` in your dataset, which can be generated usi
To use S2 layer, you need to assign a column containing S2 tokens.
+## A5 Layer
+
+To use A5 layer, you need to assign a column containing [A5](https://a5geo.org) cell identifiers. Kepler.gl auto-detects columns named `a5`, `a5_token`, or `a5_id`.
+
+The A5 layer is optional and disabled by default. Enable it with `enableA5Layer: true` in the application configuration.
+
## Vector Tile Layer
![Vector Tile layer](https://4sq-studio-public.s3.us-west-2.amazonaws.com/statics/keplergl/documentation/layer-types/vector-tile.png 'Vector Tile Layer')
diff --git a/docs/user-guides/c-types-of-layers/q-a5.md b/docs/user-guides/c-types-of-layers/q-a5.md
new file mode 100644
index 000000000..d85ade18d
--- /dev/null
+++ b/docs/user-guides/c-types-of-layers/q-a5.md
@@ -0,0 +1,32 @@
+# A5 Layer
+
+To use A5 layer, you need to assign a column containing [A5](https://a5geo.org) cell identifiers (hexadecimal tokens).
+
+### Enable the layer
+
+The A5 layer is optional and **disabled by default**. Enable it in your app config:
+
+```js
+import {initApplicationConfig} from '@kepler.gl/utils';
+
+initApplicationConfig({enableA5Layer: true});
+```
+
+### Naming Convention
+
+Kepler.gl **auto generates** an A5 layer from a column named `a5`, `a5_token`, or `a5_id`.
+
+### Simple Dataset
+
+| token | value |
+| ---------------- | :-----------------: |
+| 1ae2958000000000 | 0.5979242952642347 |
+| 1ae2968000000000 | 0.5446256069712141 |
+| 1adebc8000000000 | 0.1187171597109975 |
+| 1ae2978000000000 | 0.2859146314037557 |
+| 1ae2918000000000 | 0.19549012367504126 |
+| 1ae2998000000000 | 0.3373452974230604 |
+| 1ae29a8000000000 | 0.9218176408795662 |
+| 1ae2988000000000 | 0.23470692356446143 |
+
+[Back to table of contents](../README.md)
diff --git a/examples/demo-app/src/app.tsx b/examples/demo-app/src/app.tsx
index 6a61abdce..b4b05cbfe 100644
--- a/examples/demo-app/src/app.tsx
+++ b/examples/demo-app/src/app.tsx
@@ -60,6 +60,7 @@ import sampleTripData, {testCsvData, sampleTripDataConfig} from './data/sample-t
import sampleGeojsonConfig from './data/sample-geojson-config';
import sampleH3Data, {config as h3MapConfig} from './data/sample-hex-id-csv';
import sampleS2Data, {config as s2MapConfig, dataId as s2DataId} from './data/sample-s2-data';
+import sampleA5Data, {config as a5MapConfig, dataId as a5DataId} from './data/sample-a5-data';
import sampleAnimateTrip, {
pointData,
pointDataId,
@@ -645,6 +646,26 @@ const App = props => {
);
}, [dispatch]);
+ const _loadA5Data = useCallback(() => {
+ dispatch(
+ addDataToMap({
+ datasets: [
+ {
+ info: {
+ label: 'A5 Data',
+ id: a5DataId
+ },
+ data: processCsvData(sampleA5Data)
+ }
+ ],
+ config: a5MapConfig as ParsedConfig,
+ options: {
+ keepExistingConfig: true
+ }
+ })
+ );
+ }, [dispatch]);
+
const _loadGpsData = useCallback(() => {
dispatch(
addDataToMap({
@@ -844,6 +865,7 @@ const App = props => {
// _loadIconData();
// _loadH3HexagonData();
// _loadS2Data();
+ // _loadA5Data();
// _loadScenegraphLayer();
// _loadGpsData();
// _loadRowData();
@@ -863,6 +885,7 @@ const App = props => {
_loadIconData,
_loadH3HexagonData,
_loadS2Data,
+ _loadA5Data,
_loadScenegraphLayer,
_loadGpsData,
_loadRowData,
diff --git a/examples/demo-app/src/data/sample-a5-data.js b/examples/demo-app/src/data/sample-a5-data.js
new file mode 100644
index 000000000..ec42325cf
--- /dev/null
+++ b/examples/demo-app/src/data/sample-a5-data.js
@@ -0,0 +1,54 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+export default `a5,value
+1ae2958000000000,0.5979242952642347
+1ae2968000000000,0.5446256069712141
+1adebc8000000000,0.1187171597109975
+1ae2978000000000,0.2859146314037557
+1ae2918000000000,0.19549012367504126
+1ae2998000000000,0.3373452974230604
+1ae29a8000000000,0.9218176408795662
+1ae2988000000000,0.23470692356446143
+`;
+
+export const dataId = 'a5-data';
+export const config = {
+ version: 'v1',
+ config: {
+ visState: {
+ filters: [],
+ layers: [
+ {
+ type: 'a5',
+ config: {
+ dataId,
+ label: 'A5 Layer',
+ color: [241, 92, 23],
+ columns: {
+ token: 'a5'
+ },
+ isVisible: true,
+ visConfig: {
+ opacity: 0.8,
+ strokeColor: [253, 230, 230],
+ colorRange: {
+ name: 'Global Warming',
+ type: 'sequential',
+ category: 'Uber',
+ colors: ['#5A1846', '#900C3F', '#C70039', '#E3611C', '#F1920E', '#FFC300']
+ }
+ }
+ },
+ visualChannels: {
+ colorField: {
+ name: 'value',
+ type: 'real'
+ },
+ colorScale: 'quantile'
+ }
+ }
+ ]
+ }
+ }
+};
diff --git a/examples/demo-app/src/reducers/index.js b/examples/demo-app/src/reducers/index.js
index 9f275583f..9540c7011 100644
--- a/examples/demo-app/src/reducers/index.js
+++ b/examples/demo-app/src/reducers/index.js
@@ -55,6 +55,7 @@ initApplicationConfig({
// Data values in the "icon" column matching these IDs will render the custom shapes.
// NOTE: Cell winding must be counter-clockwise (CCW) to match the CDN icon convention.
initApplicationConfig({
+ enableA5Layer: true,
customIcons: [
{
id: 'custom-star',
diff --git a/src/ai-assistant/src/tools/kepler-tools/layer-creation-tool.tsx b/src/ai-assistant/src/tools/kepler-tools/layer-creation-tool.tsx
index d47c7803a..46d8a6e5d 100644
--- a/src/ai-assistant/src/tools/kepler-tools/layer-creation-tool.tsx
+++ b/src/ai-assistant/src/tools/kepler-tools/layer-creation-tool.tsx
@@ -28,7 +28,8 @@ export const addLayer = extendedTool<
'heatmap',
'h3',
'trip',
- 's2'
+ 's2',
+ 'a5'
]
>;
colorBy: z.ZodOptional<z.ZodString>;
@@ -90,7 +91,8 @@ For geojson datasets:
'heatmap',
'h3',
'trip',
- 's2'
+ 's2',
+ 'a5'
]),
colorBy: z.string().optional(),
colorType: z.enum(['breaks', 'unique']).optional(),
diff --git a/src/components/src/side-panel/layer-manager.tsx b/src/components/src/side-panel/layer-manager.tsx
index 62d16a5d3..91721cec7 100644
--- a/src/components/src/side-panel/layer-manager.tsx
+++ b/src/components/src/side-panel/layer-manager.tsx
@@ -206,6 +206,7 @@ function LayerManagerFactory(
const enableRasterTileLayer = getApplicationConfig().enableRasterTileLayer;
const enableWMSLayer = getApplicationConfig().enableWMSLayer;
const enableFlowLayer = getApplicationConfig().enableFlowLayer;
+ const enableA5Layer = getApplicationConfig().enableA5Layer;
const enableLayerGroups = getApplicationConfig().enableLayerGroups;
const filteredLayerClasses = useMemo(() => {
@@ -222,8 +223,12 @@ function LayerManagerFactory(
const {flow: _flow, ...rest} = filteredClasses;
filteredClasses = rest as LayerClassesType;
}
+ if (!enableA5Layer) {
+ const {a5: _a5, ...rest} = filteredClasses;
+ filteredClasses = rest as LayerClassesType;
+ }
return filteredClasses as LayerClassesType;
- }, [enableRasterTileLayer, enableWMSLayer, enableFlowLayer, layerClasses]);
+ }, [enableRasterTileLayer, enableWMSLayer, enableFlowLayer, enableA5Layer, layerClasses]);
return (
<div className="layer-manager">
diff --git a/src/components/src/side-panel/layer-panel/dataset-layer-section.tsx b/src/components/src/side-panel/layer-panel/dataset-layer-section.tsx
index 032af2463..8ea14e77b 100644
--- a/src/components/src/side-panel/layer-panel/dataset-layer-section.tsx
+++ b/src/components/src/side-panel/layer-panel/dataset-layer-section.tsx
@@ -66,6 +66,7 @@ function DatasetLayerSectionFactory(
const enableWMSLayer = getApplicationConfig().enableWMSLayer;
const enableFlowLayer = getApplicationConfig().enableFlowLayer;
const enableBitmapLayer = getApplicationConfig().enableBitmapLayer;
+ const enableA5Layer = getApplicationConfig().enableA5Layer;
const filteredLayerClasses = useMemo(() => {
let filteredClasses = layerClasses;
@@ -85,8 +86,19 @@ function DatasetLayerSectionFactory(
const {bitmap: _bitmap, ...rest} = filteredClasses;
filteredClasses = rest as LayerClassesType;
}
+ if (!enableA5Layer) {
+ const {a5: _a5, ...rest} = filteredClasses;
+ filteredClasses = rest as LayerClassesType;
+ }
return filteredClasses as LayerClassesType;
- }, [enableRasterTileLayer, enableWMSLayer, enableFlowLayer, enableBitmapLayer, layerClasses]);
+ }, [
+ enableRasterTileLayer,
+ enableWMSLayer,
+ enableFlowLayer,
+ enableBitmapLayer,
+ enableA5Layer,
+ layerClasses
+ ]);
return (
<DatasetLayerSectionWrapper>
diff --git a/src/components/src/side-panel/layer-panel/layer-configurator.tsx b/src/components/src/side-panel/layer-panel/layer-configurator.tsx
index 93d1dc4e4..4c922f90e 100644
--- a/src/components/src/side-panel/layer-panel/layer-configurator.tsx
+++ b/src/components/src/side-panel/layer-panel/layer-configurator.tsx
@@ -1487,6 +1487,114 @@ export default function LayerConfiguratorFactory(
);
}
+ _renderA5LayerConfig({
+ layer,
+ visConfiguratorProps,
+ layerConfiguratorProps,
+ layerChannelConfigProps
+ }) {
+ const {
+ config: {visConfig}
+ } = layer;
+
+ return (
+ <StyledLayerVisualConfigurator>
+ {/* Color */}
+ <LayerConfigGroup
+ {...layer.visConfigSettings.filled}
+ {...visConfiguratorProps}
+ label="layer.fillColor"
+ collapsible
+ >
+ <ChannelByValueSelector
+ channel={layer.visualChannels.color}
+ {...layerChannelConfigProps}
+ />
+ {layer.config.colorField ? (
+ <LayerColorRangeSelector {...visConfiguratorProps} />
+ ) : (
+ <LayerColorSelector {...layerConfiguratorProps} />
+ )}
+ <ConfigGroupCollapsibleContent>
+ <VisConfigSlider {...layer.visConfigSettings.opacity} {...visConfiguratorProps} />
+ </ConfigGroupCollapsibleContent>
+ </LayerConfigGroup>
+
+ {/* Stroke */}
+ <LayerConfigGroup
+ {...layer.visConfigSettings.stroked}
+ {...visConfiguratorProps}
+ label="layer.strokeColor"
+ collapsible
+ >
+ {layer.config.strokeColorField ? (
+ <LayerColorRangeSelector {...visConfiguratorProps} property="strokeColorRange" />
+ ) : (
+ <LayerColorSelector
+ {...visConfiguratorProps}
+ selectedColor={layer.config.visConfig.strokeColor}
+ property="strokeColor"
+ />
+ )}
+ <ChannelByValueSelector
+ channel={layer.visualChannels.strokeColor}
+ {...layerChannelConfigProps}
+ />
+ </LayerConfigGroup>
+
+ {/* Stroke Width */}
+ <LayerConfigGroup {...visConfiguratorProps} label="layer.strokeWidth" collapsible>
+ {layer.config.sizeField ? (
+ <VisConfigSlider
+ {...layer.visConfigSettings.sizeRange}
+ {...visConfiguratorProps}
+ label={false}
+ />
+ ) : (
+ <VisConfigSlider
+ {...layer.visConfigSettings.thickness}
+ {...visConfiguratorProps}
+ label={false}
+ />
+ )}
+ <ConfigGroupCollapsibleContent>
+ <ChannelByValueSelector
+ channel={layer.visualChannels.size}
+ {...layerChannelConfigProps}
+ />
+ </ConfigGroupCollapsibleContent>
+ </LayerConfigGroup>
+
+ {/* Elevation */}
+ <LayerConfigGroup
+ {...visConfiguratorProps}
+ {...layer.visConfigSettings.enable3d}
+ disabled={!visConfig.filled}
+ collapsible
+ >
+ <ChannelByValueSelector
+ channel={layer.visualChannels.height}
+ {...layerChannelConfigProps}
+ />
+ <VisConfigSlider
+ {...layer.visConfigSettings.elevationScale}
+ {...visConfiguratorProps}
+ label={'layerVisConfigs.heightMultiplier'}
+ />
+ <ConfigGroupCollapsibleContent>
+ <VisConfigSlider
+ {...layer.visConfigSettings.heightRange}
+ {...visConfiguratorProps}
+ label="layerVisConfigs.heightRange"
+ />
+ <VisConfigSwitch {...layer.visConfigSettings.fixedHeight} {...visConfiguratorProps} />
+ <VisConfigSwitch {...visConfiguratorProps} {...layer.visConfigSettings.wireframe} />
+ </ConfigGroupCollapsibleContent>
+ </LayerConfigGroup>
+ </StyledLayerVisualConfigurator>
+ );
+ }
+
_renderTile3dLayerConfig({layer, visConfiguratorProps, layerConfiguratorProps}) {
return (
<StyledLayerVisualConfigurator>
diff --git a/src/constants/src/layers.ts b/src/constants/src/layers.ts
index e514e98de..8d5990764 100644
--- a/src/constants/src/layers.ts
+++ b/src/constants/src/layers.ts
@@ -607,6 +607,7 @@ export const LAYER_TYPES = keyMirror({
'3D': null,
trip: null,
s2: null,
+ a5: null,
flow: null,
vectorTile: null,
rasterTile: null,
diff --git a/src/deckgl-types.d.ts b/src/deckgl-types.d.ts
index 232258881..582c31dee 100644
--- a/src/deckgl-types.d.ts
+++ b/src/deckgl-types.d.ts
@@ -104,6 +104,7 @@ declare module '@deck.gl/geo-layers' {
export {default as H3HexagonLayer} from '@deck.gl/geo-layers/dist/h3-layers/h3-hexagon-layer';
export {default as H3ClusterLayer} from '@deck.gl/geo-layers/dist/h3-layers/h3-cluster-layer';
export {default as S2Layer} from '@deck.gl/geo-layers/dist/s2-layer/s2-layer';
+ export {default as A5Layer} from '@deck.gl/geo-layers/dist/a5-layer/a5-layer';
export {default as TripsLayer} from '@deck.gl/geo-layers/dist/trips-layer/trips-layer';
export {default as TileLayer} from '@deck.gl/geo-layers/dist/tile-layer/tile-layer';
export {default as MVTLayer} from '@deck.gl/geo-layers/dist/mvt-layer/mvt-layer';
@@ -113,6 +114,7 @@ declare module '@deck.gl/geo-layers' {
export type {H3HexagonLayerProps} from '@deck.gl/geo-layers/dist/h3-layers/h3-hexagon-layer';
export type {S2LayerProps} from '@deck.gl/geo-layers/dist/s2-layer/s2-layer';
+ export type {A5LayerProps} from '@deck.gl/geo-layers/dist/a5-layer/a5-layer';
export type {
TileLayerProps,
TileLayerPickingInfo
diff --git a/src/layers/package.json b/src/layers/package.json
index bbd82bd98..446f917bf 100644
--- a/src/layers/package.json
+++ b/src/layers/package.json
@@ -70,6 +70,7 @@
"@types/keymirror": "^0.1.1",
"@types/lodash": "4.17.5",
"@types/styled-components": "^5.1.32",
+ "a5-js": "^0.7.3",
"apache-arrow": ">=15.0.0",
"buffer": "6.0.3",
"d3-array": "^2.8.0",
diff --git a/src/layers/src/a5-layer/a5-layer-icon.tsx b/src/layers/src/a5-layer/a5-layer-icon.tsx
new file mode 100644
index 000000000..8e7cba6d0
--- /dev/null
+++ b/src/layers/src/a5-layer/a5-layer-icon.tsx
@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import React from 'react';
+import {Base, BaseProps} from '../base';
+
+const A5LayerIcon: React.FC<Partial<BaseProps>> = ({
+ height = '18px',
+ predefinedClassName = 'a5-layer-icon',
+ ...props
+}) => (
+ <Base height={height} predefinedClassName={predefinedClassName} {...props}>
+ <path d="M32,6.5,54.5,22.9,45.9,49.3H18.1L9.5,22.9Z" />
+ <path d="M32,12.2,48.7,24.4,42.3,44.1H21.7L15.3,24.4Z" />
+ <path d="M23.2,38.4V27.1h2.1v4.5h5.1V27.1h2.1V38.4H30.4V33.4H25.3v5Z" />
+ <path d="M35.1,38.4l.7-1.9a4.8,4.8,0,0,0,1.5.6,4.3,4.3,0,0,0,1.5.2,2,2,0,0,0,1.4-.4,1.3,1.3,0,0,0,.5-1.1,1,1,0,0,0-.5-.9,3.7,3.7,0,0,0-1.8-.3h-1v-1.6h.9a3.9,3.9,0,0,0,1.5-.2,1.5,1.5,0,0,0,.9-1.4,1.2,1.2,0,0,0-.4-.9,2.3,2.3,0,0,0-1.4-.3,4.1,4.1,0,0,0-2.4.8l-.8-1.8a5.3,5.3,0,0,1,3.4-1.1,3.8,3.8,0,0,1,2.5.7,2.3,2.3,0,0,1,.9,1.9,2.1,2.1,0,0,1-.5,1.4,2.8,2.8,0,0,1-1.3.8v0a2.5,2.5,0,0,1,1.5.7,2,2,0,0,1,.6,1.5,2.8,2.8,0,0,1-1,2.3,4.4,4.4,0,0,1-2.9.8A6.3,6.3,0,0,1,35.1,38.4Z" />
+ </Base>
+);
+
+export default A5LayerIcon;
diff --git a/src/layers/src/a5-layer/a5-layer.ts b/src/layers/src/a5-layer/a5-layer.ts
new file mode 100644
index 000000000..eb68211d1
--- /dev/null
+++ b/src/layers/src/a5-layer/a5-layer.ts
@@ -0,0 +1,403 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import {A5Layer as DeckA5Layer} from '@deck.gl/geo-layers';
+import {GeoJsonLayer} from '@deck.gl/layers';
+import type {Feature} from 'geojson';
+import {
+ HIGHLIGH_COLOR_3D,
+ CHANNEL_SCALES,
+ LAYER_VIS_CONFIGS,
+ DEFAULT_COLOR_UI
+} from '@kepler.gl/constants';
+import {default as KeplerTable} from '@kepler.gl/table';
+import Layer, {
+ LayerBaseConfig,
+ LayerBaseConfigPartial,
+ LayerColorConfig,
+ LayerSizeConfig,
+ LayerStrokeColorConfig,
+ LayerHeightConfig
+} from '../base-layer';
+import {
+ ColorRange,
+ Merge,
+ RGBColor,
+ VisConfigBoolean,
+ VisConfigColorRange,
+ VisConfigColorSelect,
+ VisConfigNumber,
+ VisConfigRange,
+ LayerColumn
+} from '@kepler.gl/types';
+import A5LayerIcon from './a5-layer-icon';
+import {a5TokenToPolygonGeo, getA5Center, normalizeA5Token, validA5Token} from './a5-utils';
+import {DataContainerInterface, createDataContainer} from '@kepler.gl/utils';
+
+export type A5GeometryLayerVisConfigSettings = {
+ opacity: VisConfigNumber;
+ colorRange: VisConfigColorRange;
+ filled: VisConfigBoolean;
+ thickness: VisConfigNumber;
+ strokeColor: VisConfigColorSelect;
+ strokeColorRange: VisConfigColorRange;
+ sizeRange: VisConfigRange;
+ stroked: VisConfigBoolean;
+ enable3d: VisConfigBoolean;
+ elevationScale: VisConfigNumber;
+ enableElevationZoomFactor: VisConfigBoolean;
+ heightRange: VisConfigRange;
+ wireframe: VisConfigBoolean;
+};
+
+export type A5GeometryLayerColumnsConfig = {
+ token: LayerColumn;
+};
+
+export type A5GeometryLayerVisConfig = {
+ opacity: number;
+ colorRange: ColorRange;
+ filled: boolean;
+ thickness: number;
+ strokeColor: RGBColor;
+ strokeColorRange: ColorRange;
+ sizeRange: [number, number];
+ stroked: boolean;
+ enable3d: boolean;
+ elevationScale: number;
+ enableElevationZoomFactor: boolean;
+ heightRange: [number, number];
+ wireframe: boolean;
+};
+
+export type A5GeometryLayerVisualChannelConfig = LayerColorConfig &
+ LayerSizeConfig &
+ LayerStrokeColorConfig &
+ LayerHeightConfig;
+export type A5GeometryLayerConfig = Merge<
+ LayerBaseConfig,
+ {columns: A5GeometryLayerColumnsConfig; visConfig: A5GeometryLayerVisConfig}
+> &
+ A5GeometryLayerVisualChannelConfig;
+
+export type A5GeometryLayerData = {
+ index: number;
+ token: string;
+};
+
+const zoomFactorValue = 8;
+const DEFAULT_LINE_SCALE_VALUE = 8;
+
+export const A5_TOKEN_FIELDS: {
+ token: ['a5', 'a5_token', 'a5_id'];
+} = {
+ token: ['a5', 'a5_token', 'a5_id']
+};
+
+export const a5RequiredColumns: ['token'] = ['token'];
+export const A5TokenAccessor =
+ ({token}: A5GeometryLayerColumnsConfig) =>
+ (dc: DataContainerInterface) =>
+ d =>
+ dc.valueAt(d.index, token.fieldIdx);
+
+export const defaultElevation = 500;
+export const defaultLineWidth = 1;
+
+export const A5VisConfigs: {
+ // Filled color
+ opacity: 'opacity';
+ colorRange: 'colorRange';
+ filled: VisConfigBoolean;
+
+ // stroke
+ thickness: VisConfigNumber;
+ strokeColor: 'strokeColor';
+ strokeColorRange: 'strokeColorRange';
+ sizeRange: 'strokeWidthRange';
+ stroked: 'stroked';
+
+ // height
+ enable3d: 'enable3d';
+ elevationScale: 'elevationScale';
+ enableElevationZoomFactor: 'enableElevationZoomFactor';
+ fixedHeight: 'fixedHeight';
+ heightRange: 'elevationRange';
+
+ // wireframe
+ wireframe: 'wireframe';
+} = {
+ // Filled color
+ opacity: 'opacity',
+ colorRange: 'colorRange',
+ filled: {
+ ...LAYER_VIS_CONFIGS.filled,
+ type: 'boolean',
+ label: 'Fill Color',
+ defaultValue: true,
+ property: 'filled'
+ },
+
+ // stroke
+ thickness: {
+ ...LAYER_VIS_CONFIGS.thickness,
+ defaultValue: 0.5
+ },
+ strokeColor: 'strokeColor',
+ strokeColorRange: 'strokeColorRange',
+ sizeRange: 'strokeWidthRange',
+ stroked: 'stroked',
+
+ // height
+ enable3d: 'enable3d',
+ elevationScale: 'elevationScale',
+ enableElevationZoomFactor: 'enableElevationZoomFactor',
+ fixedHeight: 'fixedHeight',
+ heightRange: 'elevationRange',
+
+ // wireframe
+ wireframe: 'wireframe'
+};
+
+export default class A5GeometryLayer extends Layer {
+ dataToFeature: any;
+ declare visConfigSettings: A5GeometryLayerVisConfigSettings;
+ declare config: A5GeometryLayerConfig;
+ constructor(props) {
+ super(props);
+ this.registerVisConfig(A5VisConfigs);
+ this.getPositionAccessor = (dataContainer: DataContainerInterface) =>
+ A5TokenAccessor(this.config.columns)(dataContainer);
+ }
+
+ get type(): 'a5' {
+ return 'a5';
+ }
+
+ get name(): 'A5' {
+ return 'A5';
+ }
+
+ get requiredLayerColumns() {
+ return a5RequiredColumns;
+ }
+
+ get layerIcon() {
+ return A5LayerIcon;
+ }
+
+ get visualChannels() {
+ const visualChannels = super.visualChannels;
+ return {
+ color: {
+ ...visualChannels.color,
+ accessor: 'getFillColor'
+ },
+ size: {
+ ...visualChannels.size,
+ property: 'stroke',
+ accessor: 'getLineWidth',
+ condition: config => config.visConfig.stroked,
+ defaultValue: defaultLineWidth
+ },
+ strokeColor: {
+ property: 'strokeColor',
+ field: 'strokeColorField',
+ scale: 'strokeColorScale',
+ domain: 'strokeColorDomain',
+ range: 'strokeColorRange',
+ key: 'strokeColor',
+ channelScaleType: CHANNEL_SCALES.color,
+ accessor: 'getLineColor',
+ condition: config => config.visConfig.stroked,
+ nullValue: visualChannels.color.nullValue,
+ defaultValue: config => config.visConfig.strokeColor || config.color
+ },
+ height: {
+ property: 'height',
+ field: 'heightField',
+ scale: 'heightScale',
+ domain: 'heightDomain',
+ range: 'heightRange',
+ key: 'height',
+ channelScaleType: CHANNEL_SCALES.size,
+ accessor: 'getElevation',
+ condition: config => config.visConfig.enable3d,
+ nullValue: 0,
+ defaultValue: defaultElevation
+ }
+ };
+ }
+
+ getDefaultLayerConfig(props: LayerBaseConfigPartial) {
+ const defaultLayerConfig = super.getDefaultLayerConfig(props ?? {});
+ return {
+ ...defaultLayerConfig,
+
+ // add height visual channel
+ heightField: null,
+ heightDomain: [0, 1],
+ heightScale: 'linear',
+
+ // add stroke color visual channel
+ strokeColorField: null,
+ strokeColorDomain: [0, 1],
+ strokeColorScale: 'quantile',
+ colorUI: {
+ ...defaultLayerConfig.colorUI,
+ strokeColorRange: DEFAULT_COLOR_UI
+ }
+ };
+ }
+
+ static findDefaultLayerProps({fields = []}: KeplerTable) {
+ const foundColumns = this.findDefaultColumnField(A5_TOKEN_FIELDS, fields);
+ if (!foundColumns || !foundColumns.length) {
+ return {props: []};
+ }
+
+ return {
+ props: foundColumns.map(columns => ({
+ isVisible: true,
+ label: 'A5',
+ columns
+ }))
+ };
+ }
+
+ calculateDataAttribute({filteredIndex}: KeplerTable, getA5Token) {
+ const data: A5GeometryLayerData[] = [];
+ for (let i = 0; i < filteredIndex.length; i++) {
+ const index = filteredIndex[i];
+ const token = getA5Token({index});
+ const normalized = normalizeA5Token(token);
+ if (normalized) {
+ data.push({
+ index,
+ token: normalized
+ });
+ }
+ }
+ return data;
+ }
+
+ updateLayerMeta(dataset: KeplerTable, getA5Token) {
+ const {dataContainer} = dataset;
+ const centroids = dataContainer.reduce(
+ (acc, entry, index) => {
+ const a5Token = getA5Token({index});
+ if (validA5Token(a5Token)) {
+ const center = getA5Center(a5Token);
+ if (center) {
+ acc.push(center);
+ }
+ }
+
+ return acc;
+ },
+ [],
+ true
+ );
+
+ const centroidsDataContainer = createDataContainer(centroids);
+ const bounds = this.getPointsBounds(centroidsDataContainer, (d, dc) => [
+ dc.valueAt(d.index, 0),
+ dc.valueAt(d.index, 1)
+ ]);
+ this.dataToFeature = {centroids};
+ this.updateMeta({bounds});
+ }
+
+ formatLayerData(datasets, oldLayerData) {
+ if (this.config.dataId === null) {
+ return {};
+ }
+ const {gpuFilter, dataContainer} = datasets[this.config.dataId];
+ const getA5Token = this.getPositionAccessor(dataContainer);
+ const {data} = this.updateData(datasets, oldLayerData);
+
+ const accessors = this.getAttributeAccessors({dataContainer});
+
+ return {
+ data,
+ getA5Token,
+ getFilterValue: gpuFilter.filterValueAccessor(dataContainer)(),
+ ...accessors
+ };
+ }
+
+ /**
+ * Composite deck.gl layers report sublayer ids (e.g. `${id}-cell-fill`).
+ * Treat those as belonging to this layer so hover outlines can render.
+ */
+ isLayerHovered(objectInfo): boolean {
+ const layerId = objectInfo?.layer?.id ?? objectInfo?.layer?.props?.id;
+ return Boolean(
+ objectInfo?.picked &&
+ typeof layerId === 'string' &&
+ (layerId === this.id || layerId.startsWith(`${this.id}-`))
+ );
+ }
+
+ renderLayer(opts) {
+ const {data, gpuFilter, objectHovered, interactionConfig, mapState} = opts;
+
+ const defaultLayerProps = this.getDefaultDeckLayerProps(opts);
+
+ const eleZoomFactor = this.getElevationZoomFactor(mapState);
+ const zoomFactor = this.getZoomFactor(mapState);
+ const {config} = this;
+ const {visConfig} = config;
+ const hoveredObject = this.hasHoveredObject(objectHovered);
+
+ const updateTriggers = {
+ ...this.getVisualChannelUpdateTriggers(),
+ getFilterValue: gpuFilter.filterValueUpdateTriggers
+ };
+
+ return [
+ new DeckA5Layer({
+ ...defaultLayerProps,
+ ...interactionConfig,
+ ...data,
+ getPentagon: (d: any) => d.token,
+
+ autoHighlight: visConfig.enable3d,
+ highlightColor: HIGHLIGH_COLOR_3D,
+
+ // stroke
+ lineWidthScale: visConfig.thickness * zoomFactor * zoomFactorValue,
+ stroked: visConfig.stroked,
+ lineMiterLimit: 2,
+
+ // Filled color
+ filled: visConfig.filled,
+ opacity: visConfig.opacity,
+ wrapLongitude: false,
+
+ // Elevation
+ elevationScale: visConfig.elevationScale * eleZoomFactor,
+ extruded: visConfig.enable3d,
+
+ wireframe: visConfig.wireframe,
+
+ pickable: true,
+
+ updateTriggers
+ }),
+ // hover outline (2D); 3D uses autoHighlight
+ ...(hoveredObject && !visConfig.enable3d
+ ? [
+ new GeoJsonLayer({
+ ...this.getDefaultHoverLayerProps(),
+ visible: defaultLayerProps.visible,
+ data: [a5TokenToPolygonGeo(hoveredObject)].filter(Boolean) as Feature[],
+ getLineColor: config.highlightColor,
+ lineWidthScale: DEFAULT_LINE_SCALE_VALUE * zoomFactor,
+ wrapLongitude: false
+ })
+ ]
+ : [])
+ ];
+ }
+}
diff --git a/src/layers/src/a5-layer/a5-utils.ts b/src/layers/src/a5-layer/a5-utils.ts
new file mode 100644
index 000000000..57d6d05cc
--- /dev/null
+++ b/src/layers/src/a5-layer/a5-utils.ts
@@ -0,0 +1,155 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import {cellToBoundary, cellToLonLat, getResolution, hexToU64, u64ToHex} from 'a5-js';
+import type {Feature, LineString, Polygon} from 'geojson';
+
+const HEX_RE = /^[0-9a-fA-F]+$/;
+const MAX_A5_RESOLUTION = 30;
+
+export function maybeStripQuotes(token: string): string {
+ if (token.length >= 2) {
+ const first = token[0];
+ const last = token[token.length - 1];
+ if ((first === "'" && last === "'") || (first === '"' && last === '"')) {
+ return token.slice(1, -1);
+ }
+ }
+ return token;
+}
+
+/**
+ * Convert an A5 cell id (hex string or bigint) to a bigint cell index.
+ */
+export function toA5Cell(token: string | bigint | number): bigint | null {
+ if (typeof token === 'bigint') {
+ return token;
+ }
+
+ if (typeof token === 'number') {
+ if (!Number.isSafeInteger(token) || token < 0) {
+ return null;
+ }
+ try {
+ return BigInt(token);
+ } catch {
+ return null;
+ }
+ }
+
+ if (typeof token !== 'string') {
+ return null;
+ }
+
+ const cleaned = maybeStripQuotes(token).trim();
+ if (!cleaned || !HEX_RE.test(cleaned)) {
+ return null;
+ }
+
+ try {
+ return hexToU64(cleaned);
+ } catch {
+ return null;
+ }
+}
+
+/**
+ * Validate an A5 cell token (hex string or bigint).
+ */
+export function validA5Token(token: unknown): boolean {
+ if (typeof token !== 'string' && typeof token !== 'bigint' && typeof token !== 'number') {
+ return false;
+ }
+
+ const cell = toA5Cell(token as string | bigint | number);
+ if (cell === null) {
+ return false;
+ }
+
+ try {
+ const resolution = getResolution(cell);
+ return resolution >= 0 && resolution <= MAX_A5_RESOLUTION;
+ } catch {
+ return false;
+ }
+}
+
+/**
+ * Normalize an A5 token to a lowercase hex string for deck.gl A5Layer.
+ */
+export function normalizeA5Token(token: unknown): string | null {
+ if (typeof token !== 'string' && typeof token !== 'bigint' && typeof token !== 'number') {
+ return null;
+ }
+ const cell = toA5Cell(token);
+ if (cell === null || !validA5Token(cell)) {
+ return null;
+ }
+ return u64ToHex(cell);
+}
+
+/**
+ * Retrieve A5 cell center as [lng, lat].
+ */
+export function getA5Center(token: string | bigint | number): [number, number] | null {
+ const cell = toA5Cell(token);
+ if (cell === null) {
+ return null;
+ }
+
+ try {
+ if (!validA5Token(cell)) {
+ return null;
+ }
+ const [lng, lat] = cellToLonLat(cell);
+ return [lng, lat];
+ } catch {
+ return null;
+ }
+}
+
+/**
+ * Convert an A5 cell token to a GeoJSON Feature for hover outline rendering.
+ */
+export function a5TokenToPolygonGeo(
+ object?: {token?: string},
+ properties?: {isClosed?: boolean; [key: string]: any}
+): Feature<LineString | Polygon> | null {
+ if (!object?.token) {
+ return null;
+ }
+
+ const cell = toA5Cell(object.token);
+ if (cell === null || !validA5Token(cell)) {
+ return null;
+ }
+
+ try {
+ const vertices = cellToBoundary(cell, {closedRing: true, segments: 'auto'}) as [
+ number,
+ number
+ ][];
+
+ if (properties?.isClosed) {
+ return {
+ type: 'Feature',
+ geometry: {
+ type: 'Polygon',
+ coordinates: [vertices]
+ },
+ properties: properties ?? null
+ };
+ }
+
+ return {
+ type: 'Feature',
+ geometry: {
+ type: 'LineString',
+ coordinates: vertices
+ },
+ properties: properties ?? null
+ };
+ } catch {
+ return null;
+ }
+}
diff --git a/src/layers/src/index.ts b/src/layers/src/index.ts
index 61501bbc8..b0aec639f 100644
--- a/src/layers/src/index.ts
+++ b/src/layers/src/index.ts
@@ -41,8 +41,11 @@ export {
} from './trip-layer/trip-utils';
import {default as S2GeometryLayer} from './s2-geometry-layer/s2-geometry-layer';
export {defaultElevation as s2DefaultElevation} from './s2-geometry-layer/s2-geometry-layer';
+import {default as A5GeometryLayer} from './a5-layer/a5-layer';
+export {defaultElevation as a5DefaultElevation} from './a5-layer/a5-layer';
import {default as FlowLayer} from './flow-layer/flow-layer';
export {getS2Center} from './s2-geometry-layer/s2-utils';
+export {getA5Center} from './a5-layer/a5-utils';
export {default as AggregationLayer} from './aggregation-layer';
import {default as VectorTileLayer} from './vector-tile/vector-tile-layer';
@@ -104,6 +107,7 @@ export const KeplerGlLayers = {
ScenegraphLayer,
TripLayer,
S2GeometryLayer,
+ A5GeometryLayer,
FlowLayer,
VectorTileLayer,
RasterTileLayer,
@@ -127,6 +131,7 @@ export const LayerClasses = {
[LAYER_TYPES['3D']]: ScenegraphLayer,
[LAYER_TYPES.trip]: TripLayer,
[LAYER_TYPES.s2]: S2GeometryLayer,
+ [LAYER_TYPES.a5]: A5GeometryLayer,
[LAYER_TYPES.flow]: FlowLayer,
[LAYER_TYPES['vectorTile']]: VectorTileLayer,
[LAYER_TYPES['rasterTile']]: RasterTileLayer,
diff --git a/src/utils/src/application-config.ts b/src/utils/src/application-config.ts
index 6f2671f2b..2e54357eb 100644
--- a/src/utils/src/application-config.ts
+++ b/src/utils/src/application-config.ts
@@ -134,6 +134,10 @@ export type KeplerApplicationConfig = {
// Bitmap layer config
enableBitmapLayer?: boolean;
+ // A5 layer config
+ // A5 DGGS layer is optional. Disabled by default; enable via initApplicationConfig.
+ enableA5Layer?: boolean;
+
/** Whether to show example URLs in tileset setup forms (vector tile, raster tile, WMS, 3D tile) */
showInlineTilesetExamples?: boolean;
@@ -264,6 +268,9 @@ const DEFAULT_APPLICATION_CONFIG: Required<KeplerApplicationConfig> = {
// Bitmap layer config
enableBitmapLayer: true,
+ // A5 layer config
+ enableA5Layer: true,
+
showInlineTilesetExamples: true,
// Image export config
diff --git a/src/utils/src/dataset-utils.ts b/src/utils/src/dataset-utils.ts
index 39c94066e..66ad012d4 100644
--- a/src/utils/src/dataset-utils.ts
+++ b/src/utils/src/dataset-utils.ts
@@ -84,6 +84,7 @@ const EXCLUDED_DEFAULT_FIELDS = [
'cbgs',
'h3',
's2',
+ 'a5',
// Geographic coords (but not z/elevation/altitude
// since that might be a metric)
'lat',
diff --git a/test/browser/layer-tests/a5-layer-specs.js b/test/browser/layer-tests/a5-layer-specs.js
new file mode 100644
index 000000000..2df3607b0
--- /dev/null
+++ b/test/browser/layer-tests/a5-layer-specs.js
@@ -0,0 +1,214 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import test from 'tape';
+
+import {
+ testCreateCases,
+ testFormatLayerDataCases,
+ testRenderLayerCases
+} from 'test/helpers/layer-utils';
+import {a5DefaultElevation as defaultElevation, KeplerGlLayers} from '@kepler.gl/layers';
+import {getGpuFilterProps, KeplerTable} from '@kepler.gl/table';
+import {processCsvData} from '@kepler.gl/processors';
+import {getA5Center} from '@kepler.gl/layers';
+
+const {A5GeometryLayer} = KeplerGlLayers;
+
+const dataId = 'a5-test-data';
+const a5Csv = `a5,value,types
+1ae2958000000000,0.5,type_a
+1ae2968000000000,1.5,type_b
+1adebc8000000000,2.5,type_a
+1ae2978000000000,3.5,type_c
+1ae2988000000000,4.5,type_b
+`;
+
+const {rows, fields} = processCsvData(a5Csv);
+
+function createA5Dataset(filteredIndex) {
+ const dataset = new KeplerTable({
+ info: {id: dataId, label: 'a5-data'},
+ color: [255, 0, 0]
+ });
+ dataset.importData({
+ data: {fields, rows}
+ });
+ if (filteredIndex) {
+ dataset.filteredIndex = filteredIndex;
+ dataset.filteredIndexForDomain = filteredIndex;
+ }
+ dataset.gpuFilter = getGpuFilterProps([], dataId, dataset.fields);
+ return dataset;
+}
+
+test('#A5Geometry -> constructor', t => {
+ const TEST_CASES = [
+ {
+ props: {
+ dataId: 'smoothie',
+ isVisible: true,
+ label: 'test a5 layer'
+ },
+ test: layer => {
+ t.ok(layer.config.dataId === 'smoothie', 'A5GeometryLayer dataId should be correct');
+ t.ok(layer.type === 'a5', 'type should be a5');
+ t.deepEqual(
+ Object.keys(layer.visConfigSettings),
+ [
+ 'opacity',
+ 'colorRange',
+ 'filled',
+ 'thickness',
+ 'strokeColor',
+ 'strokeColorRange',
+ 'sizeRange',
+ 'stroked',
+ 'enable3d',
+ 'elevationScale',
+ 'enableElevationZoomFactor',
+ 'fixedHeight',
+ 'heightRange',
+ 'wireframe'
+ ],
+ 'should provide the correct visConfigSettings properties'
+ );
+ }
+ }
+ ];
+
+ testCreateCases(t, A5GeometryLayer, TEST_CASES);
+ t.end();
+});
+
+test('#A5Geometry -> formatLayerData', t => {
+ const filteredIndex = [0, 2, 4];
+ const dataset = createA5Dataset(filteredIndex);
+
+ const TEST_CASES = [
+ {
+ name: 'a5 layer',
+ layer: {
+ type: 'a5',
+ id: 'test_layer_1',
+ config: {
+ dataId,
+ label: 'A5',
+ color: [2, 3, 4],
+ columns: {
+ token: 'a5'
+ },
+ isVisible: true
+ }
+ },
+ datasets: {
+ [dataId]: dataset
+ },
+ assert: result => {
+ const {layerData, layer} = result;
+ const expectedData = [
+ {index: 0, token: '1ae2958000000000'},
+ {index: 2, token: '1adebc8000000000'},
+ {index: 4, token: '1ae2988000000000'}
+ ];
+
+ t.deepEqual(layerData.data, expectedData, 'should format correct a5 layerData');
+ t.deepEqual(layerData.getFillColor, [2, 3, 4], 'getFillColor should be a constant');
+ t.deepEqual(layerData.getElevation, defaultElevation, 'getElevation should be a constant');
+
+ const expectedBounds = expectedData.reduce(
+ (acc, d) => {
+ const center = getA5Center(d.token);
+ return [
+ Math.min(acc[0], center[0]),
+ Math.min(acc[1], center[1]),
+ Math.max(acc[2], center[0]),
+ Math.max(acc[3], center[1])
+ ];
+ },
+ [Infinity, Infinity, -Infinity, -Infinity]
+ );
+
+ // Bounds are computed from all rows in updateLayerMeta, not filtered ones
+ t.ok(layer.meta.bounds, 'should have bounds in meta');
+ t.ok(layer.meta.bounds[0] <= expectedBounds[0], 'west bound');
+ t.ok(layer.meta.bounds[1] <= expectedBounds[1], 'south bound');
+ t.ok(layer.meta.bounds[2] >= expectedBounds[2], 'east bound');
+ t.ok(layer.meta.bounds[3] >= expectedBounds[3], 'north bound');
+ }
+ }
+ ];
+
+ testFormatLayerDataCases(t, A5GeometryLayer, TEST_CASES);
+ t.end();
+});
+
+test('#A5Geometry -> renderLayer', t => {
+ const filteredIndex = [0, 2, 4];
+ const dataset = createA5Dataset(filteredIndex);
+
+ const TEST_CASES = [
+ {
+ name: 'a5 layer',
+ layer: {
+ type: 'a5',
+ id: 'test_layer_1',
+ config: {
+ dataId,
+ label: 'A5',
+ color: [2, 3, 4],
+ columns: {
+ token: 'a5'
+ },
+ isVisible: true
+ }
+ },
+ datasets: {
+ [dataId]: dataset
+ },
+ assert: (deckLayers, layer) => {
+ t.equal(layer.type, 'a5', 'should create 1 a5 layer');
+ t.equal(deckLayers.length, 4, 'Should create 4 deck.gl layers');
+
+ const expectedLayerIds = [
+ 'test_layer_1',
+ 'test_layer_1-cell',
+ 'test_layer_1-cell-fill',
+ 'test_layer_1-cell-stroke'
+ ];
+
+ t.deepEqual(
+ deckLayers.map(l => l.id),
+ expectedLayerIds,
+ 'should create composite A5 cell layers'
+ );
+
+ const {props: layerProps} = deckLayers[0];
+
+ const expectedProps = {
+ opacity: layer.config.visConfig.opacity,
+ filled: true,
+ wrapLongitude: false,
+ autoHighlight: false,
+ highlightColor: [255, 255, 255, 60],
+ extruded: false
+ };
+
+ Object.keys(expectedProps).forEach(key => {
+ t.deepEqual(layerProps[key], expectedProps[key], `should have correct props.${key}`);
+ });
+ }
+ }
+ ];
+
+ testRenderLayerCases(t, A5GeometryLayer, TEST_CASES);
+ t.end();
+});
+
+test('#A5Geometry -> findDefaultLayerProps', t => {
+ const dataset = createA5Dataset();
+ const {props} = A5GeometryLayer.findDefaultLayerProps(dataset);
+ t.equal(props.length, 1, 'should find one A5 layer prop');
+ t.equal(props[0].columns.token.value, 'a5', 'should auto-detect a5 column');
+ t.end();
+});
diff --git a/test/browser/layer-tests/index.js b/test/browser/layer-tests/index.js
index 75c22620f..cff285c31 100644
--- a/test/browser/layer-tests/index.js
+++ b/test/browser/layer-tests/index.js
@@ -17,6 +17,7 @@ import './raster-tile-layer-specs';
import './scenegraph-layer-specs';
import './trip-layer-specs';
import './s2-geometry-layer-specs';
+import './a5-layer-specs';
import './wms-layer-specs';
import './flow-layer-specs';
import './aggregation-layer-geojson-specs';
diff --git a/test/node/utils/a5-utils-test.js b/test/node/utils/a5-utils-test.js
new file mode 100644
index 000000000..269011790
--- /dev/null
+++ b/test/node/utils/a5-utils-test.js
@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import test from 'tape';
+import {getA5Center} from '@kepler.gl/layers';
+
+test('Utils -> getA5Center', t => {
+ const token = '1ae2988000000000';
+ const center = getA5Center(token);
+ t.ok(center, 'should return a center');
+ t.equal(center.length, 2, 'center should be [lng, lat]');
+ t.ok(Math.abs(center[0] + 122.374) < 0.01, 'lng should be near SF');
+ t.ok(Math.abs(center[1] - 37.783) < 0.01, 'lat should be near SF');
+ t.equal(getA5Center('ZZZZ'), null, 'invalid token returns null');
+ t.equal(getA5Center('0'), null, 'world cell returns null');
+ t.end();
+});
diff --git a/test/node/utils/index.js b/test/node/utils/index.js
index f419b0cac..1c126b09c 100644
--- a/test/node/utils/index.js
+++ b/test/node/utils/index.js
@@ -19,6 +19,7 @@ import './color-util-test';
import './util-test';
import './export-utils-test';
import './s2-utils-test';
+import './a5-utils-test';
import './editor-utils-test';
import './kepler-gl-utils-test';
import './timeline-test';
diff --git a/yarn.lock b/yarn.lock
index 13d56fef1..b54fcd9ea 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -6007,6 +6007,7 @@ __metadata:
"@types/keymirror": "npm:^0.1.1"
"@types/lodash": "npm:4.17.5"
"@types/styled-components": "npm:^5.1.32"
+ a5-js: "npm:^0.7.3"
apache-arrow: "npm:>=15.0.0"
buffer: "npm:6.0.3"
d3-array: "npm:^2.8.0"
@@ -13071,7 +13072,7 @@ __metadata:
languageName: node
linkType: hard
-"a5-js@npm:^0.7.2":
+"a5-js@npm:^0.7.2, a5-js@npm:^0.7.3":
version: 0.7.3
resolution: "a5-js@npm:0.7.3"
dependencies: