Skip to content

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

[Chore]: Technical: Translate layer factory (#1748)

Maksim Suslovd9e9d8aa68d0
diff --git a/babel.config.js b/babel.config.js
index 233846061..33ed507e1 100644
--- a/babel.config.js
+++ b/babel.config.js
@@ -22,6 +22,7 @@ const KeplerPackage = require('./package');
const PRESETS = ['@babel/preset-env', '@babel/preset-react', '@babel/preset-typescript'];
const PLUGINS = [
+ ['@babel/plugin-transform-typescript', {isTSX: true, allowDeclareFields: true}],
'@babel/plugin-transform-modules-commonjs',
'@babel/plugin-proposal-class-properties',
'@babel/plugin-proposal-export-namespace-from',
diff --git a/package.json b/package.json
index dd0ea7a17..1d4a3e0c1 100644
--- a/package.json
+++ b/package.json
@@ -192,6 +192,7 @@
"@babel/plugin-proposal-optional-chaining": "^7.12.1",
"@babel/plugin-transform-modules-commonjs": "^7.12.1",
"@babel/plugin-transform-runtime": "^7.12.1",
+ "@babel/plugin-transform-typescript": "^7.16.8",
"@babel/polyfill": "^7.12.1",
"@babel/preset-env": "^7.12.1",
"@babel/preset-react": "^7.12.1",
diff --git a/src/constants/color-ranges.ts b/src/constants/color-ranges.ts
index 2ea4e15d2..eaa5f0252 100644
--- a/src/constants/color-ranges.ts
+++ b/src/constants/color-ranges.ts
@@ -22,6 +22,20 @@ import colorbrewer from 'colorbrewer';
import {HexColor} from 'reducers';
import {VizColorPalette} from './custom-color-ranges';
+export type ColorMap = [string | number | null, HexColor][];
+// Key is HexColor but as key we can use only string
+export type ColorLegends = {[key: string]: string};
+
+export type ColorRange = {
+ name: string;
+ type: string;
+ category: string;
+ colors: HexColor[];
+ reversed?: boolean;
+ colorMap?: ColorMap;
+ colorLegends?: ColorLegends;
+};
+
// Add colorbrewer color schemes (Data Science requirement)
// See http://colorbrewer2.org/
@@ -39,7 +53,7 @@ const colorBrewerMap = Object.entries(colorbrewer.schemeGroups).reduce(
{}
);
-const colorRanges = [...VizColorPalette];
+const colorRanges: ColorRange[] = [...VizColorPalette];
for (const [keyName, colorScheme] of Object.entries(colorbrewer)) {
if (keyName !== 'schemeGroups') {
diff --git a/src/layers/base-layer.ts b/src/layers/base-layer.ts
index 5678c6b24..094fc7c98 100644
--- a/src/layers/base-layer.ts
+++ b/src/layers/base-layer.ts
@@ -37,7 +37,7 @@ import {
CHANNEL_SCALE_SUPPORTED_FIELDS,
MAX_GPU_FILTERS
} from 'constants/default-settings';
-import {COLOR_RANGES} from 'constants/color-ranges';
+import {ColorRange, COLOR_RANGES} from 'constants/color-ranges';
import {DataVizColors} from 'constants/custom-color-ranges';
import {
LAYER_VIS_CONFIGS,
@@ -47,7 +47,7 @@ import {
DEFAULT_HIGHLIGHT_COLOR,
DEFAULT_LAYER_LABEL,
LayerVisConfig,
- ColorRange
+ LayerVisConfigSettings
} from './layer-factory';
import {generateHashId, isPlainObject} from 'utils/utils';
@@ -57,14 +57,12 @@ import {getSampleData} from 'utils/table-utils/data-container-utils';
import {hexToRgb, getColorGroupByName, reverseColorRange} from 'utils/color-utils';
-import {RGBColor, RGBAColor, MapState, Filter, Datasets} from 'reducers';
+import {RGBColor, RGBAColor, MapState, Filter, Datasets, ValueOf} from 'reducers';
import {LayerTextLabel, ColorUI} from './layer-factory';
import {KeplerTable} from 'utils';
import {DataContainerInterface} from 'utils/table-utils/data-container-interface';
import {Field, GpuFilter} from 'utils/table-utils/kepler-table';
-export {LAYER_VIS_CONFIGS} from './layer-factory';
-
export type LayerColumn = {value: string | null; fieldIdx: number; optional?: boolean};
export type LayerColumns = {
@@ -178,13 +176,14 @@ function* generateColor(): Generator<RGBColor> {
export const colorMaker = generateColor();
-class Layer<LayerConfig extends LayerBaseConfig = LayerBaseConfig> {
+class Layer {
id: string;
// TODO: define meta
meta: {};
- // TODO: define visConfigSettings
- visConfigSettings: {};
- config: LayerConfig;
+ visConfigSettings: {
+ [key: string]: ValueOf<LayerVisConfigSettings>;
+ };
+ config: LayerBaseConfig;
// TODO: define _oldDataUpdateTriggers
_oldDataUpdateTriggers: any;
@@ -201,7 +200,6 @@ class Layer<LayerConfig extends LayerBaseConfig = LayerBaseConfig> {
// visConfigSettings
this.visConfigSettings = {};
- // @ts-expect-error
this.config = this.getDefaultLayerConfig({
columns: this.getLayerColumns(),
...props
@@ -404,7 +402,9 @@ class Layer<LayerConfig extends LayerBaseConfig = LayerBaseConfig> {
return hexToRgb(c);
}
- getDefaultLayerConfig(props: Partial<LayerBaseConfig> = {}): LayerBaseConfig {
+ getDefaultLayerConfig(
+ props: Partial<LayerBaseConfig> = {}
+ ): LayerBaseConfig & LayerColorConfig & LayerHeightConfig & LayerSizeConfig {
return {
dataId: props.dataId || null,
label: props.label || DEFAULT_LAYER_LABEL,
@@ -445,9 +445,10 @@ class Layer<LayerConfig extends LayerBaseConfig = LayerBaseConfig> {
* @returns
*/
getVisualChannelDescription(key: string): VisualChannelDescription {
+ const label = this.visConfigSettings[this.visualChannels[key].range].label;
// e.g. label: Color, measure: Vehicle Type
return {
- label: this.visConfigSettings[this.visualChannels[key].range].label,
+ label: typeof label === 'function' ? label(this.config) : label,
measure: this.config[this.visualChannels[key].field]
? this.config[this.visualChannels[key].field].displayName ||
this.config[this.visualChannels[key].field].name
@@ -623,10 +624,14 @@ class Layer<LayerConfig extends LayerBaseConfig = LayerBaseConfig> {
}
registerVisConfig(
- layerVisConfigs: Partial<LayerVisConfig> | {[key in keyof Partial<LayerVisConfig>]: string}
+ layerVisConfigs: {
+ [key in keyof Partial<LayerVisConfig>]:
+ | keyof LayerVisConfigSettings
+ | ValueOf<LayerVisConfigSettings>;
+ }
) {
Object.keys(layerVisConfigs).forEach(item => {
- if (typeof item === 'string' && LAYER_VIS_CONFIGS[layerVisConfigs[item]]) {
+ if (typeof layerVisConfigs[item] === 'string' && LAYER_VIS_CONFIGS[layerVisConfigs[item]]) {
// if assigned one of default LAYER_CONFIGS
this.config.visConfig[item] = LAYER_VIS_CONFIGS[layerVisConfigs[item]].defaultValue;
this.visConfigSettings[item] = LAYER_VIS_CONFIGS[layerVisConfigs[item]];
diff --git a/src/layers/layer-factory.d.ts b/src/layers/layer-factory.d.ts
deleted file mode 100644
index d035a01e0..000000000
--- a/src/layers/layer-factory.d.ts
+++ /dev/null
@@ -1,149 +0,0 @@
-import {RGBColor, RGBAColor, HexColor, Field} from 'reducers';
-
-export type ColorRange = {
- name: string;
- type: string;
- category: string;
- colors: HexColor[];
- reversed?: boolean;
- colorMap?: Map | object;
-};
-
-export type LayerTextLabel = {
- field: Field | null;
- color: RGBColor;
- size: number;
- offset: [number, number];
- anchor: string;
- alignment: string;
-};
-
-export type ColorUI = {
- // customPalette in edit
- customPalette: ColorRange;
- // show color sketcher modal
- showSketcher: boolean;
- // show color range selection panel
- showDropdown: boolean;
- // color range selector config
- colorRangeConfig: {
- type: string;
- steps: number;
- reversed: boolean;
- custom: boolean;
- };
-};
-
-export type VisConfig = {
- label: string | ((config: LayerConfig) => string);
- group: string;
- property: string;
- description?: string;
- condition?: (config: LayerConfig) => boolean;
-};
-
-export type VisConfigNumber = VisConfig & {
- type: 'number';
- isRanged: false;
- defaultValue: number;
- range: [number, number];
- step: number;
-};
-
-export type VisConfigBoolean = VisConfig & {
- type: 'boolean';
- defaultValue: boolean;
-};
-
-export type VisConfigSelection = VisConfig & {
- type: 'select';
- defaultValue: string;
- options: string[];
-};
-
-export type VisConfigRange = VisConfig & {
- type: 'number';
- isRanged: boolean;
- range: [number, number];
- defaultValue: [number, number];
- step: number;
-};
-
-export type VisConfigColorSelect = VisConfig & {
- type: 'color-select';
- defaultValue: null;
-};
-
-export type VisConfigColorRange = VisConfig & {
- type: 'color-range-select';
- defaultValue: ColorRange;
-};
-
-export type LayerVisConfig = {
- thickness: VisConfigNumber;
- strokeWidthRange: VisConfigRange;
- trailLength: VisConfigNumber;
- radius: VisConfigNumber;
- fixedRadius: VisConfigBoolean;
- radiusRange: VisConfigRange;
- clusterRadius: VisConfigNumber;
- clusterRadiusRange: VisConfigRange;
- opacity: VisConfigNumber;
- coverage: VisConfigNumber;
- outline: VisConfigBoolean;
- colorRange: VisConfigColorRange;
- strokeColorRange: VisConfigColorRange;
- targetColor: VisConfigColorSelect;
- strokeColor: VisConfigColorSelect;
- aggregation: VisConfigSelect;
- sizeAggregation: VisConfigSelect;
- percentile: VisConfigRange;
- elevationPercentile: VisConfigRange;
- resolution: VisConfigNumber;
- sizeScale: VisConfigNumber;
- angle: VisConfigNumber;
- worldUnitSize: VisConfigNumber;
- elevationScale: VisConfigNumber;
- enableElevationZoomFactor: VisConfigBoolean;
- elevationRange: VisConfigRange;
- heightRange: VisConfigRange;
- coverageRange: VisConfigRange;
- 'hi-precision': VisConfigBoolean;
- enable3d: VisConfigBoolean;
- stroked: VisConfigBoolean;
- filled: VisConfigBoolean;
- extruded: VisConfigBoolean;
- wireframe: VisConfigBoolean;
- weight: VisConfigNumber;
- heatmapRadius: VisConfigNumber;
-};
-
-export type TextConfigSelect = {
- type: 'select';
- options: string[];
- multiSelect: boolean;
- searchable: boolean;
-};
-export type TextConfigNumber = {
- type: 'number';
- range: number[];
- value0: number;
- step: number;
- isRanged: boolean;
- label: string;
- showInput: boolean;
-};
-export type LayerTextConfig = {
- fontSize: TextConfigNumber;
- textAnchor: TextConfigSelect;
- textAlignment: TextConfigSelect;
-};
-
-export const DEFAULT_TEXT_LABEL: LayerTextLabel;
-export const DEFAULT_CUSTOM_PALETTE: ColorRange;
-export const DEFAULT_COLOR_UI: ColorUI;
-export const DEFAULT_HIGHLIGHT_COLOR: RGBAColor;
-export const DEFAULT_LAYER_LABEL: string;
-export const LAYER_VIS_CONFIGS: LayerVisConfig;
-export const LAYER_TEXT_CONFIGS: LayerTextConfig;
-export const UNKNOWN_COLOR_KEY: string;
diff --git a/src/layers/layer-factory.js b/src/layers/layer-factory.ts
similarity index 67%
rename from src/layers/layer-factory.js
rename to src/layers/layer-factory.ts
index e71bd17d8..8890c47d0 100644
--- a/src/layers/layer-factory.js
+++ b/src/layers/layer-factory.ts
@@ -20,8 +20,200 @@
import keyMirror from 'keymirror';
-import {AGGREGATION_TYPES} from 'constants/default-settings';
-import {DEFAULT_COLOR_RANGE} from 'constants/color-ranges';
+import {AGGREGATION_TYPES} from '../constants/default-settings';
+import {ColorRange, DEFAULT_COLOR_RANGE} from '../constants/color-ranges';
+
+import {RGBColor, RGBAColor} from '../reducers';
+import {Field} from '../utils/table-utils/kepler-table';
+import {
+ LayerBaseConfig,
+ LayerColorConfig,
+ LayerHeightConfig,
+ LayerSizeConfig,
+ LayerWeightConfig
+} from './base-layer';
+
+export type LayerTextLabel = {
+ field: Field | null;
+ color: RGBColor;
+ size: number;
+ offset: [number, number];
+ anchor: string;
+ alignment: string;
+};
+
+export type ColorUI = {
+ // customPalette in edit
+ customPalette: ColorRange;
+ // show color sketcher modal
+ showSketcher: boolean;
+ // show color range selection panel
+ showDropdown: boolean;
+ // color range selector config
+ colorRangeConfig: {
+ type: string;
+ steps: number;
+ reversed: boolean;
+ custom: boolean;
+ };
+};
+
+export type VisConfig = {
+ label:
+ | string
+ | ((
+ config: LayerBaseConfig &
+ Partial<LayerColorConfig> &
+ Partial<LayerHeightConfig> &
+ Partial<LayerSizeConfig> &
+ Partial<LayerWeightConfig>
+ ) => string);
+ group: keyof typeof PROPERTY_GROUPS;
+ property: string;
+ description?: string;
+ condition?: (
+ config: LayerBaseConfig &
+ Partial<LayerColorConfig> &
+ Partial<LayerHeightConfig> &
+ Partial<LayerSizeConfig> &
+ Partial<LayerWeightConfig>
+ ) => boolean;
+
+ allowCustomValue?: boolean;
+};
+
+export type VisConfigNumber = VisConfig & {
+ type: 'number';
+ isRanged: false;
+ defaultValue: number;
+ range: [number, number];
+ step: number;
+};
+
+export type VisConfigBoolean = VisConfig & {
+ type: 'boolean';
+ defaultValue: boolean;
+};
+
+export type VisConfigSelection = VisConfig & {
+ type: 'select';
+ defaultValue: string;
+ options: string[];
+};
+
+export type VisConfigRange = VisConfig & {
+ type: 'number';
+ isRanged: boolean;
+ range: [number, number];
+ defaultValue: [number, number];
+ step: number;
+};
+
+export type VisConfigColorSelect = VisConfig & {
+ type: 'color-select';
+ defaultValue: null;
+};
+
+export type VisConfigColorRange = VisConfig & {
+ type: 'color-range-select';
+ defaultValue: ColorRange;
+};
+
+export type LayerVisConfigSettings = {
+ thickness: VisConfigNumber;
+ strokeWidthRange: VisConfigRange;
+ trailLength: VisConfigNumber;
+ radius: VisConfigNumber;
+ fixedRadius: VisConfigBoolean;
+ radiusRange: VisConfigRange;
+ clusterRadius: VisConfigNumber;
+ clusterRadiusRange: VisConfigRange;
+ opacity: VisConfigNumber;
+ coverage: VisConfigNumber;
+ outline: VisConfigBoolean;
+ colorRange: VisConfigColorRange;
+ strokeColorRange: VisConfigColorRange;
+ targetColor: VisConfigColorSelect;
+ strokeColor: VisConfigColorSelect;
+ colorAggregation: VisConfigSelection;
+ sizeAggregation: VisConfigSelection;
+ percentile: VisConfigRange;
+ elevationPercentile: VisConfigRange;
+ resolution: VisConfigNumber;
+ sizeScale: VisConfigNumber;
+ angle: VisConfigNumber;
+ worldUnitSize: VisConfigNumber;
+ elevationScale: VisConfigNumber;
+ enableElevationZoomFactor: VisConfigBoolean;
+ elevationRange: VisConfigRange;
+ heightRange: VisConfigRange;
+ coverageRange: VisConfigRange;
+ 'hi-precision': VisConfigBoolean;
+ enable3d: VisConfigBoolean;
+ stroked: VisConfigBoolean;
+ filled: VisConfigBoolean;
+ extruded: VisConfigBoolean;
+ wireframe: VisConfigBoolean;
+ weight: VisConfigNumber;
+ heatmapRadius: VisConfigNumber;
+};
+// TODO: This type is not coplete yet
+export type LayerVisConfig = {
+ thickness: number;
+ sizeRange: number;
+ trailLength: number;
+ radius: number;
+ fixedRadius: boolean;
+ radiusRange: [number, number];
+ clusterRadius: number;
+ opacity: number;
+ coverage: number;
+ outline: boolean;
+ colorRange: ColorRange;
+ strokeColorRange: ColorRange;
+ targetColor: any;
+ strokeColor: any;
+ colorAggregation: keyof typeof AGGREGATION_TYPES;
+ sizeAggregation: keyof typeof AGGREGATION_TYPES;
+ percentile: [number, number];
+ elevationPercentile: [number, number];
+ resolution: number;
+ sizeScale: number;
+ angle: number;
+ worldUnitSize: number;
+ elevationScale: number;
+ enableElevationZoomFactor: boolean;
+ heightRange: [number, number];
+ coverageRange: [number, number];
+ 'hi-precision': boolean;
+ enable3d: boolean;
+ stroked: boolean;
+ filled: boolean;
+ extruded: boolean;
+ wireframe: boolean;
+ weight: number;
+};
+
+export type TextConfigSelect = {
+ type: 'select';
+ options: string[];
+ multiSelect: boolean;
+ searchable: boolean;
+};
+export type TextConfigNumber = {
+ type: 'number';
+ range: number[];
+ value0: number;
+ step: number;
+ isRanged: boolean;
+ label: string;
+ showInput: boolean;
+};
+export type LayerTextConfig = {
+ fontSize: TextConfigNumber;
+ textAnchor: TextConfigSelect;
+ textAlignment: TextConfigSelect;
+};
export const PROPERTY_GROUPS = keyMirror({
color: null,
@@ -31,16 +223,16 @@ export const PROPERTY_GROUPS = keyMirror({
angle: null,
// for heatmap aggregation
cell: null,
- precision: null
+ precision: null,
+ display: null
});
export const DEFAULT_LAYER_OPACITY = 0.8;
-export const DEFAULT_HIGHLIGHT_COLOR = [252, 242, 26, 255];
+export const DEFAULT_HIGHLIGHT_COLOR: RGBAColor = [252, 242, 26, 255];
export const DEFAULT_LAYER_LABEL = 'new layer';
export {DEFAULT_COLOR_RANGE};
-/** @type {import('./layer-factory').LayerTextLabel} */
-export const DEFAULT_TEXT_LABEL = {
+export const DEFAULT_TEXT_LABEL: LayerTextLabel = {
field: null,
color: [255, 255, 255],
size: 18,
@@ -49,8 +241,7 @@ export const DEFAULT_TEXT_LABEL = {
alignment: 'center'
};
-/** @type {import('./layer-factory').ColorRange} */
-export const DEFAULT_CUSTOM_PALETTE = {
+export const DEFAULT_CUSTOM_PALETTE: ColorRange = {
name: 'color.customPalette',
type: 'custom',
category: 'Custom',
@@ -59,8 +250,7 @@ export const DEFAULT_CUSTOM_PALETTE = {
export const UNKNOWN_COLOR_KEY = '__unknownColor__';
-/** @type {import('./layer-factory').ColorUI} */
-export const DEFAULT_COLOR_UI = {
+export const DEFAULT_COLOR_UI: ColorUI = {
// customPalette in edit
customPalette: DEFAULT_CUSTOM_PALETTE,
// show color sketcher modal
@@ -76,8 +266,7 @@ export const DEFAULT_COLOR_UI = {
}
};
-/** @type {import('./layer-factory').LayerVisConfig} */
-export const LAYER_VIS_CONFIGS = {
+export const LAYER_VIS_CONFIGS: LayerVisConfigSettings = {
thickness: {
type: 'number',
defaultValue: 2,
@@ -222,7 +411,7 @@ export const LAYER_VIS_CONFIGS = {
group: PROPERTY_GROUPS.color,
property: 'strokeColor'
},
- aggregation: {
+ colorAggregation: {
type: 'select',
defaultValue: AGGREGATION_TYPES.average,
label: 'layerVisConfigs.colorAggregation',
@@ -230,7 +419,7 @@ export const LAYER_VIS_CONFIGS = {
options: Object.keys(AGGREGATION_TYPES),
group: PROPERTY_GROUPS.color,
property: 'colorAggregation',
- condition: config => config.colorField
+ condition: config => Boolean(config.colorField)
},
sizeAggregation: {
type: 'select',
@@ -240,7 +429,7 @@ export const LAYER_VIS_CONFIGS = {
options: Object.keys(AGGREGATION_TYPES),
group: PROPERTY_GROUPS.height,
property: 'sizeAggregation',
- condition: config => config.sizeField
+ condition: config => Boolean(config.sizeField)
},
percentile: {
type: 'number',
@@ -274,7 +463,8 @@ export const LAYER_VIS_CONFIGS = {
group: PROPERTY_GROUPS.height,
property: 'elevationPercentile',
// percentile filter only makes sense with linear aggregation
- condition: config => config.visConfig.enable3d && (config.colorField || config.sizeField),
+ condition: config =>
+ Boolean(config.visConfig.enable3d && (config.colorField || config.sizeField)),
allowCustomValue: false
},
resolution: {
@@ -428,7 +618,7 @@ export const LAYER_VIS_CONFIGS = {
step: 0.01,
group: PROPERTY_GROUPS.cell,
property: 'weight',
- condition: config => config.weightField,
+ condition: config => Boolean(config.weightField),
allowCustomValue: true
},
heatmapRadius: {
@@ -444,8 +634,7 @@ export const LAYER_VIS_CONFIGS = {
}
};
-/** @type {import('./layer-factory').LayerTextConfig} */
-export const LAYER_TEXT_CONFIGS = {
+export const LAYER_TEXT_CONFIGS: LayerTextConfig = {
fontSize: {
type: 'number',
range: [1, 100],
diff --git a/src/utils/color-utils.ts b/src/utils/color-utils.ts
index df0bf4cf8..0d2d123de 100644
--- a/src/utils/color-utils.ts
+++ b/src/utils/color-utils.ts
@@ -18,7 +18,7 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
-import {ColorRange} from 'layers/layer-factory';
+import {ColorRange} from 'constants/color-ranges';
import {HexColor, RGBColor} from 'reducers';
/**
diff --git a/yarn.lock b/yarn.lock
index 5cb583450..389c51c69 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -1756,7 +1756,7 @@
dependencies:
"@babel/helper-plugin-utils" "^7.12.13"
-"@babel/plugin-transform-typescript@^7.16.7":
+"@babel/plugin-transform-typescript@^7.16.7", "@babel/plugin-transform-typescript@^7.16.8":
version "7.16.8"
resolved "https://registry.yarnpkg.com/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.16.8.tgz#591ce9b6b83504903fa9dd3652c357c2ba7a1ee0"
integrity sha512-bHdQ9k7YpBDO2d0NVfkj51DpQcvwIzIusJ7mEUaMlbZq3Kt/U47j24inXZHQ5MDiYpCs+oZiwnXyKedE8+q7AQ==