@mathstack/viz 1.1.5 → 2.0.3

package/src/lib/geographies/config/layers/attribute-data-layer/dimensions/equal-frequencies-bins/equal-frequencies-bins.cy.ts

@@ -0,0 +1,362 @@
+/* eslint-disable @angular-eslint/prefer-standalone */
+import { Component, Input } from '@angular/core';
+import {
+  ChartConfig,
+  GeographiesConfig,
+  VicChartConfigBuilder,
+  VicChartModule,
+  VicGeographiesConfigBuilder,
+  VicGeographiesModule,
+} from '@mathstack/viz';
+import { ascending, max } from 'd3';
+import {
+  FeatureCollection,
+  GeoJsonProperties,
+  MultiPolygon,
+  Polygon,
+} from 'geojson';
+import { beforeEach, cy, describe, expect, it } from 'local-cypress';
+import { uniqBy } from 'lodash-es';
+import * as topojson from 'topojson-client';
+import { GeometryCollection, Objects, Topology } from 'topojson-specification';
+import {
+  StateIncomePopulationYearDatum,
+  stateIncomePopulationYearData,
+} from '../../../../../../testing/data/state-population-income-year-data';
+
+const margin = { top: 36, right: 36, bottom: 36, left: 36 };
+const chartHeight = 400;
+const chartWidth = 600;
+const attributeData = stateIncomePopulationYearData
+  .filter((x) => x.year === 2020)
+  .filter((x) => x.state !== 'Puerto Rico');
+
+interface TestMapGeometryProperties extends GeoJsonProperties {
+  name: string;
+  id: string;
+}
+
+interface TestMapObjects extends Objects {
+  country: GeometryCollection<TestMapGeometryProperties>;
+  states: GeometryCollection<TestMapGeometryProperties>;
+}
+
+type TestUsMapTopology = Topology<TestMapObjects>;
+
+// ***********************************************************
+// Geographies component set up
+// ***********************************************************
+@Component({
+  // eslint-disable-next-line @angular-eslint/component-selector
+  selector: 'app-test-geographies',
+  template: `
+    <vic-map-chart [config]="chartConfig">
+      <svg:g
+        vic-primary-marks-geographies
+        svg-elements
+        [config]="geographiesConfig"
+        [vicGeographiesHoversActions]="hoverActions"
+        (vicGeographiesHoverOutput)="updateTooltipForNewOutput($event)"
+      ></svg:g>
+    </vic-map-chart>
+  `,
+  styles: [],
+  imports: [VicChartModule, VicGeographiesModule],
+})
+class TestGeographiesComponent {
+  @Input() geographiesConfig: GeographiesConfig<
+    StateIncomePopulationYearDatum,
+    TestMapGeometryProperties
+  >;
+  chartConfig: ChartConfig = new VicChartConfigBuilder()
+    .margin(margin)
+    .maxWidth(chartWidth)
+    .maxHeight(chartHeight)
+    .scalingStrategy('responsive-width')
+    .getConfig();
+}
+
+const mountGeographiesComponent = (
+  geographiesConfig: GeographiesConfig<
+    StateIncomePopulationYearDatum,
+    TestMapGeometryProperties
+  >
+): void => {
+  cy.mount(TestGeographiesComponent, {
+    componentProperties: {
+      geographiesConfig: geographiesConfig,
+    },
+  });
+};
+
+// ***********************************************************
+// Test dimension
+// ***********************************************************
+describe('the Equal Frequencies Bins Attribute Data dimension', () => {
+  let geographiesConfig: GeographiesConfig<
+    StateIncomePopulationYearDatum,
+    TestMapGeometryProperties
+  >;
+  beforeEach(() => {
+    geographiesConfig = undefined;
+  });
+  it('Uses dimension defaults and creates bins in the data and colors values accordingly with default colors', () => {
+    cy.fixture('usMap.json').then((response) => {
+      const usMap: TestUsMapTopology = response;
+      const usBoundary = topojson.feature(
+        usMap,
+        usMap.objects.country
+      ) as FeatureCollection<MultiPolygon, TestMapGeometryProperties>;
+      const states = topojson.feature(
+        usMap,
+        usMap.objects.states
+      ) as FeatureCollection<MultiPolygon | Polygon, TestMapGeometryProperties>;
+      geographiesConfig = new VicGeographiesConfigBuilder<
+        StateIncomePopulationYearDatum,
+        TestMapGeometryProperties
+      >()
+        .boundary(usBoundary)
+        .featureIndexAccessor((d) => d.properties.name)
+        .attributeDataLayer((dimension) =>
+          dimension
+            .data(attributeData)
+            .class((d) => d.name.split(' ').join('-'))
+            .geographies(states.features)
+            .geographyIndexAccessor((d) => d.state)
+            .equalFrequenciesBins((bins) => bins.valueAccessor((d) => d.income))
+        )
+        .getConfig();
+      mountGeographiesComponent(geographiesConfig);
+      // see https://d3js.org/d3-scale/quantile#quantile_domain for how d3 quantile works
+      const sortedAttributeData = attributeData
+        .filter((x) => {
+          const coerced = Number(x.income);
+          return !(isNaN(coerced) || coerced === null || coerced === undefined);
+        })
+        .sort((a, b) => ascending(Number(a.income), Number(b.income)));
+      const binMaxValues = [
+        ...geographiesConfig.attributeDataLayer.attributeDimension
+          .getScale()
+          ['quantiles'](),
+        max(sortedAttributeData.map((x) => x.income)),
+      ];
+      const statesByBin = sortedAttributeData.reduce((acc, d) => {
+        const binNumber = binMaxValues.reduce((acc, maxValue, i) => {
+          if (
+            (d.income < maxValue || i === binMaxValues.length - 1) &&
+            acc === null
+          ) {
+            acc = i;
+            return acc;
+          } else {
+            return acc;
+          }
+        }, null);
+        if (!acc[binNumber]) {
+          acc[binNumber] = [];
+        }
+        acc[binNumber].push(d.state);
+        return acc;
+      }, []);
+      cy.get('.vic-geographies-group path').then((states) => {
+        // get unique bin colors for geographies in attribute data
+        const binColors = uniqBy(
+          states
+            .filter(
+              (i, el) =>
+                !!attributeData.find(
+                  (x) => x.state.split(' ').join('-') === el.classList[0]
+                )
+            )
+            .map((i, el) => {
+              const rg = el.getAttribute('fill').split('(')[1].split(',');
+              return { r: rg[0].trim(), g: rg[1].trim() };
+            }),
+          (x) => x.r
+        )
+          .sort((a, b) => b.r - a.r)
+          .map((x) => `rgb(${x.r}, ${x.g}, 255)`);
+        binColors.forEach((color, i) => {
+          // check that the states in each bin have the same color
+          statesByBin[i].forEach((state) => {
+            cy.get(
+              `.vic-geographies-group.${state.split(' ').join('-')} path`
+            ).then((path) => {
+              expect(path.attr('fill')).to.eq(color);
+            });
+          });
+        });
+      });
+    });
+  });
+
+  it('Colors the data with provided range when a user provides a range of the same length as num bins', () => {
+    const range = ['red', 'orange', 'yellow', 'green', 'blue'];
+    cy.fixture('usMap.json').then((response) => {
+      const usMap: TestUsMapTopology = response;
+      const usBoundary = topojson.feature(
+        usMap,
+        usMap.objects.country
+      ) as FeatureCollection<MultiPolygon, TestMapGeometryProperties>;
+      const states = topojson.feature(
+        usMap,
+        usMap.objects.states
+      ) as FeatureCollection<MultiPolygon | Polygon, TestMapGeometryProperties>;
+      geographiesConfig = new VicGeographiesConfigBuilder<
+        StateIncomePopulationYearDatum,
+        TestMapGeometryProperties
+      >()
+        .boundary(usBoundary)
+        .featureIndexAccessor((d) => d.properties.name)
+        .attributeDataLayer((dimension) =>
+          dimension
+            .data(attributeData)
+            .class((d) => d.name.split(' ').join('-'))
+            .geographies(states.features)
+            .geographyIndexAccessor((d) => d.state)
+            .equalFrequenciesBins((bins) =>
+              bins
+                .valueAccessor((d) => d.income)
+                .numBins(5)
+                .range(range)
+            )
+        )
+        .getConfig();
+      mountGeographiesComponent(geographiesConfig);
+      // see https://d3js.org/d3-scale/quantile#quantile_domain for how d3 quantile works
+      const sortedAttributeData = attributeData
+        .filter((x) => {
+          const coerced = Number(x.income);
+          return !(isNaN(coerced) || coerced === null || coerced === undefined);
+        })
+        .sort((a, b) => ascending(Number(a.income), Number(b.income)));
+      const binMaxValues = [
+        ...geographiesConfig.attributeDataLayer.attributeDimension
+          .getScale()
+          ['quantiles'](),
+        max(sortedAttributeData.map((x) => x.income)),
+      ];
+      const statesByBin = sortedAttributeData.reduce((acc, d) => {
+        const binNumber = binMaxValues.reduce((acc, maxValue, i) => {
+          if (
+            (d.income < maxValue || i === binMaxValues.length - 1) &&
+            acc === null
+          ) {
+            acc = i;
+            return acc;
+          } else {
+            return acc;
+          }
+        }, null);
+        if (!acc[binNumber]) {
+          acc[binNumber] = [];
+        }
+        acc[binNumber].push(d.state);
+        return acc;
+      }, []);
+      range.forEach((color, i) => {
+        // check that the states in each bin have the same color
+        statesByBin[i].forEach((state) => {
+          cy.get(
+            `.vic-geographies-group.${state.split(' ').join('-')} path`
+          ).then((path) => {
+            expect(path.attr('fill')).to.eq(color);
+          });
+        });
+      });
+    });
+  });
+
+  it('Colors the data with interpolated colors when a user provides a range of lesser length than num bins', () => {
+    const range = ['red', 'white'];
+    const numBins = 5;
+    cy.fixture('usMap.json').then((response) => {
+      const usMap: TestUsMapTopology = response;
+      const usBoundary = topojson.feature(
+        usMap,
+        usMap.objects.country
+      ) as FeatureCollection<MultiPolygon, TestMapGeometryProperties>;
+      const states = topojson.feature(
+        usMap,
+        usMap.objects.states
+      ) as FeatureCollection<MultiPolygon | Polygon, TestMapGeometryProperties>;
+      geographiesConfig = new VicGeographiesConfigBuilder<
+        StateIncomePopulationYearDatum,
+        TestMapGeometryProperties
+      >()
+        .boundary(usBoundary)
+        .featureIndexAccessor((d) => d.properties.name)
+        .attributeDataLayer((dimension) =>
+          dimension
+            .data(attributeData)
+            .class((d) => d.name.split(' ').join('-'))
+            .geographies(states.features)
+            .geographyIndexAccessor((d) => d.state)
+            .equalFrequenciesBins((bins) =>
+              bins
+                .valueAccessor((d) => d.income)
+                .numBins(numBins)
+                .range(range)
+            )
+        )
+        .getConfig();
+      mountGeographiesComponent(geographiesConfig);
+      // see https://d3js.org/d3-scale/quantile#quantile_domain for how d3 quantile works
+      const sortedAttributeData = attributeData
+        .filter((x) => {
+          const coerced = Number(x.income);
+          return !(isNaN(coerced) || coerced === null || coerced === undefined);
+        })
+        .sort((a, b) => ascending(Number(a.income), Number(b.income)));
+      const binMaxValues = [
+        ...geographiesConfig.attributeDataLayer.attributeDimension
+          .getScale()
+          ['quantiles'](),
+        max(sortedAttributeData.map((x) => x.income)),
+      ];
+      const statesByBin = sortedAttributeData.reduce((acc, d) => {
+        const binNumber = binMaxValues.reduce((acc, maxValue, i) => {
+          if (
+            (d.income < maxValue || i === binMaxValues.length - 1) &&
+            acc === null
+          ) {
+            acc = i;
+            return acc;
+          } else {
+            return acc;
+          }
+        }, null);
+        if (!acc[binNumber]) {
+          acc[binNumber] = [];
+        }
+        acc[binNumber].push(d.state);
+        return acc;
+      }, []);
+      let colors = [];
+      cy.get('.vic-geographies-group path').then((paths) => {
+        paths.each((i, el) => {
+          const path = el as unknown as SVGPathElement;
+          const fill = path.getAttribute('fill');
+          if (!colors.includes(fill)) {
+            colors.push(fill);
+          }
+        });
+        expect(colors).to.have.lengthOf(numBins + 1);
+        colors = colors.filter((x) => x[0] === 'r'); // filter out null color 'whitesmoke'
+        colors.sort((a, b) =>
+          ascending(a.split(',')[1].trim(), b.split(',')[1].trim())
+        );
+        paths.each((i, el) => {
+          const path = el as unknown as SVGPathElement;
+          const state = path.parentElement.classList[1].split('-').join(' ');
+          const binIndex = statesByBin.findIndex((bin) => bin.includes(state));
+          if (binIndex > -1) {
+            expect(path.getAttribute('fill')).to.eq(colors[binIndex]);
+          } else {
+            expect(path.getAttribute('fill')).to.eq('whitesmoke');
+          }
+        });
+      });
+    });
+  });
+});

package/src/lib/geographies/config/layers/attribute-data-layer/dimensions/equal-frequencies-bins/equal-frequencies-bins.spec.ts

@@ -0,0 +1,72 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { EqualFrequenciesAttributeDataDimension } from './equal-frequencies-bins';
+import { EqualFrequenciesAttributeDataDimensionBuilder } from './equal-frequencies-bins-builder';
+
+describe('VicEqualNumObservationsBins', () => {
+  let dimension: EqualFrequenciesAttributeDataDimension<any, string>;
+  beforeEach(() => {
+    dimension = new EqualFrequenciesAttributeDataDimensionBuilder<any, string>()
+      .numBins(4)
+      .range(['red', 'blue', 'yellow', 'green'])
+      .valueAccessor((d) => d)
+      .nullColor('black')
+      ._build();
+  });
+  describe('setPropertiesFromData', () => {
+    beforeEach(() => {
+      spyOn(dimension as any, 'setDomain');
+      spyOn(dimension as any, 'setNumBins');
+      spyOn(dimension as any, 'setRange');
+    });
+    it('calls setDomain once', () => {
+      dimension.setPropertiesFromData([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
+      expect((dimension as any).setDomain).toHaveBeenCalledOnceWith([
+        1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
+      ]);
+    });
+    it('calls setNumBins once', () => {
+      dimension.setPropertiesFromData([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
+      expect((dimension as any).setNumBins).toHaveBeenCalledTimes(1);
+    });
+    it('calls setRange once', () => {
+      dimension.setPropertiesFromData([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
+      expect((dimension as any).setRange).toHaveBeenCalledTimes(1);
+    });
+  });
+
+  describe('integration: setDomain', () => {
+    it('sets the domain to the values', () => {
+      dimension.setPropertiesFromData([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
+      expect((dimension as any).calculatedDomain).toEqual([
+        1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
+      ]);
+    });
+  });
+
+  describe('integration: setNumBins', () => {
+    it('sets the calculatedNumBins correctly', () => {
+      dimension.setPropertiesFromData([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
+      expect((dimension as any).calculatedNumBins).toEqual(4);
+    });
+  });
+
+  describe('integration: getScale', () => {
+    let scale: any;
+    beforeEach(() => {
+      dimension.setPropertiesFromData([0, 2, 4, 6]);
+      scale = dimension.getScale();
+    });
+    it('correctly sets the domain', () => {
+      expect(scale.domain()).toEqual([0, 2, 4, 6]);
+    });
+    it('correctly sets the range', () => {
+      expect(scale.range()).toEqual(['red', 'blue', 'yellow', 'green']);
+    });
+    it('correctly scales a value in the domain', () => {
+      expect(scale(2)).toEqual('blue');
+    });
+    it('correctly scales a value out of the domain', () => {
+      expect(scale(null)).toEqual('black');
+    });
+  });
+});

package/src/lib/geographies/config/layers/attribute-data-layer/dimensions/equal-frequencies-bins/equal-frequencies-bins.ts

@@ -0,0 +1,56 @@
+import { safeAssign } from '@mathstack/app-kit';
+import { BinStrategy } from '../attribute-data-bin-enums';
+import { CalculatedBinsAttributeDataDimension } from '../calculated-bins/calculated-bins';
+import { EqualFrequenciesAttributeDataDimensionOptions } from './equal-frequencies-bins-options';
+
+/**
+ * Configuration object for attribute data that is quantitative and will be binned into equal number of observations. For example, if the data is [0, 1, 2, 4, 60, 100] and numBins is 2, the bin ranges will be [0, 2] and [4, 100].
+ *
+ * The generic parameter is the type of the attribute data.
+ */
+export class EqualFrequenciesAttributeDataDimension<
+  Datum,
+  RangeValue extends string | number = string,
+>
+  extends CalculatedBinsAttributeDataDimension<Datum, RangeValue>
+  implements EqualFrequenciesAttributeDataDimensionOptions<Datum, RangeValue>
+{
+  override readonly binType: BinStrategy.equalFrequencies;
+  private calculatedDomain: number[];
+  readonly numBins: number;
+
+  constructor(
+    options: EqualFrequenciesAttributeDataDimensionOptions<Datum, RangeValue>
+  ) {
+    super('number');
+    this.binType = BinStrategy.equalFrequencies;
+    safeAssign(this, options);
+    if (!this.valueAccessor) {
+      console.error(
+        'Value accessor is required for EqualNumObservationsAttributeDataDimension'
+      );
+    }
+  }
+
+  setPropertiesFromData(data: Datum[]): void {
+    const values = data.map(this.valueAccessor);
+    this.setDomain(values);
+    this.setNumBins();
+    this.setRange();
+  }
+
+  protected setDomain(values: number[]): void {
+    this.calculatedDomain = values;
+  }
+
+  private setNumBins(): void {
+    this.calculatedNumBins = this.numBins;
+  }
+
+  getScale() {
+    return this.scale()
+      .domain(this.calculatedDomain)
+      .range(this.range)
+      .unknown(this.nullColor);
+  }
+}

package/src/lib/geographies/config/layers/attribute-data-layer/dimensions/equal-value-ranges-bins/equal-value-ranges-bins-builder.ts

@@ -0,0 +1,60 @@
+import { safeAssign } from '@mathstack/app-kit';
+import { interpolateLab, scaleQuantize } from 'd3';
+import { CalculatedBinsAttributeDataDimensionBuilder } from '../calculated-bins/calculated-bins-builder';
+import { EqualValueRangesAttributeDataDimension } from './equal-value-ranges-bins';
+
+const DEFAULT = {
+  _interpolator: interpolateLab,
+  _nullColor: 'whitesmoke',
+  _numBins: 3,
+  _range: ['white', 'pink', 'red'],
+  _scale: scaleQuantize,
+};
+
+export class EqualValueRangesBinsBuilder<
+  Datum,
+  RangeValue extends string | number = string,
+> extends CalculatedBinsAttributeDataDimensionBuilder<Datum, RangeValue> {
+  private _domain: [number, number];
+  private _numBins: number;
+
+  constructor() {
+    super();
+    safeAssign(this, DEFAULT);
+  }
+
+  /**
+   * OPTIONAL. The domain of the scale. If not set, the domain will be inferred from the data.
+   */
+  domain(domain: [number, number]): this {
+    this._domain = domain;
+    return this;
+  }
+
+  /**
+   * OPTIONAL. The number of bins to create.
+   *
+   * @default 3
+   */
+  numBins(numBins: number): this {
+    this._numBins = numBins;
+    return this;
+  }
+
+  /**
+   * @internal This method is not intended to be used by consumers of this library.
+   */
+  _build(): EqualValueRangesAttributeDataDimension<Datum, RangeValue> {
+    return new EqualValueRangesAttributeDataDimension({
+      domain: this._domain,
+      formatFunction: this._formatFunction,
+      formatSpecifier: this._formatSpecifier,
+      interpolator: this._interpolator,
+      nullColor: this._nullColor,
+      numBins: this._numBins,
+      range: this._range,
+      scale: this._scale,
+      valueAccessor: this._valueAccessor,
+    });
+  }
+}

package/src/lib/geographies/config/layers/attribute-data-layer/dimensions/equal-value-ranges-bins/equal-value-ranges-bins-options.ts

@@ -0,0 +1,9 @@
+import { CalculatedBinsAttributeDataDimensionOptions } from '../calculated-bins/calculated-bins-options';
+
+export interface EqualValueRangesAttributeDataDimensionOptions<
+  Datum,
+  RangeValue extends string | number = string,
+> extends CalculatedBinsAttributeDataDimensionOptions<Datum, RangeValue> {
+  domain: [number, number];
+  numBins: number;
+}