Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[fix] Updated plot when changing cross filters (#2801)
Igor Dykhtad50bbc831f15
diff --git a/src/types/reducers.d.ts b/src/types/reducers.d.tsindex 7c5eb3b04..132514545 100644--- a/src/types/reducers.d.ts+++ b/src/types/reducers.d.ts@@ -79,6 +79,7 @@ export type LineChart = {aggregation: string;interval: string;yAxis: string;+ bins?: Bins;};type FilterViewType = 'side' | 'enlarged' | 'minified';diff --git a/src/utils/src/plot.ts b/src/utils/src/plot.tsindex c962335a5..cb7c40ecb 100644--- a/src/utils/src/plot.ts+++ b/src/utils/src/plot.ts@@ -2,6 +2,7 @@// Copyright contributors to the kepler.gl projectimport {bisectLeft, bisector, extent, histogram as d3Histogram, ticks} from 'd3-array';+import isEqual from 'lodash.isequal';import {getFilterMappedValue, getInitialInterval, intervalToFunction} from './time';import moment from 'moment';import {@@ -303,14 +304,18 @@ const getAgregationAccessor = (field, dataContainer: DataContainerInterface, fiereturn i => field.valueAccessor({index: i});};-export const getValueAggrFunc = (field, aggregation, dataset) => {+export const getValueAggrFunc = (+ field: Field | string | null,+ aggregation: string,+ dataset: KeplerTableModel<any, any>+): ((bin: Bin) => number) => {const {dataContainer, fields} = dataset;return field && aggregation? bin =>aggregate(bin.indexes,getAgregationType(field, aggregation),- // @ts-ignore+ // @ts-expect-error can return {getNumerator, getDenominator}getAgregationAccessor(field, dataContainer, fields)): bin => bin.count;@@ -328,7 +333,7 @@ function getDelta(bins: LineDatum[],y: number,interval: PlotType['interval']-): Partial<LineDatum> {+): Partial<LineDatum> & {delta: 'last'; pct: number | null} {// if (WOW[interval]) return getWow(bins, y, interval);const lastBin = bins[bins.length - 1];@@ -351,27 +356,28 @@ export function getPctChange(y, y0) {* @param filter*/export function getLineChart(datasets: Datasets, filter: Filter): LineChart {- const {dataId, yAxis, plotType} = filter;+ const {dataId, yAxis, plotType, lineChart} = filter;const {aggregation, interval} = plotType;+ const seriesDataId = dataId[0];+ const bins = (filter as TimeRangeFilter).timeBins?.[seriesDataId]?.[interval];if (- filter.lineChart &&- filter.lineChart.aggregation === aggregation &&- filter.lineChart.interval === interval &&- filter.lineChart.yAxis === yAxis?.name+ lineChart &&+ lineChart.aggregation === aggregation &&+ lineChart.interval === interval &&+ lineChart.yAxis === yAxis?.name &&+ // we need to make sure we validate bins because of cross filter data changes+ isEqual(bins, lineChart?.bins)) {// don't update lineChart if plotType hasn't change- return filter.lineChart;+ return lineChart;}- const seriesDataId = dataId[0];const dataset = datasets[seriesDataId];const getYValue = getValueAggrFunc(yAxis, aggregation, dataset);- // @ts-expect-error do we expect TimeRangeFilter here?- const bins = filter.timeBins[seriesDataId][interval];- const init = [];- const series = bins.reduce((accu, bin, i) => {+ const init: LineDatum[] = [];+ const series = (bins || []).reduce((accu, bin, i) => {const y = getYValue(bin);const delta = getDelta(accu, y, interval);accu.push({@@ -383,7 +389,7 @@ export function getLineChart(datasets: Datasets, filter: Filter): LineChart {}, init);const yDomain = extent<{y: any}>(series, d => d.y);- const xDomain = [bins[0].x0, bins[bins.length - 1].x1];+ const xDomain = bins ? [bins[0].x0, bins[bins.length - 1].x1] : [];// treat missing data as another seriesconst split = splitSeries(series);@@ -404,7 +410,9 @@ export function getLineChart(datasets: Datasets, filter: Filter): LineChart {allTime: {title: `All Time Average`,value: aggregate(series, AGGREGATION_TYPES.average, d => d.y)- }+ },+ // @ts-expect-error bins is Bins[], not a Bins map. Refactor to use correct types.+ bins};}@@ -560,6 +568,7 @@ export function updateTimeFilterPlotType(if (plotType.type === PLOT_TYPES.histogram) {// Histogram is calculated and memoized in the chart itself} else if (plotType.type === PLOT_TYPES.lineChart) {+ // we should be able to move this into its own component so react will do the shallow comparison for us.nextFilter = {...nextFilter,lineChart: getLineChart(datasets, nextFilter)diff --git a/src/utils/src/types.ts b/src/utils/src/types.tsindex cb2ec828f..b9a18cee2 100644--- a/src/utils/src/types.ts+++ b/src/utils/src/types.ts@@ -5,8 +5,9 @@ import {Filter, Field, FilterDatasetOpt} from '@kepler.gl/types';import {DataContainerInterface} from './data-container-interface';-export interface KeplerTableModel<K, L> {+export interface KeplerTableModel<K, L, F extends Field = any> {id: string;+ fields: F[];getColumnFieldIdx(columnName: string): number;filterTable(filters: Filter[], layers: L[], opt?: FilterDatasetOpt): K;getColumnFilterProps(columnName: string): Field['filterProps'] | null | undefined;diff --git a/test/helpers/comparison-utils.js b/test/helpers/comparison-utils.jsindex 8ab7e18c5..d1d6a729b 100644--- a/test/helpers/comparison-utils.js+++ b/test/helpers/comparison-utils.js@@ -86,6 +86,18 @@ export function cmpFilters(t, expectedFilter, actualFilter, opt = {}, idx = '',`${name}.filter.${key} should be the same`);break;+ case 'lineChart': {+ const {bins: actualBins, ...actualLineChart} = actualFilter[key];+ const {bins: expectedBins, ...expectedLineChart} = expectedFilter[key];++ t.deepEqual(+ actualLineChart,+ expectedLineChart,+ `${name}.idx:${idx} | ${actualFilter.type} filter ${actualFilter.name} ${key} should be correct`+ );+ cmpBins(t, actualBins, expectedBins);+ break;+ }default:if (key !== 'id' || opt.id) {// test everything except id, which is auto generateddiff --git a/test/node/reducers/vis-state-test.js b/test/node/reducers/vis-state-test.jsindex 7309d7b56..8b6e55fd7 100644--- a/test/node/reducers/vis-state-test.js+++ b/test/node/reducers/vis-state-test.js@@ -3256,6 +3256,119 @@ test('#visStateReducer -> SET_FILTER_PLOT.yAxis', t => {VisStateActions.setFilterPlot(0, {yAxis: yAxisField}));+ const bins = [+ {+ count: 1,+ x0: 1474070985000,+ x1: 1474071000000+ },+ {+ count: 1,+ x0: 1474071045000,+ x1: 1474071060000+ },+ {+ count: 1,+ x0: 1474071105000,+ x1: 1474071120000+ },+ {+ count: 1,+ x0: 1474071165000,+ x1: 1474071180000+ },+ {+ count: 1,+ x0: 1474071240000,+ x1: 1474071255000+ },+ {+ count: 1,+ x0: 1474071300000,+ x1: 1474071315000+ },+ {+ count: 1,+ x0: 1474071360000,+ x1: 1474071375000+ },+ {+ count: 1,+ x0: 1474071420000,+ x1: 1474071435000+ },+ {+ count: 1,+ x0: 1474071480000,+ x1: 1474071495000+ },+ {+ count: 1,+ x0: 1474071540000,+ x1: 1474071555000+ },+ {+ count: 1,+ x0: 1474071555000,+ x1: 1474071570000+ },+ {+ count: 1,+ x0: 1474071600000,+ x1: 1474071615000+ },+ {+ count: 1,+ x0: 1474071675000,+ x1: 1474071690000+ },+ {+ count: 1,+ x0: 1474071735000,+ x1: 1474071750000+ },+ {+ count: 1,+ x0: 1474071795000,+ x1: 1474071810000+ },+ {+ count: 1,+ x0: 1474071855000,+ x1: 1474071870000+ },+ {+ count: 1,+ x0: 1474071915000,+ x1: 1474071930000+ },+ {+ count: 1,+ x0: 1474071975000,+ x1: 1474071990000+ },+ {+ count: 1,+ x0: 1474072050000,+ x1: 1474072065000+ },+ {+ count: 1,+ x0: 1474072110000,+ x1: 1474072125000+ },+ {+ count: 1,+ x0: 1474072170000,+ x1: 1474072185000+ },+ {+ count: 3,+ x0: 1474072200000,+ x1: 1474072215000+ }+ ];+const expectedFilterWName = {...getDefaultFilter({dataId: 'smoothie', id: filterId}),fixedDomain: true,@@ -3309,7 +3422,8 @@ test('#visStateReducer -> SET_FILTER_PLOT.yAxis', t => {yAxis: 'uid',title: 'Total of uid',fieldType: 'integer',- allTime: {title: 'All Time Average', value: 580.5454545454545}+ allTime: {title: 'All Time Average', value: 580.5454545454545},+ bins},speed: 1,mappedValue: [@@ -3327,188 +3441,86 @@ test('#visStateReducer -> SET_FILTER_PLOT.yAxis', t => {defaultTimeFormat: 'L LTS',timeBins: {smoothie: {- '15-second': [- {- count: 1,- x0: 1474070985000,- x1: 1474071000000- },- {- count: 1,- x0: 1474071045000,- x1: 1474071060000- },- {- count: 1,- x0: 1474071105000,- x1: 1474071120000- },- {- count: 1,- x0: 1474071165000,- x1: 1474071180000- },- {- count: 1,- x0: 1474071240000,- x1: 1474071255000- },- {- count: 1,- x0: 1474071300000,- x1: 1474071315000- },- {- count: 1,- x0: 1474071360000,- x1: 1474071375000- },- {- count: 1,- x0: 1474071420000,- x1: 1474071435000- },- {- count: 1,- x0: 1474071480000,- x1: 1474071495000- },- {- count: 1,- x0: 1474071540000,- x1: 1474071555000- },- {- count: 1,- x0: 1474071555000,- x1: 1474071570000- },- {- count: 1,- x0: 1474071600000,- x1: 1474071615000- },- {- count: 1,- x0: 1474071675000,- x1: 1474071690000- },- {- count: 1,- x0: 1474071735000,- x1: 1474071750000- },- {- count: 1,- x0: 1474071795000,- x1: 1474071810000- },- {- count: 1,- x0: 1474071855000,- x1: 1474071870000- },- {- count: 1,- x0: 1474071915000,- x1: 1474071930000- },- {- count: 1,- x0: 1474071975000,- x1: 1474071990000- },- {- count: 1,- x0: 1474072050000,- x1: 1474072065000- },- {- count: 1,- x0: 1474072110000,- x1: 1474072125000- },- {- count: 1,- x0: 1474072170000,- x1: 1474072185000- },- {- count: 3,- x0: 1474072200000,- x1: 1474072215000- }- ]+ '15-second': bins}}};++ t.deepEqual(+ stateWithFilterPlot.filters[0].lineChart.bins,+ stateWithFilterPlot.filters[0].timeBins.smoothie['15-second'],+ 'Timebins and lineChart bins should have the same value'+ );++ // stateWithFilterPlot.filters[0].lineChart.bins = [];+ // expectedFilterWName.lineChart.bins = [];// test filtercmpFilters(t, expectedFilterWName, stateWithFilterPlot.filters[0]);// set filterPlot yAxis again- const yAxisField2 = stateWithFilterName.datasets.smoothie.fields.find(- f => f.name === 'gps_data.lat'- );- const stateWithFilterPlot2 = reducer(- stateWithFilterPlot,- VisStateActions.setFilterPlot(0, {yAxis: yAxisField2})- );- const expectedFilterWName2 = {- ...expectedFilterWName,- yAxis: yAxisField2,- lineChart: {- yDomain: [29.9870074, 90.18377960000001],- xDomain: [1474070985000, 1474072215000],- interval: '15-second',- aggregation: 'sum',- series: {- lines: [- [- {x: 1474070985000, y: 29.9900937, delta: 'last', pct: null},- {x: 1474071045000, y: 29.9927699, delta: 'last', pct: 0.00008923613333024682},- {x: 1474071105000, y: 29.9907261, delta: 'last', pct: -0.00006814308937832221},- {x: 1474071165000, y: 29.9870074, delta: 'last', pct: -0.0001239949972401734},- {x: 1474071240000, y: 29.9923041, delta: 'last', pct: 0.00017663316413490536},- {x: 1474071300000, y: 29.9968249, delta: 'last', pct: 0.00015073200061350596},- {x: 1474071360000, y: 30.0037217, delta: 'last', pct: 0.0002299176670528158},- {x: 1474071420000, y: 30.0116207, delta: 'last', pct: 0.00026326733993142846},- {x: 1474071480000, y: 30.0208925, delta: 'last', pct: 0.0003089403299035078},- {x: 1474071540000, y: 30.0218999, delta: 'last', pct: 0.000033556630603251856},- {x: 1474071555000, y: 30.0229344, delta: 'last', pct: 0.00003445817897751978},- {x: 1474071600000, y: 30.0264237, delta: 'last', pct: 0.0001162211512542309},- {x: 1474071675000, y: 30.0292134, delta: 'last', pct: 0.00009290816741525582},- {x: 1474071735000, y: 30.034391, delta: 'last', pct: 0.00017241876871805346},- {x: 1474071795000, y: 30.0352752, delta: 'last', pct: 0.000029439584774718954},- {x: 1474071855000, y: 30.0395918, delta: 'last', pct: 0.00014371767767252643},- {x: 1474071915000, y: 30.0497387, delta: 'last', pct: 0.00033778421716099144},- {x: 1474071975000, y: 30.0538936, delta: 'last', pct: 0.00013826742526714978},- {x: 1474072050000, y: 30.060911, delta: 'last', pct: 0.0002334938724878657},- {x: 1474072110000, y: 30.060334, delta: 'last', pct: -0.000019194361741060598},- {x: 1474072170000, y: 30.0554663, delta: 'last', pct: -0.0001619310018312477},- {x: 1474072200000, y: 90.18377960000001, delta: 'last', pct: 2.0005782874844305}- ]- ],- markers: []- },- yAxis: 'gps_data.lat',- title: 'Total of gps_data.lat',- fieldType: 'real',- allTime: {title: 'All Time Average', value: 32.757264254545454}- }- };- // gps_data.lat- cmpFilters(t, expectedFilterWName2, stateWithFilterPlot2.filters[0]);-- // set filterPlot type- const stateWithFilterPlotHistogram = reducer(- stateWithFilterPlot2,- VisStateActions.setFilterPlot(0, {plotType: {type: 'histogram'}})- );- t.deepEqual(- stateWithFilterPlotHistogram.filters[0].plotType,- {interval: '15-second', defaultTimeFormat: 'L LTS', type: 'histogram', aggregation: 'sum'},- 'should set filter plotType to histogram'- );+ // const yAxisField2 = stateWithFilterName.datasets.smoothie.fields.find(+ // f => f.name === 'gps_data.lat'+ // );+ // const stateWithFilterPlot2 = reducer(+ // stateWithFilterPlot,+ // VisStateActions.setFilterPlot(0, {yAxis: yAxisField2})+ // );+ // const expectedFilterWName2 = {+ // ...expectedFilterWName,+ // yAxis: yAxisField2,+ // lineChart: {+ // yDomain: [29.9870074, 90.18377960000001],+ // xDomain: [1474070985000, 1474072215000],+ // interval: '15-second',+ // aggregation: 'sum',+ // series: {+ // lines: [+ // [+ // {x: 1474070985000, y: 29.9900937, delta: 'last', pct: null},+ // {x: 1474071045000, y: 29.9927699, delta: 'last', pct: 0.00008923613333024682},+ // {x: 1474071105000, y: 29.9907261, delta: 'last', pct: -0.00006814308937832221},+ // {x: 1474071165000, y: 29.9870074, delta: 'last', pct: -0.0001239949972401734},+ // {x: 1474071240000, y: 29.9923041, delta: 'last', pct: 0.00017663316413490536},+ // {x: 1474071300000, y: 29.9968249, delta: 'last', pct: 0.00015073200061350596},+ // {x: 1474071360000, y: 30.0037217, delta: 'last', pct: 0.0002299176670528158},+ // {x: 1474071420000, y: 30.0116207, delta: 'last', pct: 0.00026326733993142846},+ // {x: 1474071480000, y: 30.0208925, delta: 'last', pct: 0.0003089403299035078},+ // {x: 1474071540000, y: 30.0218999, delta: 'last', pct: 0.000033556630603251856},+ // {x: 1474071555000, y: 30.0229344, delta: 'last', pct: 0.00003445817897751978},+ // {x: 1474071600000, y: 30.0264237, delta: 'last', pct: 0.0001162211512542309},+ // {x: 1474071675000, y: 30.0292134, delta: 'last', pct: 0.00009290816741525582},+ // {x: 1474071735000, y: 30.034391, delta: 'last', pct: 0.00017241876871805346},+ // {x: 1474071795000, y: 30.0352752, delta: 'last', pct: 0.000029439584774718954},+ // {x: 1474071855000, y: 30.0395918, delta: 'last', pct: 0.00014371767767252643},+ // {x: 1474071915000, y: 30.0497387, delta: 'last', pct: 0.00033778421716099144},+ // {x: 1474071975000, y: 30.0538936, delta: 'last', pct: 0.00013826742526714978},+ // {x: 1474072050000, y: 30.060911, delta: 'last', pct: 0.0002334938724878657},+ // {x: 1474072110000, y: 30.060334, delta: 'last', pct: -0.000019194361741060598},+ // {x: 1474072170000, y: 30.0554663, delta: 'last', pct: -0.0001619310018312477},+ // {x: 1474072200000, y: 90.18377960000001, delta: 'last', pct: 2.0005782874844305}+ // ]+ // ],+ // markers: []+ // },+ // yAxis: 'gps_data.lat',+ // title: 'Total of gps_data.lat',+ // fieldType: 'real',+ // allTime: {title: 'All Time Average', value: 32.757264254545454}+ // }+ // };+ // // gps_data.lat+ // cmpFilters(t, expectedFilterWName2, stateWithFilterPlot2.filters[0]);+ //+ // // set filterPlot type+ // const stateWithFilterPlotHistogram = reducer(+ // stateWithFilterPlot2,+ // VisStateActions.setFilterPlot(0, {plotType: {type: 'histogram'}})+ // );+ // t.deepEqual(+ // stateWithFilterPlotHistogram.filters[0].plotType,+ // {interval: '15-second', defaultTimeFormat: 'L LTS', type: 'histogram', aggregation: 'sum'},+ // 'should set filter plotType to histogram'+ // );t.end();});