7267963662

Committed 19 Dec 2023 09:50PM UTC coverage: 30.524% (-0.06%) from 30.582%

Build # 7267963662

Build Type

push

github

Committed by

web-flow

Commit Message

[Feat] add polygon filter based on mean centers for GeoJsonLayer (#2476)

Signed-off-by: Xun Li <lixun910@gmail.com>

Run Details

1784 of 10808 branches covered (0.0%)

Branch coverage included in aggregate %.

1 of 21 new or added lines in 4 files covered. (4.76%)

4 existing lines in 2 files now uncovered.

6243 of 15489 relevant lines covered (40.31%)

16.9 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

10.62

/src/layers/src/geojson-layer/geojson-layer.ts

// Copyright (c) 2023 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

import * as arrow from 'apache-arrow';
import {point as turfPoint} from '@turf/helpers';
import booleanWithin from '@turf/boolean-within';
import {Feature, Polygon} from 'geojson';
import uniq from 'lodash.uniq';
import {DATA_TYPES} from 'type-analyzer';
import Layer, {
  colorMaker,
  LayerBaseConfig,
  LayerBaseConfigPartial,
  LayerColorConfig,
  LayerColumn,
  LayerHeightConfig,
  LayerRadiusConfig,
  LayerSizeConfig,
  LayerStrokeColorConfig
} from '../base-layer';
import {GeoJsonLayer as DeckGLGeoJsonLayer} from '@deck.gl/layers';
import {getGeojsonLayerMeta, GeojsonDataMaps, DeckGlGeoTypes} from './geojson-utils';
import {
  getGeojsonLayerMetaFromArrow,
  isLayerHoveredFromArrow,
  getHoveredObjectFromArrow
} from '../layer-utils';
import GeojsonLayerIcon from './geojson-layer-icon';
import {
  GEOJSON_FIELDS,
  HIGHLIGH_COLOR_3D,
  CHANNEL_SCALES,
  ColorRange,
  LAYER_VIS_CONFIGS
} from '@kepler.gl/constants';
import {
  VisConfigNumber,
  VisConfigColorSelect,
  VisConfigColorRange,
  VisConfigRange,
  VisConfigBoolean,
  Merge,
  RGBColor,
  Field
} from '@kepler.gl/types';
import {KeplerTable} from '@kepler.gl/table';
import {DataContainerInterface, ArrowDataContainer} from '@kepler.gl/utils';
import {FilterArrowExtension} from '@kepler.gl/deckgl-layers';

const SUPPORTED_ANALYZER_TYPES = {
  [DATA_TYPES.GEOMETRY]: true,
  [DATA_TYPES.GEOMETRY_FROM_STRING]: true,
  [DATA_TYPES.PAIR_GEOMETRY_FROM_STRING]: true
};

export const geojsonVisConfigs: {
  opacity: 'opacity';
  strokeOpacity: VisConfigNumber;
  thickness: VisConfigNumber;
  strokeColor: 'strokeColor';
  colorRange: 'colorRange';
  strokeColorRange: 'strokeColorRange';
  radius: 'radius';

  sizeRange: 'strokeWidthRange';
  radiusRange: 'radiusRange';
  heightRange: 'elevationRange';
  elevationScale: 'elevationScale';
  enableElevationZoomFactor: 'enableElevationZoomFactor';
  stroked: 'stroked';
  filled: 'filled';
  enable3d: 'enable3d';
  wireframe: 'wireframe';
} = {
  opacity: 'opacity',
  strokeOpacity: {
    ...LAYER_VIS_CONFIGS.opacity,
    property: 'strokeOpacity'
  },
  thickness: {
    ...LAYER_VIS_CONFIGS.thickness,
    defaultValue: 0.5
  },
  strokeColor: 'strokeColor',
  colorRange: 'colorRange',
  strokeColorRange: 'strokeColorRange',
  radius: 'radius',

  sizeRange: 'strokeWidthRange',
  radiusRange: 'radiusRange',
  heightRange: 'elevationRange',
  elevationScale: 'elevationScale',
  enableElevationZoomFactor: 'enableElevationZoomFactor',
  stroked: 'stroked',
  filled: 'filled',
  enable3d: 'enable3d',
  wireframe: 'wireframe'
};

export type GeoJsonVisConfigSettings = {
  opacity: VisConfigNumber;
  strokeOpacity: VisConfigNumber;
  thickness: VisConfigNumber;
  strokeColor: VisConfigColorSelect;
  colorRange: VisConfigColorRange;
  strokeColorRange: VisConfigColorRange;
  radius: VisConfigNumber;

  sizeRange: VisConfigRange;
  radiusRange: VisConfigRange;
  heightRange: VisConfigRange;
  elevationScale: VisConfigNumber;
  enableElevationZoomFactor: VisConfigBoolean;
  stroked: VisConfigBoolean;
  filled: VisConfigBoolean;
  enable3d: VisConfigBoolean;
  wireframe: VisConfigBoolean;
};

export type GeoJsonLayerColumnsConfig = {
  geojson: LayerColumn;
};

export type GeoJsonLayerVisConfig = {
  opacity: number;
  strokeOpacity: number;
  thickness: number;
  strokeColor: RGBColor;
  colorRange: ColorRange;
  strokeColorRange: ColorRange;
  radius: number;

  sizeRange: [number, number];
  radiusRange: [number, number];
  heightRange: [number, number];
  elevationScale: number;
  enableElevationZoomFactor: boolean;
  stroked: boolean;
  filled: boolean;
  enable3d: boolean;
  wireframe: boolean;
};

type GeoJsonLayerVisualChannelConfig = LayerColorConfig &
  LayerStrokeColorConfig &
  LayerSizeConfig &
  LayerHeightConfig &
  LayerRadiusConfig;
export type GeoJsonLayerConfig = Merge<
  LayerBaseConfig,
  {columns: GeoJsonLayerColumnsConfig; visConfig: GeoJsonLayerVisConfig}
> &
  GeoJsonLayerVisualChannelConfig;

export type GeoJsonLayerMeta = {
  featureTypes?: DeckGlGeoTypes;
  fixedRadius?: boolean;
};

export const geoJsonRequiredColumns: ['geojson'] = ['geojson'];

type ObjectInfo = {
  index: number;
  object?: Feature | undefined;
  picked: boolean;
  layer: Layer;
  radius?: number;
  id?: string;
};

export const featureAccessor = ({geojson}: GeoJsonLayerColumnsConfig) => (
  dc: DataContainerInterface
) => d => dc.valueAt(d.index, geojson.fieldIdx);

const geoColumnAccessor = ({geojson}: GeoJsonLayerColumnsConfig) => (
  dc: DataContainerInterface
): arrow.Vector | null => dc.getColumn?.(geojson.fieldIdx) as arrow.Vector;

const geoFieldAccessor = ({geojson}: GeoJsonLayerColumnsConfig) => (
  dc: DataContainerInterface
): Field | null => (dc.getField ? dc.getField(geojson.fieldIdx) : null);

// access feature properties from geojson sub layer
export const defaultElevation = 500;
export const defaultLineWidth = 1;
export const defaultRadius = 1;

export default class GeoJsonLayer extends Layer {
  declare config: GeoJsonLayerConfig;
  declare visConfigSettings: GeoJsonVisConfigSettings;
  declare meta: GeoJsonLayerMeta;

  dataToFeature: GeojsonDataMaps = [];
  dataContainer: DataContainerInterface | null = null;
  filteredIndex: Uint8ClampedArray | null = null;
  filteredIndexTrigger: number[] | null = null;
  centroids: Array<number[] | null> = [];

  constructor(props) {
    super(props);

    this.registerVisConfig(geojsonVisConfigs);
    this.getPositionAccessor = (dataContainer: DataContainerInterface) =>
      featureAccessor(this.config.columns)(dataContainer);
  }

  get type() {
    return GeoJsonLayer.type;
  }
  static get type(): 'geojson' {
    return 'geojson';
  }

  get name(): 'Polygon' {
    return 'Polygon';
  }

  get layerIcon() {
    return GeojsonLayerIcon;
  }

  get requiredLayerColumns() {
    return geoJsonRequiredColumns;
  }

  get visualChannels() {
    const visualChannels = super.visualChannels;
    return {
      color: {
        ...visualChannels.color,
        accessor: 'getFillColor',
        condition: config => config.visConfig.filled,
        nullValue: visualChannels.color.nullValue,
        getAttributeValue: config => d => d.properties.fillColor || config.color,
        // used this to get updateTriggers
        defaultValue: config => config.color
      },
      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,
        getAttributeValue: config => d =>
          d.properties.lineColor || config.visConfig.strokeColor || config.color,
        // used this to get updateTriggers
        defaultValue: config => config.visConfig.strokeColor || config.color
      },
      size: {
        ...visualChannels.size,
        property: 'stroke',
        accessor: 'getLineWidth',
        condition: config => config.visConfig.stroked,
        nullValue: 0,
        getAttributeValue: () => d => d.properties.lineWidth || defaultLineWidth
      },
      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,
        getAttributeValue: () => d => d.properties.elevation || defaultElevation
      },
      radius: {
        property: 'radius',
        field: 'radiusField',
        scale: 'radiusScale',
        domain: 'radiusDomain',
        range: 'radiusRange',
        key: 'radius',
        channelScaleType: CHANNEL_SCALES.radius,
        accessor: 'getPointRadius',
        nullValue: 0,
        getAttributeValue: () => d => d.properties.radius || defaultRadius
      }
    };
  }

  static findDefaultLayerProps({label, fields = []}: KeplerTable) {
    const geojsonColumns = fields
      .filter(
        f =>
          (f.type === 'geojson' || f.type === 'geoarrow') &&
          SUPPORTED_ANALYZER_TYPES[f.analyzerType]
      )
      .map(f => f.name);

    const defaultColumns = {
      geojson: uniq([...GEOJSON_FIELDS.geojson, ...geojsonColumns])
    };

    const foundColumns = this.findDefaultColumnField(defaultColumns, fields);
    if (!foundColumns || !foundColumns.length) {
      return {props: []};
    }

    return {
      props: foundColumns.map(columns => ({
        label: (typeof label === 'string' && label.replace(/\.[^/.]+$/, '')) || this.type,
        columns,
        isVisible: true
      }))
    };
  }

  getDefaultLayerConfig(props: LayerBaseConfigPartial) {
    return {
      ...super.getDefaultLayerConfig(props),

      // add height visual channel
      heightField: null,
      heightDomain: [0, 1],
      heightScale: 'linear',

      // add radius visual channel
      radiusField: null,
      radiusDomain: [0, 1],
      radiusScale: 'linear',

      // add stroke color visual channel
      strokeColorField: null,
      strokeColorDomain: [0, 1],
      strokeColorScale: 'quantile'
    };
  }

  getHoverData(object, dataContainer) {
    // index of dataContainer is saved to feature.properties
    // for arrow format, `object` is the index of the row returned from deck
    const index = dataContainer instanceof ArrowDataContainer ? object : object?.properties?.index;
    if (index >= 0) {
      return dataContainer.row(index);
    }
    return null;
  }

  calculateDataAttribute({dataContainer, filteredIndex}, getPosition) {
    if (dataContainer instanceof ArrowDataContainer) {
      // filter geojson/arrow table by values and make a partial copy of the raw table are expensive
      // so we will use filteredIndex to create an attribute e.g. filteredIndex [0|1] for GPU filtering
      // in deck.gl layer, see: FilterArrowExtension in @kepler.gl/deckgl-layers
      if (!this.filteredIndex || this.filteredIndex.length !== dataContainer.numRows()) {
        // for incremental data loading, we need to update filteredIndex
        this.filteredIndex = new Uint8ClampedArray(dataContainer.numRows());
        this.filteredIndex.fill(1);
      }

      // check if filteredIndex is a range from 0 to numRows if it is, we don't need to update it
      const isRange = filteredIndex && filteredIndex.length === dataContainer.numRows();
      if (!isRange || this.filteredIndexTrigger !== null) {
        this.filteredIndex.fill(0);
        for (let i = 0; i < filteredIndex.length; ++i) {
          this.filteredIndex[filteredIndex[i]] = 1;
        }
        this.filteredIndexTrigger = filteredIndex;
      }
      // for arrow, always return full dataToFeature instead of a filtered one, so there is no need to update attributes in GPU
      return this.dataToFeature;
    }

    // for geojson, this should work as well and more efficient. But we need to update some test cases e.g. #GeojsonLayer -> formatLayerData
    return filteredIndex.map(i => this.dataToFeature[i]).filter(d => d);
  }

  formatLayerData(datasets, oldLayerData) {
    if (this.config.dataId === null) {
      return {};
    }
    const {gpuFilter, dataContainer} = datasets[this.config.dataId];
    const {data} = this.updateData(datasets, oldLayerData);

    const customFilterValueAccessor = (dc, d, fieldIndex) => {
      return dc.valueAt(d.properties.index, fieldIndex);
    };
    const indexAccessor = f => f.properties.index;

    const dataAccessor = dc => d => ({index: d.properties.index});
    const accessors = this.getAttributeAccessors({dataAccessor, dataContainer});

    const isFilteredAccessor = d => {
      return this.filteredIndex ? this.filteredIndex[d.properties.index] : 1;
    };

    return {
      data,
      getFilterValue: gpuFilter.filterValueAccessor(dataContainer)(
        indexAccessor,
        customFilterValueAccessor
      ),
      getFiltered: isFilteredAccessor,
      ...accessors
    };
  }

  isInPolygon(data: DataContainerInterface, index: number, polygon: Feature<Polygon>): Boolean {
    if (this.centroids.length === 0 || !this.centroids[index]) {
      return false;
    }
    const isReactangleSearchBox = polygon.properties?.shape === 'Rectangle';
    const point = this.centroids[index];
    // if no valid centroid, return false
    if (!point) return false;
    // quick check if centroid is within the query rectangle
    if (isReactangleSearchBox && polygon.properties?.bbox) {
      const [minX, minY, maxX, maxY] = polygon.properties?.bbox;
      return point[0] >= minX && point[0] <= maxX && point[1] >= minY && point[1] <= maxY;
    }
    // use turf.js to check if centroid is within query polygon
    return booleanWithin(turfPoint(point), polygon);
  }

  updateLayerMeta(dataContainer) {
    this.dataContainer = dataContainer;

    const getFeature = this.getPositionAccessor(dataContainer);
    const getGeoColumn = geoColumnAccessor(this.config.columns);
    const getGeoField = geoFieldAccessor(this.config.columns);

    if (dataContainer instanceof ArrowDataContainer) {
      // update the latest batch/chunk of geoarrow data when loading data incrementally
      if (this.dataToFeature.length < dataContainer.numChunks()) {
        // for incrementally loading data, we only load and render the latest batch; otherwise, we will load and render all batches
        const isIncrementalLoad = dataContainer.numChunks() - this.dataToFeature.length === 1;
        const {dataToFeature, bounds, fixedRadius, featureTypes, centroids} = getGeojsonLayerMetaFromArrow({
          dataContainer,
          getGeoColumn,
          getGeoField,
          ...(isIncrementalLoad ? {chunkIndex: this.dataToFeature.length} : null)
        });
        if (centroids) this.centroids = this.centroids.concat(centroids);
        this.updateMeta({bounds, fixedRadius, featureTypes});
        this.dataToFeature = [...this.dataToFeature, ...dataToFeature];
      }
    } else {
      if (this.dataToFeature.length === 0) {
        const {dataToFeature, bounds, fixedRadius, featureTypes, centroids} = getGeojsonLayerMeta({
          dataContainer,
          getFeature
        });
        if (centroids) this.centroids = centroids;
        this.dataToFeature = dataToFeature;
        this.updateMeta({bounds, fixedRadius, featureTypes});
      }
    }
  }

  setInitialLayerConfig({dataContainer}) {
    if (!dataContainer.numRows()) {
      return this;
    }
    this.updateLayerMeta(dataContainer);

    const {featureTypes} = this.meta;
    // default settings is stroke: true, filled: false
    if (featureTypes && featureTypes.polygon) {
      // set both fill and stroke to true
      return this.updateLayerVisConfig({
        filled: true,
        stroked: true,
        strokeColor: colorMaker.next().value
      });
    } else if (featureTypes && featureTypes.point) {
      // set fill to true if detect point
      return this.updateLayerVisConfig({filled: true, stroked: false});
    }

    return this;
  }

  isLayerHovered(objectInfo: ObjectInfo): boolean {
    return this.dataContainer instanceof ArrowDataContainer
      ? isLayerHoveredFromArrow(objectInfo, this.id)
      : super.isLayerHovered(objectInfo);
  }

  hasHoveredObject(objectInfo: ObjectInfo): Feature | null {
    return this.dataContainer instanceof ArrowDataContainer
      ? getHoveredObjectFromArrow(
          objectInfo,
          this.dataContainer,
          this.id,
          geoColumnAccessor(this.config.columns),
          geoFieldAccessor(this.config.columns)
        )
      : super.hasHoveredObject(objectInfo);
  }

  renderLayer(opts) {
    const {data: dataProps, gpuFilter, objectHovered, mapState, interactionConfig} = opts;

    const {fixedRadius, featureTypes} = this.meta;
    const radiusScale = this.getRadiusScaleByZoom(mapState, fixedRadius);
    const zoomFactor = this.getZoomFactor(mapState);
    const eleZoomFactor = this.getElevationZoomFactor(mapState);

    const {visConfig} = this.config;

    const layerProps = {
      lineWidthScale: visConfig.thickness * zoomFactor * 8,
      elevationScale: visConfig.elevationScale * eleZoomFactor,
      pointRadiusScale: radiusScale,
      lineMiterLimit: 4
    };

    const updateTriggers = {
      ...this.getVisualChannelUpdateTriggers(),
      getFilterValue: gpuFilter.filterValueUpdateTriggers,
      getFiltered: this.filteredIndexTrigger
    };

    const defaultLayerProps = this.getDefaultDeckLayerProps(opts);
    const opaOverwrite = {
      opacity: visConfig.strokeOpacity
    };

    const pickable = interactionConfig.tooltip.enabled;
    const hoveredObject = this.hasHoveredObject(objectHovered);

    const {data, ...props} = dataProps;

    // arrow table can have multiple chunks, a deck.gl layer is created for each chunk
    const deckLayerData = this.dataContainer instanceof ArrowDataContainer ? data : [data];
    const deckLayers = deckLayerData.map((d, i) => {
      return new DeckGLGeoJsonLayer({
        ...defaultLayerProps,
        ...layerProps,
        ...props,
        data: d,
        id: deckLayerData.length > 1 ? `${this.id}-${i}` : this.id,
        pickable,
        highlightColor: HIGHLIGH_COLOR_3D,
        autoHighlight: visConfig.enable3d && pickable,
        stroked: visConfig.stroked,
        filled: visConfig.filled,
        extruded: visConfig.enable3d,
        wireframe: visConfig.wireframe,
        wrapLongitude: false,
        lineMiterLimit: 2,
        capRounded: true,
        jointRounded: true,
        updateTriggers,
        extensions: [...defaultLayerProps.extensions, new FilterArrowExtension()],
        _subLayerProps: {
          ...(featureTypes?.polygon ? {'polygons-stroke': opaOverwrite} : {}),
          ...(featureTypes?.line ? {linestrings: opaOverwrite} : {}),
          ...(featureTypes?.point
            ? {
                points: {
                  lineOpacity: visConfig.strokeOpacity
                }
              }
            : {})
        }
      });
    });

    return [
      ...deckLayers,
      // hover layer
      ...(hoveredObject && !visConfig.enable3d
        ? [
            new DeckGLGeoJsonLayer({
              ...this.getDefaultHoverLayerProps(),
              ...layerProps,
              visible: defaultLayerProps.visible,
              wrapLongitude: false,
              data: [hoveredObject],
              getLineWidth: props.getLineWidth,
              getPointRadius: props.getPointRadius,
              getElevation: props.getElevation,
              getLineColor: this.config.highlightColor,
              getFillColor: this.config.highlightColor,
              // always draw outline
              stroked: true,
              filled: false
            })
          ]
        : [])
    ];
  }
}

