Skip to content

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

[Chore]: Technical: Translate arc-layer (#1749)

Maksim Suslov13ba6bb7a384
diff --git a/src/layers/arc-layer/arc-layer-icon.js b/src/layers/arc-layer/arc-layer-icon.tsx
similarity index 98%
rename from src/layers/arc-layer/arc-layer-icon.js
rename to src/layers/arc-layer/arc-layer-icon.tsx
index bcf142b99..12f158ec6 100644
--- a/src/layers/arc-layer/arc-layer-icon.js
+++ b/src/layers/arc-layer/arc-layer-icon.tsx
@@ -20,7 +20,7 @@
import React, {Component} from 'react';
import PropTypes from 'prop-types';
-import Base from 'components/common/icons/base';
+import Base from '../../components/common/icons/base';
class ArcLayerIcon extends Component {
static propTypes = {
diff --git a/src/layers/arc-layer/arc-layer.js b/src/layers/arc-layer/arc-layer.ts
similarity index 73%
rename from src/layers/arc-layer/arc-layer.js
rename to src/layers/arc-layer/arc-layer.ts
index adba1dc7c..d067d408f 100644
--- a/src/layers/arc-layer/arc-layer.js
+++ b/src/layers/arc-layer/arc-layer.ts
@@ -18,15 +18,72 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
-import Layer from '../base-layer';
+import Layer, {
+ LayerColumn,
+ LayerBaseConfig,
+ LayerColorConfig,
+ LayerSizeConfig,
+ LayerBounds
+} from '../base-layer';
import {BrushingExtension} from '@deck.gl/extensions';
import {ArcLayer as DeckArcLayer} from '@deck.gl/layers';
-import {hexToRgb} from 'utils/color-utils';
+import {hexToRgb} from '../../utils/color-utils';
import ArcLayerIcon from './arc-layer-icon';
-import {DEFAULT_LAYER_COLOR} from 'constants/default-settings';
+import {DEFAULT_LAYER_COLOR} from '../../constants/default-settings';
+import {DataContainerInterface} from '../../utils/table-utils/data-container-interface';
+import {RGBColor, Merge} from '../../reducers';
-export const arcPosAccessor = ({lat0, lng0, lat1, lng1}) => dc => d => [
+import {
+ VisConfigColorRange,
+ VisConfigColorSelect,
+ VisConfigNumber,
+ VisConfigRange
+} from '../layer-factory';
+import {ColorRange} from '../../constants/color-ranges';
+
+export type ArcLayerVisConfigSettings = {
+ opacity: VisConfigNumber;
+ thickness: VisConfigNumber;
+ colorRange: VisConfigColorRange;
+ sizeRange: VisConfigRange;
+ targetColor: VisConfigColorSelect;
+};
+
+export type ArcLayerColumnsConfig = {
+ lat0: LayerColumn;
+ lat1: LayerColumn;
+ lng0: LayerColumn;
+ lng1: LayerColumn;
+};
+
+export type ArcLayerVisConfig = {
+ colorRange: ColorRange;
+ opacity: number;
+ sizeRange: [number, number];
+ targetColor: RGBColor;
+ thickness: number;
+};
+
+export type ArcLayerVisualChannelConfig = LayerColorConfig & LayerSizeConfig;
+export type ArcLayerConfig = Merge<
+ LayerBaseConfig,
+ {columns: ArcLayerColumnsConfig; visConfig: ArcLayerVisConfig}
+> &
+ ArcLayerVisualChannelConfig;
+
+export type ArcLayerData = {
+ index: number;
+ sourcePosition: [number, number, number];
+ targetPosition: [number, number, number];
+};
+
+export type ArcLayerMeta = {
+ bounds: LayerBounds;
+};
+export const arcPosAccessor = ({lat0, lng0, lat1, lng1}: ArcLayerColumnsConfig) => (
+ dc: DataContainerInterface
+) => d => [
dc.valueAt(d.index, lng0.fieldIdx),
dc.valueAt(d.index, lat0.fieldIdx),
0,
@@ -52,6 +109,10 @@ export const arcVisConfigs = {
};
export default class ArcLayer extends Layer {
+ declare visConfigSettings: ArcLayerVisConfigSettings;
+ declare config: ArcLayerConfig;
+ declare meta: ArcLayerMeta;
+
constructor(props) {
super(props);
@@ -111,24 +172,23 @@ export default class ArcLayer extends Layer {
return {props: []};
}
- const props = {
- color: hexToRgb(DEFAULT_LAYER_COLOR.tripArc)
- };
-
- // connect the first two point layer with arc
- props.columns = {
- lat0: fieldPairs[0].pair.lat,
- lng0: fieldPairs[0].pair.lng,
- lat1: fieldPairs[1].pair.lat,
- lng1: fieldPairs[1].pair.lng
+ const props: {color: RGBColor; columns: ArcLayerColumnsConfig; label: string} = {
+ color: hexToRgb(DEFAULT_LAYER_COLOR.tripArc),
+ // connect the first two point layer with arc
+ columns: {
+ lat0: fieldPairs[0].pair.lat,
+ lng0: fieldPairs[0].pair.lng,
+ lat1: fieldPairs[1].pair.lat,
+ lng1: fieldPairs[1].pair.lng
+ },
+ label: `${fieldPairs[0].defaultName} -> ${fieldPairs[1].defaultName} arc`
};
- props.label = `${fieldPairs[0].defaultName} -> ${fieldPairs[1].defaultName} arc`;
return {props: [props]};
}
calculateDataAttribute({dataContainer, filteredIndex}, getPosition) {
- const data = [];
+ const data: ArcLayerData[] = [];
for (let i = 0; i < filteredIndex.length; i++) {
const index = filteredIndex[i];
const pos = getPosition({index});
diff --git a/src/layers/base-layer.ts b/src/layers/base-layer.ts
index 094fc7c98..2850afac0 100644
--- a/src/layers/base-layer.ts
+++ b/src/layers/base-layer.ts
@@ -146,6 +146,8 @@ export type VisualChannelDescription = {
export type ColumnPairs = {[key: string]: {pair: string; fieldPairKey: string}};
type ColumnValidator = (column: LayerColumn, columns: LayerColumns, allFields: Field[]) => boolean;
+
+export type LayerBounds = [number, number, number, number];
/**
* Approx. number of points to sample in a large data set
*/
@@ -404,7 +406,7 @@ class Layer {
getDefaultLayerConfig(
props: Partial<LayerBaseConfig> = {}
- ): LayerBaseConfig & LayerColorConfig & LayerHeightConfig & LayerSizeConfig {
+ ): LayerBaseConfig & LayerColorConfig & LayerSizeConfig {
return {
dataId: props.dataId || null,
label: props.label || DEFAULT_LAYER_LABEL,
@@ -426,7 +428,6 @@ class Layer {
sizeScale: SCALE_TYPES.linear,
sizeField: null,
- // @ts-expect-error
visConfig: {},
textLabel: [DEFAULT_TEXT_LABEL],
@@ -623,23 +624,23 @@ class Layer {
return copied;
}
- registerVisConfig(
- layerVisConfigs: {
- [key in keyof Partial<LayerVisConfig>]:
- | keyof LayerVisConfigSettings
- | ValueOf<LayerVisConfigSettings>;
- }
- ) {
+ registerVisConfig(layerVisConfigs: {
+ [key: string]: keyof LayerVisConfigSettings | ValueOf<LayerVisConfigSettings>;
+ }) {
Object.keys(layerVisConfigs).forEach(item => {
- if (typeof layerVisConfigs[item] === 'string' && LAYER_VIS_CONFIGS[layerVisConfigs[item]]) {
+ const configItem = layerVisConfigs[item];
+ if (typeof configItem === 'string' && LAYER_VIS_CONFIGS[configItem]) {
// 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]];
- } else if (['type', 'defaultValue'].every(p => layerVisConfigs[item].hasOwnProperty(p))) {
+ this.config.visConfig[item] = LAYER_VIS_CONFIGS[configItem].defaultValue;
+ this.visConfigSettings[item] = LAYER_VIS_CONFIGS[configItem];
+ } else if (
+ typeof configItem === 'object' &&
+ ['type', 'defaultValue'].every(p => configItem.hasOwnProperty(p))
+ ) {
// if provided customized visConfig, and has type && defaultValue
// TODO: further check if customized visConfig is valid
- this.config.visConfig[item] = layerVisConfigs[item].defaultValue;
- this.visConfigSettings[item] = layerVisConfigs[item];
+ this.config.visConfig[item] = configItem.defaultValue;
+ this.visConfigSettings[item] = configItem;
}
});
}
diff --git a/src/layers/layer-factory.ts b/src/layers/layer-factory.ts
index 8890c47d0..1ec3e5af1 100644
--- a/src/layers/layer-factory.ts
+++ b/src/layers/layer-factory.ts
@@ -157,41 +157,45 @@ export type LayerVisConfigSettings = {
weight: VisConfigNumber;
heatmapRadius: VisConfigNumber;
};
-// TODO: This type is not coplete yet
+
+// TODO: Move this to individual layers
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;
+ [key: string]: any;
+ // possible visConfigs
+
+ // 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 = {