7267107175

Committed 19 Dec 2023 08:13PM UTC coverage: 37.537% (-0.003%) from 37.54%

Build # 7267107175

Build Type

push

github

Committed by

web-flow

Commit Message

[Demo] Add GeoArrow sample dataset (#2483)

Run Details

1755 of 7785 branches covered (0.0%)

Branch coverage included in aggregate %.

0 of 6 new or added lines in 2 files covered. (0.0%)

4 existing lines in 2 files now uncovered.

6579 of 14417 relevant lines covered (45.63%)

13.89 hits per line

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

15.43

/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 {Feature} 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;

  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
    };
  }

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

keplergl / kepler.gl / 7267107175

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