1	// Copyright (c) 2023 Uber Technologies, Inc.
2	//
3	// Permission is hereby granted, free of charge, to any person obtaining a copy
4	// of this software and associated documentation files (the "Software"), to deal
5	// in the Software without restriction, including without limitation the rights
6	// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7	// copies of the Software, and to permit persons to whom the Software is
8	// furnished to do so, subject to the following conditions:
9	//
10	// The above copyright notice and this permission notice shall be included in
11	// all copies or substantial portions of the Software.
12	//
13	// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14	// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15	// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16	// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17	// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18	// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19	// THE SOFTWARE.
20
21	import * as arrow from 'apache-arrow';
22	import {point as turfPoint} from '@turf/helpers';
23	import booleanWithin from '@turf/boolean-within';
24	import {Feature, Polygon} from 'geojson';
25	import uniq from 'lodash.uniq';	9✔
26	import {DATA_TYPES} from 'type-analyzer';	9✔
27	import Layer, {
28	colorMaker,	9✔
29	LayerBaseConfig,	9✔
30	LayerBaseConfigPartial,	9✔
31	LayerColorConfig,
32	LayerColumn,
33	LayerHeightConfig,
34	LayerRadiusConfig,
35	LayerSizeConfig,
36	LayerStrokeColorConfig
37	} from '../base-layer';
38	import {GeoJsonLayer as DeckGLGeoJsonLayer} from '@deck.gl/layers';
39	import {getGeojsonLayerMeta, GeojsonDataMaps, DeckGlGeoTypes} from './geojson-utils';
40	import {
41	getGeojsonLayerMetaFromArrow,	9✔
42	isLayerHoveredFromArrow,	9✔
43	getHoveredObjectFromArrow	9✔
44	} from '../layer-utils';
45	import GeojsonLayerIcon from './geojson-layer-icon';
46	import {
47	GEOJSON_FIELDS,
48	HIGHLIGH_COLOR_3D,	9✔
49	CHANNEL_SCALES,	9✔
50	ColorRange,
51	LAYER_VIS_CONFIGS
52	} from '@kepler.gl/constants';
53	import {
54	VisConfigNumber,
55	VisConfigColorSelect,
56	VisConfigColorRange,
57	VisConfigRange,
58	VisConfigBoolean,
59	Merge,
60	RGBColor,
61	Field
62	} from '@kepler.gl/types';
63	import {KeplerTable} from '@kepler.gl/table';
64	import {DataContainerInterface, ArrowDataContainer} from '@kepler.gl/utils';
65	import {FilterArrowExtension} from '@kepler.gl/deckgl-layers';
66
67	const SUPPORTED_ANALYZER_TYPES = {	9✔
68	[DATA_TYPES.GEOMETRY]: true,	9✔
69	[DATA_TYPES.GEOMETRY_FROM_STRING]: true,
70	[DATA_TYPES.PAIR_GEOMETRY_FROM_STRING]: true	9✔
71	};
72
73	export const geojsonVisConfigs: {
74	opacity: 'opacity';
75	strokeOpacity: VisConfigNumber;
76	thickness: VisConfigNumber;
77	strokeColor: 'strokeColor';
78	colorRange: 'colorRange';
79	strokeColorRange: 'strokeColorRange';
80	radius: 'radius';
81
82	sizeRange: 'strokeWidthRange';
83	radiusRange: 'radiusRange';
84	heightRange: 'elevationRange';
85	elevationScale: 'elevationScale';
86	enableElevationZoomFactor: 'enableElevationZoomFactor';
87	stroked: 'stroked';
88	filled: 'filled';
89	enable3d: 'enable3d';
90	wireframe: 'wireframe';
91	} = {
92	opacity: 'opacity',
93	strokeOpacity: {
94	...LAYER_VIS_CONFIGS.opacity,	9✔
95	property: 'strokeOpacity'
96	},
97	thickness: {
98	...LAYER_VIS_CONFIGS.thickness,
99	defaultValue: 0.5
100	},
101	strokeColor: 'strokeColor',
102	colorRange: 'colorRange',
103	strokeColorRange: 'strokeColorRange',
104	radius: 'radius',
105
106	sizeRange: 'strokeWidthRange',
107	radiusRange: 'radiusRange',
108	heightRange: 'elevationRange',
109	elevationScale: 'elevationScale',
110	enableElevationZoomFactor: 'enableElevationZoomFactor',
111	stroked: 'stroked',
112	filled: 'filled',
113	enable3d: 'enable3d',
114	wireframe: 'wireframe'
115	};
116
117	export type GeoJsonVisConfigSettings = {
118	opacity: VisConfigNumber;
119	strokeOpacity: VisConfigNumber;
120	thickness: VisConfigNumber;
121	strokeColor: VisConfigColorSelect;
122	colorRange: VisConfigColorRange;
123	strokeColorRange: VisConfigColorRange;
124	radius: VisConfigNumber;
125
126	sizeRange: VisConfigRange;
127	radiusRange: VisConfigRange;
128	heightRange: VisConfigRange;
129	elevationScale: VisConfigNumber;
130	enableElevationZoomFactor: VisConfigBoolean;
131	stroked: VisConfigBoolean;
132	filled: VisConfigBoolean;
133	enable3d: VisConfigBoolean;
134	wireframe: VisConfigBoolean;
135	};
136
137	export type GeoJsonLayerColumnsConfig = {
138	geojson: LayerColumn;
139	};
140
141	export type GeoJsonLayerVisConfig = {
142	opacity: number;
143	strokeOpacity: number;
144	thickness: number;
145	strokeColor: RGBColor;
146	colorRange: ColorRange;
147	strokeColorRange: ColorRange;
148	radius: number;
149
150	sizeRange: [number, number];
151	radiusRange: [number, number];
152	heightRange: [number, number];
153	elevationScale: number;
154	enableElevationZoomFactor: boolean;
155	stroked: boolean;
156	filled: boolean;
157	enable3d: boolean;
158	wireframe: boolean;
159	};
160
161	type GeoJsonLayerVisualChannelConfig = LayerColorConfig &
162	LayerStrokeColorConfig &
163	LayerSizeConfig &
164	LayerHeightConfig &
165	LayerRadiusConfig;
166	export type GeoJsonLayerConfig = Merge<
167	LayerBaseConfig,
168	{columns: GeoJsonLayerColumnsConfig; visConfig: GeoJsonLayerVisConfig}
169	> &
170	GeoJsonLayerVisualChannelConfig;
171
172	export type GeoJsonLayerMeta = {
173	featureTypes?: DeckGlGeoTypes;
174	fixedRadius?: boolean;
175	};
176
177	export const geoJsonRequiredColumns: ['geojson'] = ['geojson'];
178
179	type ObjectInfo = {
180	index: number;	9✔
181	object?: Feature \| undefined;
182	picked: boolean;
183	layer: Layer;
184	radius?: number;
185	id?: string;
186	};
187
188	export const featureAccessor = ({geojson}: GeoJsonLayerColumnsConfig) => (
189	dc: DataContainerInterface
190	) => d => dc.valueAt(d.index, geojson.fieldIdx);
191		9✔
192	const geoColumnAccessor = ({geojson}: GeoJsonLayerColumnsConfig) => (
193	dc: DataContainerInterface	×
194	): arrow.Vector \| null => dc.getColumn?.(geojson.fieldIdx) as arrow.Vector;
195		9!
196	const geoFieldAccessor = ({geojson}: GeoJsonLayerColumnsConfig) => (
197	dc: DataContainerInterface
198	): Field \| null => (dc.getField ? dc.getField(geojson.fieldIdx) : null);
199		9✔
200	// access feature properties from geojson sub layer
201	export const defaultElevation = 500;	×
202	export const defaultLineWidth = 1;
203	export const defaultRadius = 1;
204		9✔
205	export default class GeoJsonLayer extends Layer {	9✔
206	declare config: GeoJsonLayerConfig;	9✔
207	declare visConfigSettings: GeoJsonVisConfigSettings;
208	declare meta: GeoJsonLayerMeta;
209
210	dataToFeature: GeojsonDataMaps = [];
211	dataContainer: DataContainerInterface \| null = null;
212	filteredIndex: Uint8ClampedArray \| null = null;
213	filteredIndexTrigger: number[] \| null = null;
214	centroids: Array<number[] \| null> = [];
215
216	constructor(props) {
217	super(props);
218
219	this.registerVisConfig(geojsonVisConfigs);	21✔
220	this.getPositionAccessor = (dataContainer: DataContainerInterface) =>	3✔
221	featureAccessor(this.config.columns)(dataContainer);
222	}	3✔
223		3✔
224	get type() {
225	return GeoJsonLayer.type;
226	}
227	static get type(): 'geojson' {
228	return 'geojson';	×
229	}
230
231	get name(): 'Polygon' {	×
232	return 'Polygon';
233	}
234
235	get layerIcon() {	3✔
236	return GeojsonLayerIcon;
237	}
238
239	get requiredLayerColumns() {	3✔
240	return geoJsonRequiredColumns;
241	}
242
243	get visualChannels() {	3✔
244	const visualChannels = super.visualChannels;
245	return {
246	color: {
247	...visualChannels.color,	×
248	accessor: 'getFillColor',	×
249	condition: config => config.visConfig.filled,
250	nullValue: visualChannels.color.nullValue,
251	getAttributeValue: config => d => d.properties.fillColor \|\| config.color,
252	// used this to get updateTriggers	×
253	defaultValue: config => config.color
254	},	×
255	strokeColor: {
256	property: 'strokeColor',	×
257	field: 'strokeColorField',
258	scale: 'strokeColorScale',
259	domain: 'strokeColorDomain',
260	range: 'strokeColorRange',
261	key: 'strokeColor',
262	channelScaleType: CHANNEL_SCALES.color,
263	accessor: 'getLineColor',
264	condition: config => config.visConfig.stroked,
265	nullValue: visualChannels.color.nullValue,
266	getAttributeValue: config => d =>
267	d.properties.lineColor \|\| config.visConfig.strokeColor \|\| config.color,	×
268	// used this to get updateTriggers
269	defaultValue: config => config.visConfig.strokeColor \|\| config.color	×
270	},	×
271	size: {
272	...visualChannels.size,	×
273	property: 'stroke',
274	accessor: 'getLineWidth',
275	condition: config => config.visConfig.stroked,
276	nullValue: 0,
277	getAttributeValue: () => d => d.properties.lineWidth \|\| defaultLineWidth
278	},	×
279	height: {
280	property: 'height',	×
281	field: 'heightField',
282	scale: 'heightScale',
283	domain: 'heightDomain',
284	range: 'heightRange',
285	key: 'height',
286	channelScaleType: CHANNEL_SCALES.size,
287	accessor: 'getElevation',
288	condition: config => config.visConfig.enable3d,
289	nullValue: 0,
290	getAttributeValue: () => d => d.properties.elevation \|\| defaultElevation
291	},	×
292	radius: {
293	property: 'radius',	×
294	field: 'radiusField',
295	scale: 'radiusScale',
296	domain: 'radiusDomain',
297	range: 'radiusRange',
298	key: 'radius',
299	channelScaleType: CHANNEL_SCALES.radius,
300	accessor: 'getPointRadius',
301	nullValue: 0,
302	getAttributeValue: () => d => d.properties.radius \|\| defaultRadius
303	}
304	};
305	}	×
306
307	static findDefaultLayerProps({label, fields = []}: KeplerTable) {
308	const geojsonColumns = fields
309	.filter(
310	f =>	×
311	(f.type === 'geojson' \|\| f.type === 'geoarrow') &&	×
312	SUPPORTED_ANALYZER_TYPES[f.analyzerType]
313	)	×
314	.map(f => f.name);	×
315
316	const defaultColumns = {
317	geojson: uniq([...GEOJSON_FIELDS.geojson, ...geojsonColumns])	×
318	};
319		×
320	const foundColumns = this.findDefaultColumnField(defaultColumns, fields);
321	if (!foundColumns \|\| !foundColumns.length) {
322	return {props: []};
323	}	×
324		×
325	return {	×
326	props: foundColumns.map(columns => ({
327	label: (typeof label === 'string' && label.replace(/\.[^/.]+$/, '')) \|\| this.type,
328	columns,	×
329	isVisible: true	×
330	}))	×
331	};
332	}
333
334	getDefaultLayerConfig(props: LayerBaseConfigPartial) {
335	return {
336	...super.getDefaultLayerConfig(props),
337
338	// add height visual channel	3✔
339	heightField: null,
340	heightDomain: [0, 1],
341	heightScale: 'linear',
342
343	// add radius visual channel
344	radiusField: null,
345	radiusDomain: [0, 1],
346	radiusScale: 'linear',
347
348	// add stroke color visual channel
349	strokeColorField: null,
350	strokeColorDomain: [0, 1],
351	strokeColorScale: 'quantile'
352	};
353	}
354
355	getHoverData(object, dataContainer) {
356	// index of dataContainer is saved to feature.properties
357	// for arrow format, `object` is the index of the row returned from deck
358	const index = dataContainer instanceof ArrowDataContainer ? object : object?.properties?.index;
359	if (index >= 0) {
360	return dataContainer.row(index);
361	}	×
362	return null;	×
363	}	×
364
365	calculateDataAttribute({dataContainer, filteredIndex}, getPosition) {	×
366	if (dataContainer instanceof ArrowDataContainer) {
367	// filter geojson/arrow table by values and make a partial copy of the raw table are expensive
368	// so we will use filteredIndex to create an attribute e.g. filteredIndex [0\|1] for GPU filtering	×
369	// in deck.gl layer, see: FilterArrowExtension in @kepler.gl/deckgl-layers	×
370	if (!this.filteredIndex \|\| this.filteredIndex.length !== dataContainer.numRows()) {
371	// for incremental data loading, we need to update filteredIndex
372	this.filteredIndex = new Uint8ClampedArray(dataContainer.numRows());
373	this.filteredIndex.fill(1);	×
374	}
375		×
376	// check if filteredIndex is a range from 0 to numRows if it is, we don't need to update it	×
377	const isRange = filteredIndex && filteredIndex.length === dataContainer.numRows();
378	if (!isRange \|\| this.filteredIndexTrigger !== null) {
379	this.filteredIndex.fill(0);
380	for (let i = 0; i < filteredIndex.length; ++i) {	×
381	this.filteredIndex[filteredIndex[i]] = 1;	×
382	}	×
383	this.filteredIndexTrigger = filteredIndex;	×
384	}	×
385	// for arrow, always return full dataToFeature instead of a filtered one, so there is no need to update attributes in GPU
386	return this.dataToFeature;	×
387	}
388
389	// for geojson, this should work as well and more efficient. But we need to update some test cases e.g. #GeojsonLayer -> formatLayerData	×
390	return filteredIndex.map(i => this.dataToFeature[i]).filter(d => d);
391	}
392
393	formatLayerData(datasets, oldLayerData) {	×
394	if (this.config.dataId === null) {
395	return {};
396	}	×
397	const {gpuFilter, dataContainer} = datasets[this.config.dataId];	×
398	const {data} = this.updateData(datasets, oldLayerData);	×
399
400	const customFilterValueAccessor = (dc, d, fieldIndex) => {	×
401	return dc.valueAt(d.properties.index, fieldIndex);	×
402	};
403	const indexAccessor = f => f.properties.index;	×
404		×
405	const dataAccessor = dc => d => ({index: d.properties.index});
406	const accessors = this.getAttributeAccessors({dataAccessor, dataContainer});	×
407
408	const isFilteredAccessor = d => {	×
409	return this.filteredIndex ? this.filteredIndex[d.properties.index] : 1;	×
410	};
411		×
412	return {	×
413	data,
414	getFilterValue: gpuFilter.filterValueAccessor(dataContainer)(
415	indexAccessor,	×
416	customFilterValueAccessor
417	),
418	getFiltered: isFilteredAccessor,
419	...accessors
420	};
421	}
422
423	isInPolygon(data: DataContainerInterface, index: number, polygon: Feature<Polygon>): Boolean {
424	if (this.centroids.length === 0 \|\| !this.centroids[index]) {
425	return false;
426	}
NEW 427	const isReactangleSearchBox = polygon.properties?.shape === 'Rectangle';	×
NEW 428	const point = this.centroids[index];	×
429	// if no valid centroid, return false
NEW 430	if (!point) return false;	×
NEW 431	// quick check if centroid is within the query rectangle	×
432	if (isReactangleSearchBox && polygon.properties?.bbox) {
NEW 433	const [minX, minY, maxX, maxY] = polygon.properties?.bbox;	×
434	return point[0] >= minX && point[0] <= maxX && point[1] >= minY && point[1] <= maxY;
NEW 435	}	×
436	// use turf.js to check if centroid is within query polygon
NEW 437	return booleanWithin(turfPoint(point), polygon);	×
438	}
439
UNCOV 440	updateLayerMeta(dataContainer) {	×
441	this.dataContainer = dataContainer;
442
443	const getFeature = this.getPositionAccessor(dataContainer);
444	const getGeoColumn = geoColumnAccessor(this.config.columns);	×
445	const getGeoField = geoFieldAccessor(this.config.columns);
446		×
447	if (dataContainer instanceof ArrowDataContainer) {	×
448	// update the latest batch/chunk of geoarrow data when loading data incrementally	×
449	if (this.dataToFeature.length < dataContainer.numChunks()) {
450	// for incrementally loading data, we only load and render the latest batch; otherwise, we will load and render all batches	×
451	const isIncrementalLoad = dataContainer.numChunks() - this.dataToFeature.length === 1;
NEW 452	const {dataToFeature, bounds, fixedRadius, featureTypes, centroids} = getGeojsonLayerMetaFromArrow({	×
453	dataContainer,
454	getGeoColumn,	×
455	getGeoField,	×
456	...(isIncrementalLoad ? {chunkIndex: this.dataToFeature.length} : null)
457	});
458	if (centroids) this.centroids = this.centroids.concat(centroids);
459	this.updateMeta({bounds, fixedRadius, featureTypes});	×
460	this.dataToFeature = [...this.dataToFeature, ...dataToFeature];
UNCOV 461	}	×
462	} else {	×
463	if (this.dataToFeature.length === 0) {	×
464	const {dataToFeature, bounds, fixedRadius, featureTypes, centroids} = getGeojsonLayerMeta({
465	dataContainer,
466	getFeature	×
467	});	×
468	if (centroids) this.centroids = centroids;
469	this.dataToFeature = dataToFeature;
470	this.updateMeta({bounds, fixedRadius, featureTypes});
UNCOV 471	}	×
472	}	×
473	}	×
474
475	setInitialLayerConfig({dataContainer}) {
476	if (!dataContainer.numRows()) {
477	return this;
478	}	×
479	this.updateLayerMeta(dataContainer);	×
480		×
481	const {featureTypes} = this.meta;
482	// default settings is stroke: true, filled: false	×
483	if (featureTypes && featureTypes.polygon) {
484	// set both fill and stroke to true	×
485	return this.updateLayerVisConfig({
486	filled: true,	×
487	stroked: true,
488	strokeColor: colorMaker.next().value	×
489	});
490	} else if (featureTypes && featureTypes.point) {
491	// set fill to true if detect point
492	return this.updateLayerVisConfig({filled: true, stroked: false});
493	}	×
494
495	return this;	×
496	}
497
498	isLayerHovered(objectInfo: ObjectInfo): boolean {	×
499	return this.dataContainer instanceof ArrowDataContainer
500	? isLayerHoveredFromArrow(objectInfo, this.id)
501	: super.isLayerHovered(objectInfo);
502	}	×
503		×
504	hasHoveredObject(objectInfo: ObjectInfo): Feature \| null {
505	return this.dataContainer instanceof ArrowDataContainer
506	? getHoveredObjectFromArrow(
507	objectInfo,
508	this.dataContainer,	×
509	this.id,	×
510	geoColumnAccessor(this.config.columns),
511	geoFieldAccessor(this.config.columns)
512	)
513	: super.hasHoveredObject(objectInfo);
514	}
515
516	renderLayer(opts) {
517	const {data: dataProps, gpuFilter, objectHovered, mapState, interactionConfig} = opts;
518
519	const {fixedRadius, featureTypes} = this.meta;	×
520	const radiusScale = this.getRadiusScaleByZoom(mapState, fixedRadius);	×
521	const zoomFactor = this.getZoomFactor(mapState);
522	const eleZoomFactor = this.getElevationZoomFactor(mapState);	×
523		×
524	const {visConfig} = this.config;	×
525		×
526	const layerProps = {
527	lineWidthScale: visConfig.thickness * zoomFactor * 8,	×
528	elevationScale: visConfig.elevationScale * eleZoomFactor,
529	pointRadiusScale: radiusScale,	×
530	lineMiterLimit: 4
531	};
532
533	const updateTriggers = {
534	...this.getVisualChannelUpdateTriggers(),
535	getFilterValue: gpuFilter.filterValueUpdateTriggers,
536	getFiltered: this.filteredIndexTrigger	×
537	};
538
539	const defaultLayerProps = this.getDefaultDeckLayerProps(opts);
540	const opaOverwrite = {
541	opacity: visConfig.strokeOpacity
542	};	×
543		×
544	const pickable = interactionConfig.tooltip.enabled;
545	const hoveredObject = this.hasHoveredObject(objectHovered);
546
547	const {data, ...props} = dataProps;	×
548		×
549	// arrow table can have multiple chunks, a deck.gl layer is created for each chunk
550	const deckLayerData = this.dataContainer instanceof ArrowDataContainer ? data : [data];	×
551	const deckLayers = deckLayerData.map((d, i) => {
552	return new DeckGLGeoJsonLayer({
553	...defaultLayerProps,	×
554	...layerProps,	×
555	...props,	×
556	data: d,
557	id: deckLayerData.length > 1 ? `${this.id}-${i}` : this.id,
558	pickable,
559	highlightColor: HIGHLIGH_COLOR_3D,
560	autoHighlight: visConfig.enable3d && pickable,	×
561	stroked: visConfig.stroked,
562	filled: visConfig.filled,
563	extruded: visConfig.enable3d,	×
564	wireframe: visConfig.wireframe,
565	wrapLongitude: false,
566	lineMiterLimit: 2,
567	capRounded: true,
568	jointRounded: true,
569	updateTriggers,
570	extensions: [...defaultLayerProps.extensions, new FilterArrowExtension()],
571	_subLayerProps: {
572	...(featureTypes?.polygon ? {'polygons-stroke': opaOverwrite} : {}),
573	...(featureTypes?.line ? {linestrings: opaOverwrite} : {}),
574	...(featureTypes?.point
575	? {	×
576	points: {	×
577	lineOpacity: visConfig.strokeOpacity	×
578	}	×
579	}
580	: {})
581	}
582	});
583	});
584
585	return [
586	...deckLayers,
587	// hover layer
588	...(hoveredObject && !visConfig.enable3d	×
589	? [
590	new DeckGLGeoJsonLayer({
591	...this.getDefaultHoverLayerProps(),	×
592	...layerProps,	×
593	visible: defaultLayerProps.visible,
594	wrapLongitude: false,
595	data: [hoveredObject],
596	getLineWidth: props.getLineWidth,
597	getPointRadius: props.getPointRadius,
598	getElevation: props.getElevation,
599	getLineColor: this.config.highlightColor,
600	getFillColor: this.config.highlightColor,
601	// always draw outline
602	stroked: true,
603	filled: false
604	})
605	]
606	: [])
607	];
608	}
609	}

keplergl / kepler.gl / 7267963662

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous