Skip to content

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

[Chore]: Technical: Translate h3-hexagon-layer (#1762)

Maksim Suslov079da4ccb027
diff --git a/src/layers/base-layer.ts b/src/layers/base-layer.ts
index abacd8769..81597da15 100644
--- a/src/layers/base-layer.ts
+++ b/src/layers/base-layer.ts
@@ -116,6 +116,11 @@ export type LayerStrokeColorConfig = {
strokeColorDomain: VisualChannelDomain;
strokeColorScale: VisualChannelScale;
};
+export type LayerCoverageConfig = {
+ coverageField: VisualChannelField;
+ coverageDomain: VisualChannelDomain;
+ coverageScale: VisualChannelScale;
+};
export type LayerWeightConfig = {
weightField: VisualChannelField;
};
@@ -153,6 +158,12 @@ export type ColumnPairs = {[key: string]: {pair: string; fieldPairKey: string}};
type ColumnValidator = (column: LayerColumn, columns: LayerColumns, allFields: Field[]) => boolean;
+export type UpdateTriggers = {
+ [key: string]: UpdateTrigger;
+};
+export type UpdateTrigger = {
+ [key: string]: {};
+};
export type LayerBounds = [number, number, number, number];
/**
* Approx. number of points to sample in a large data set
@@ -673,7 +684,9 @@ class Layer {
return {...required, ...optional};
}
- updateLayerConfig(newConfig: Partial<LayerBaseConfig>): Layer {
+ updateLayerConfig<LayerConfig extends LayerBaseConfig = LayerBaseConfig>(
+ newConfig: Partial<LayerConfig>
+ ): Layer {
this.config = {...this.config, ...newConfig};
return this;
}
@@ -1158,8 +1171,8 @@ class Layer {
this.updateLayerConfig({[visualChannel.domain]: updatedDomain});
}
- getVisualChannelUpdateTriggers() {
- const updateTriggers = {};
+ getVisualChannelUpdateTriggers(): UpdateTriggers {
+ const updateTriggers: UpdateTriggers = {};
Object.values(this.visualChannels).forEach(visualChannel => {
// field range scale domain
const {accessor, field, scale, domain, range, defaultValue, fixed} = visualChannel;
@@ -1192,7 +1205,7 @@ class Layer {
return dataset.getColumnLayerDomain(field, scaleType) || defaultDomain;
}
- hasHoveredObject(objectInfo): boolean {
+ hasHoveredObject(objectInfo) {
return this.isLayerHovered(objectInfo) && objectInfo.object ? objectInfo.object : null;
}
diff --git a/src/layers/h3-hexagon-layer/h3-hexagon-layer-icon.js b/src/layers/h3-hexagon-layer/h3-hexagon-layer-icon.tsx
similarity index 100%
rename from src/layers/h3-hexagon-layer/h3-hexagon-layer-icon.js
rename to src/layers/h3-hexagon-layer/h3-hexagon-layer-icon.tsx
diff --git a/src/layers/h3-hexagon-layer/h3-hexagon-layer.js b/src/layers/h3-hexagon-layer/h3-hexagon-layer.ts
similarity index 79%
rename from src/layers/h3-hexagon-layer/h3-hexagon-layer.js
rename to src/layers/h3-hexagon-layer/h3-hexagon-layer.ts
index 9a98adf87..b6818a360 100644
--- a/src/layers/h3-hexagon-layer/h3-hexagon-layer.js
+++ b/src/layers/h3-hexagon-layer/h3-hexagon-layer.ts
@@ -18,21 +18,75 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
-import Layer from '../base-layer';
+import Layer, {
+ LayerBaseConfig,
+ LayerColorConfig,
+ LayerColumn,
+ LayerColumns,
+ LayerCoverageConfig,
+ LayerSizeConfig
+} from '../base-layer';
import {findDefaultColorField} from 'utils/dataset-utils';
import {GeoJsonLayer} from '@deck.gl/layers';
import {H3HexagonLayer} from '@deck.gl/geo-layers';
import EnhancedColumnLayer from 'deckgl-layers/column-layer/enhanced-column-layer';
-import {getCentroid, idToPolygonGeo, h3IsValid, getHexFields} from './h3-utils';
+import {getCentroid, idToPolygonGeo, h3IsValid, getHexFields, Centroid} from './h3-utils';
import H3HexagonLayerIcon from './h3-hexagon-layer-icon';
import {CHANNEL_SCALES, HIGHLIGH_COLOR_3D} from 'constants/default-settings';
import {createDataContainer} from 'utils/table-utils';
+import {
+ LayerVisConfigSettings,
+ VisConfigBoolean,
+ VisConfigColorRange,
+ VisConfigNumber,
+ VisConfigRange
+} from '../layer-factory';
+import {Merge} from '../../reducers';
+import {DataContainerInterface} from '../../utils/table-utils/data-container-interface';
+import {ColorRange} from '../../constants/color-ranges';
+
+export type HexagonIdLayerColumnsConfig = {
+ hex_id: LayerColumn;
+};
+
+export type HexagonIdLayerVisConfigSettings = {
+ opacity: VisConfigNumber;
+ colorRange: VisConfigColorRange;
+ coverage: VisConfigNumber;
+ enable3d: VisConfigBoolean;
+ sizeRange: VisConfigRange;
+ coverageRange: VisConfigRange;
+ elevationScale: VisConfigNumber;
+ enableElevationZoomFactor: VisConfigBoolean;
+};
+
+export type HexagonIdLayerVisConfig = {
+ opacity: number;
+ colorRange: ColorRange;
+ coverage: number;
+ enable3d: boolean;
+ sizeRange: [number, number];
+ coverageRange: [number, number];
+ elevationScale: number;
+ enableElevationZoomFactor: boolean;
+};
+
+export type HexagonIdLayerVisualChannelConfig = LayerColorConfig &
+ LayerSizeConfig &
+ LayerCoverageConfig;
+export type HexagonIdLayerConfig = Merge<
+ LayerBaseConfig,
+ {columns: HexagonIdLayerColumnsConfig; visConfig: HexagonIdLayerVisConfig}
+> &
+ HexagonIdLayerVisualChannelConfig;
const DEFAULT_LINE_SCALE_VALUE = 8;
-export const hexIdRequiredColumns = ['hex_id'];
-export const hexIdAccessor = ({hex_id}) => dc => d => dc.valueAt(d.index, hex_id.fieldIdx);
+export const hexIdRequiredColumns: ['hex_id'] = ['hex_id'];
+export const hexIdAccessor = ({hex_id}: HexagonIdLayerColumnsConfig) => (
+ dc: DataContainerInterface
+) => d => dc.valueAt(d.index, hex_id.fieldIdx);
export const defaultElevation = 500;
export const defaultCoverage = 1;
@@ -49,17 +103,21 @@ export const HexagonIdVisConfigs = {
};
export default class HexagonIdLayer extends Layer {
+ dataToFeature: {centroids: Centroid[]};
+
+ declare config: HexagonIdLayerConfig;
+ declare visConfigSettings: HexagonIdLayerVisConfigSettings;
constructor(props) {
super(props);
this.registerVisConfig(HexagonIdVisConfigs);
this.getPositionAccessor = dataContainer => hexIdAccessor(this.config.columns)(dataContainer);
}
- get type() {
+ get type(): 'hexagonId' {
return 'hexagonId';
}
- get name() {
+ get name(): 'H3' {
return 'H3';
}
@@ -106,7 +164,7 @@ export default class HexagonIdLayer extends Layer {
const defaultColorField = findDefaultColorField(dataset);
if (defaultColorField) {
- this.updateLayerConfig({
+ this.updateLayerConfig<HexagonIdLayerConfig>({
colorField: defaultColorField
});
this.updateLayerVisualChannel(dataset, 'color');
diff --git a/src/layers/h3-hexagon-layer/h3-utils.js b/src/layers/h3-hexagon-layer/h3-utils.ts
similarity index 84%
rename from src/layers/h3-hexagon-layer/h3-utils.js
rename to src/layers/h3-hexagon-layer/h3-utils.ts
index 5584b74b4..36891fd80 100644
--- a/src/layers/h3-hexagon-layer/h3-utils.js
+++ b/src/layers/h3-hexagon-layer/h3-utils.ts
@@ -18,26 +18,28 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
-import {h3GetResolution, h3IsValid, h3ToGeo, h3ToGeoBoundary} from 'h3-js';
+import {h3GetResolution, H3Index, h3IsValid, h3ToGeo, h3ToGeoBoundary} from 'h3-js';
import {ALL_FIELD_TYPES} from 'constants/default-settings';
import {notNullorUndefined} from 'utils/data-utils';
export {h3GetResolution, h3IsValid};
+export type Centroid = [number, number];
+
// get vertices should return [lon, lat]
-export function getVertices({id}) {
+export function getVertices({id}: {id: H3Index}) {
// always reverse it
return h3ToGeoBoundary(id, true);
}
// get centroid should return [lon, lat]
-export function getCentroid({id}) {
+export function getCentroid({id}: {id: H3Index}): Centroid {
// always reverse it to [lng, lat]
- return h3ToGeo(id).reverse();
+ return h3ToGeo(id).reverse() as Centroid;
}
-export function idToPolygonGeo(object, properties) {
- if (!object || !object.id) {
+export function idToPolygonGeo(object?: {id: H3Index}, properties?: any) {
+ if (!object?.id) {
return null;
}