Skip to content

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

[feat] H3 Layer: Add fill transparency and stroke color settings (#2249)

Igor D5fcbcdab86d7
diff --git a/bindings/kepler.gl-jupyter/js/package.json b/bindings/kepler.gl-jupyter/js/package.json
index 12362ed26..465e7cfd9 100644
--- a/bindings/kepler.gl-jupyter/js/package.json
+++ b/bindings/kepler.gl-jupyter/js/package.json
@@ -39,6 +39,7 @@
"@babel/plugin-proposal-class-properties": "^7.3.0",
"@babel/preset-env": "^7.0.0",
"@babel/preset-react": "^7.0.0",
+ "@jupyterlab/builder": "^4.0.0",
"babel-eslint": "^9.0.0",
"babel-loader": "^8.0.0",
"babel-plugin-search-and-replace": "^1.0.0",
@@ -50,12 +51,11 @@
"eslint-plugin-babel": "^5.3.0",
"eslint-plugin-prettier": "^3.0.1",
"eslint-plugin-react": "~7.12.4",
- "@jupyterlab/builder": "^4.0.0",
"html-webpack-plugin": "^4.3.0",
"react-dev-utils": "^10.2.1",
"rimraf": "^2.6.1",
"webpack": "^4.29.0",
- "webpack-cli": "^3.2.3",
+ "webpack-cli": "4.10.x",
"webpack-dev-middleware": "^3.5.1",
"webpack-dev-server": "^3.1.14",
"webpack-hot-middleware": "^2.24.3",
@@ -63,10 +63,11 @@
},
"dependencies": {
"@jupyter-widgets/base": "^2 || ^3 || ^4.0.0",
- "@jupyterlab/builder": "^3.1.5",
+ "@jupyterlab/builder": "^4.0.0",
"global": "^4.3.0",
"kepler.gl": "^2.5.5",
"node-polyfill-webpack-plugin": "^1.1.2",
+ "querystring": "0.2.1",
"react": "^17.0.2",
"react-copy-to-clipboard": "^5.0.2",
"react-dom": "^17.0.2",
@@ -78,7 +79,8 @@
"styled-components": "^4.1.3"
},
"resolutions": {
- "react-vis": "1.11.7"
+ "react-vis": "1.11.7",
+ "webpack-cli": "4.10.x"
},
"jupyterlab": {
"extension": "babel/labplugin",
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 f78e849f8..6969d10b6 100644
--- a/src/components/src/side-panel/layer-panel/layer-configurator.tsx
+++ b/src/components/src/side-panel/layer-panel/layer-configurator.tsx
@@ -490,8 +490,13 @@ export default function LayerConfiguratorFactory(
}) {
return (
<StyledLayerVisualConfigurator>
- {/* Color */}
- <LayerConfigGroup label={'layer.color'} collapsible>
+ {/* Fill Color */}
+ <LayerConfigGroup
+ {...layer.visConfigSettings.filled}
+ {...visConfiguratorProps}
+ collapsible
+ label={'layer.fillColor'}
+ >
{layer.config.colorField ? (
<LayerColorRangeSelector {...visConfiguratorProps} />
) : (
@@ -502,10 +507,46 @@ export default function LayerConfiguratorFactory(
channel={layer.visualChannels.color}
{...layerChannelConfigProps}
/>
- <VisConfigSlider {...layer.visConfigSettings.opacity} {...visConfiguratorProps} />
</ConfigGroupCollapsibleContent>
</LayerConfigGroup>
+ {/* Outline Color */}
+ <LayerConfigGroup
+ {...layer.visConfigSettings.outline}
+ {...visConfiguratorProps}
+ collapsible
+ >
+ <ChannelByValueSelector
+ channel={layer.visualChannels.strokeColor}
+ {...layerChannelConfigProps}
+ />
+ {layer.config.strokeColorField ? (
+ <LayerColorRangeSelector {...visConfiguratorProps} property="strokeColorRange" />
+ ) : (
+ <LayerColorSelector
+ {...visConfiguratorProps}
+ selectedColor={layer.config.visConfig.strokeColor}
+ property="strokeColor"
+ />
+ )}
+ <ConfigGroupCollapsibleContent>
+ <VisConfigSlider
+ {...layer.visConfigSettings.thickness}
+ {...visConfiguratorProps}
+ disabled={!layer.config.visConfig.outline}
+ />
+ </ConfigGroupCollapsibleContent>
+ </LayerConfigGroup>
+
+ {/* Opacity */}
+ <LayerConfigGroup label={layer.visConfigSettings.opacity.label}>
+ <VisConfigSlider
+ {...layer.visConfigSettings.opacity}
+ {...visConfiguratorProps}
+ label={false}
+ />
+ </LayerConfigGroup>
+
{/* Coverage */}
<LayerConfigGroup label={'layer.coverage'} collapsible>
{!layer.config.coverageField ? (
diff --git a/src/layers/src/h3-hexagon-layer/h3-hexagon-layer.ts b/src/layers/src/h3-hexagon-layer/h3-hexagon-layer.ts
index 6254e46f5..aa9e20acc 100644
--- a/src/layers/src/h3-hexagon-layer/h3-hexagon-layer.ts
+++ b/src/layers/src/h3-hexagon-layer/h3-hexagon-layer.ts
@@ -41,7 +41,13 @@ import {
createDataContainer
} from '@kepler.gl/utils';
import H3HexagonLayerIcon from './h3-hexagon-layer-icon';
-import {CHANNEL_SCALES, HIGHLIGH_COLOR_3D, ColorRange} from '@kepler.gl/constants';
+import {
+ CHANNEL_SCALES,
+ HIGHLIGH_COLOR_3D,
+ DEFAULT_COLOR_UI,
+ LAYER_VIS_CONFIGS,
+ ColorRange
+} from '@kepler.gl/constants';
import {
VisConfigBoolean,
@@ -67,6 +73,9 @@ export type HexagonIdLayerVisConfigSettings = {
coverageRange: VisConfigRange;
elevationScale: VisConfigNumber;
enableElevationZoomFactor: VisConfigBoolean;
+ filled: VisConfigBoolean;
+ outline: VisConfigBoolean;
+ thickness: VisConfigNumber;
};
export type HexagonIdLayerVisConfig = {
@@ -78,6 +87,9 @@ export type HexagonIdLayerVisConfig = {
coverageRange: [number, number];
elevationScale: number;
enableElevationZoomFactor: boolean;
+ filled: boolean;
+ outline: boolean;
+ thickness: number;
};
export type HexagonIdLayerVisualChannelConfig = LayerColorConfig &
@@ -104,6 +116,11 @@ export const defaultCoverage = 1;
export const HexagonIdVisConfigs: {
opacity: 'opacity';
colorRange: 'colorRange';
+ filled: VisConfigBoolean;
+ outline: 'outline';
+ strokeColor: 'strokeColor';
+ strokeColorRange: 'strokeColorRange';
+ thickness: 'thickness';
coverage: 'coverage';
enable3d: 'enable3d';
sizeRange: 'elevationRange';
@@ -113,6 +130,14 @@ export const HexagonIdVisConfigs: {
} = {
opacity: 'opacity',
colorRange: 'colorRange',
+ filled: {
+ ...LAYER_VIS_CONFIGS.filled,
+ defaultValue: true
+ },
+ outline: 'outline',
+ strokeColor: 'strokeColor',
+ strokeColorRange: 'strokeColorRange',
+ thickness: 'thickness',
coverage: 'coverage',
enable3d: 'enable3d',
sizeRange: 'elevationRange',
@@ -157,7 +182,20 @@ export default class HexagonIdLayer extends Layer {
return {
color: {
...visualChannels.color,
- accessor: 'getFillColor'
+ accessor: 'getFillColor',
+ condition: config => config.visConfig.filled
+ },
+ strokeColor: {
+ property: 'strokeColor',
+ key: 'strokeColor',
+ field: 'strokeColorField',
+ scale: 'strokeColorScale',
+ domain: 'strokeColorDomain',
+ range: 'strokeColorRange',
+ channelScaleType: CHANNEL_SCALES.color,
+ accessor: 'getLineColor',
+ condition: config => config.visConfig.outline,
+ defaultValue: config => config.visConfig.strokeColor || config.color
},
size: {
...visualChannels.size,
@@ -220,10 +258,21 @@ export default class HexagonIdLayer extends Layer {
}
getDefaultLayerConfig(props: LayerBaseConfigPartial) {
+ const defaultLayerConfig = super.getDefaultLayerConfig(props);
+
return {
- ...super.getDefaultLayerConfig(props),
+ ...defaultLayerConfig,
+
+ // add stroke color visual channel
+ strokeColorField: null,
+ strokeColorDomain: [0, 1],
+ strokeColorScale: 'quantile',
+ colorUI: {
+ ...defaultLayerConfig.colorUI,
+ strokeColorRange: DEFAULT_COLOR_UI
+ },
- // add height visual channel
+ // add radius visual channel
coverageField: null,
coverageDomain: [0, 1],
coverageScale: 'linear'
@@ -316,6 +365,7 @@ export default class HexagonIdLayer extends Layer {
const h3HexagonLayerTriggers = {
getHexagon: this.config.columns,
getFillColor: updateTriggers.getFillColor,
+ getLineColor: updateTriggers.getLineColor,
getElevation: updateTriggers.getElevation,
getFilterValue: gpuFilter.filterValueUpdateTriggers
};
@@ -350,6 +400,10 @@ export default class HexagonIdLayer extends Layer {
extensions,
wrapLongitude: false,
+ filled: visConfig.filled,
+ stroked: visConfig.outline,
+ lineWidthScale: visConfig.thickness,
+
getHexagon: (x: any) => x.id,
// coverage
diff --git a/test/browser/layer-tests/h3-hexagon-layer-specs.js b/test/browser/layer-tests/h3-hexagon-layer-specs.js
index 1e78c09ef..abd19f1ee 100644
--- a/test/browser/layer-tests/h3-hexagon-layer-specs.js
+++ b/test/browser/layer-tests/h3-hexagon-layer-specs.js
@@ -103,6 +103,7 @@ test('#H3Layer -> formatLayerData', t => {
getElevation: () => {},
getFilterValue: () => {},
getFillColor: () => {},
+ getLineColor: () => {},
getHexId: () => {},
getCoverage: () => {},
getPosition: () => {},
@@ -120,6 +121,8 @@ test('#H3Layer -> formatLayerData', t => {
);
// getFillColor
t.deepEqual(layerData.getFillColor, [2, 3, 4], 'getFillColor should be a constant');
+ // getLineColor
+ t.deepEqual(layerData.getLineColor, [2, 3, 4], 'getLineColor should be a constant');
// getElevation
t.deepEqual(layerData.getElevation, defaultElevation, 'getElevation should be a constant');
// getHexId
@@ -143,18 +146,23 @@ test('#H3Layer -> formatLayerData', t => {
}
},
{
- name: 'H3 layer format data. with colorField and sizeField',
+ name: 'H3 layer format data. with colorField, strokeColorField, and sizeField',
layer: {
config: {
dataId,
label: 'h3.2',
columns,
color: [10, 10, 10],
- // color by types(string)
+ // fill color by types(string)
colorField: {
type: 'string',
name: 'types'
},
+ // stroke color by types(string)
+ strokeColorField: {
+ type: 'string',
+ name: 'types'
+ },
// size by id(integer)
sizeField: {
type: 'real',
@@ -164,6 +172,9 @@ test('#H3Layer -> formatLayerData', t => {
colorRange: {
colors: ['#010101', '#020202', '#030303']
},
+ strokeColorRange: {
+ colors: ['#010101', '#020202', '#030303']
+ },
elevationRange: [10, 20],
enable3d: true
}
@@ -188,6 +199,16 @@ test('#H3Layer -> formatLayerData', t => {
],
'getFillColor should be correct'
);
+
+ t.deepEqual(
+ layerData.data.map(layerData.getLineColor),
+ [
+ [2, 2, 2],
+ [1, 1, 1]
+ ],
+ 'getLineColor should be correct'
+ );
+
// getElevation
// domain: [1.59, 11]
// range: [0, 500]
@@ -258,7 +279,9 @@ test('#H3Layer -> renderLayer', t => {
autoHighlight: false,
highlightColor: [255, 255, 255, 60],
extruded: false,
- elevationScale: 5
+ elevationScale: 5,
+ filled: true,
+ stroked: false
};
Object.keys(expectedProps).forEach(key => {
t.deepEqual(props[key], expectedProps[key], `should have correct props.${key}`);
diff --git a/test/fixtures/test-hex-id-data.js b/test/fixtures/test-hex-id-data.js
index e500309e4..f06ef5afc 100644
--- a/test/fixtures/test-hex-id-data.js
+++ b/test/fixtures/test-hex-id-data.js
@@ -89,6 +89,7 @@ export const hexIdDataConfig = {
colors: ['#5A1846', '#900C3F', '#C70039', '#E3611C', '#F1920E', '#FFC300']
},
coverage: 1,
+ enable3d: false,
sizeRange: [0, 500],
coverageRange: [0, 1],
elevationScale: 5,
@@ -114,7 +115,10 @@ export const hexIdDataConfig = {
sizeField: null,
sizeScale: 'linear',
coverageField: null,
- coverageScale: 'linear'
+ coverageScale: 'linear',
+ strokeColorDomain: [0, 1],
+ strokeColorField: 'something',
+ strokeColorScale: 'something'
}
}
],
@@ -371,6 +375,9 @@ mergedH3Layer.config = {
coverageField: null,
coverageScale: 'linear',
coverageDomain: [0, 1],
+ strokeColorDomain: [0, 1],
+ strokeColorField: null,
+ strokeColorScale: 'quantile',
visConfig: {
opacity: 0.8,
colorRange: {
@@ -379,12 +386,22 @@ mergedH3Layer.config = {
category: 'Uber',
colors: ['#5A1846', '#900C3F', '#C70039', '#E3611C', '#F1920E', '#FFC300']
},
+ filled: true,
+ outline: false,
+ strokeColor: null,
+ strokeColorRange: {
+ name: 'Global Warming',
+ type: 'sequential',
+ category: 'Uber',
+ colors: ['#5A1846', '#900C3F', '#C70039', '#E3611C', '#F1920E', '#FFC300']
+ },
+ thickness: 2,
coverage: 1,
sizeRange: [0, 500],
coverageRange: [0, 1],
+ enable3d: false,
elevationScale: 5,
- enableElevationZoomFactor: true,
- enable3d: false
+ enableElevationZoomFactor: true
},
textLabel: [
{
@@ -398,7 +415,8 @@ mergedH3Layer.config = {
],
colorUI: {
color: DEFAULT_COLOR_UI,
- colorRange: DEFAULT_COLOR_UI
+ colorRange: DEFAULT_COLOR_UI,
+ strokeColorRange: DEFAULT_COLOR_UI
},
animation: {
enabled: false