@mathstack/viz 2.1.0 → 2.2.0

package/src/lib/data-dimensions/ordinal/ordinal-visual-value/ordinal-visual-value.ts

@@ -1,79 +0,0 @@
-import { safeAssign } from '@mathstack/app-kit';
-import { InternSet, scaleOrdinal } from 'd3';
-import { DataValue, VisualValue } from '../../../core/types/values';
-import { DataDimension } from '../../dimension';
-import { OrdinalVisualValueDimensionOptions } from './ordinal-visual-value-options';
-
-/**
- * A dimension that transforms string / number / Date values into a value of type number or string.
- *
- * This dimension is intended to be used to set a visual property of an element in a chart.
- *
- * The first generic is the type of the data that will be passed to the dimension. The second generic is the type of the value that will be used to set the visual property. The third generic is the type of the range of the scale / the output value.
- *
- * TESTABLE FUNCTIONALITY
- *
- * - It extracts values for the dimension from data.
- *   - tested in: ordinal-visual-value.cy.ts
- * - It sets the domain of the dimension.
- *   - tested in: ordinal-visual-value.cy.ts
- * - It checks if a value is in the domain.
- * - The domain can be set by the user passing in an array of values.
- *   - tested in: ordinal-chart-position.spec.ts
- * - The domain will be unique values from the data if no custom domain is given by the user.
- *   - tested in: ordinal-chart-position.spec.ts
- * - The domain will always contain only unique values.
- *   - tested in: ordinal-chart-position.spec.ts
- */
-
-export class OrdinalVisualValueDimension<
-  Datum,
-  Domain extends DataValue,
-  Range extends VisualValue,
-> extends DataDimension<Datum, Domain> {
-  private _calculatedDomain: Domain[];
-  private readonly domain: Domain[];
-  private internSetDomain: InternSet<Domain>;
-  readonly range: Range[];
-  private scale: (category: Domain) => Range;
-
-  constructor(
-    options: OrdinalVisualValueDimensionOptions<Datum, Domain, Range>
-  ) {
-    super('ordinal');
-    safeAssign(this, options);
-  }
-
-  get calculatedDomain(): Domain[] {
-    return this._calculatedDomain;
-  }
-
-  getScale(): (category: Domain) => Range {
-    return this.scale;
-  }
-
-  setPropertiesFromData(data: Datum[]): void {
-    this.setValues(data);
-    this.setDomain();
-    this.setScale();
-  }
-
-  protected setDomain(): void {
-    let domain = this.domain;
-    if (domain === undefined) {
-      domain = this.values;
-    }
-    this.internSetDomain = new InternSet(domain);
-    this._calculatedDomain = [...this.internSetDomain.values()];
-  }
-
-  private setScale(): void {
-    if (this.scale === undefined) {
-      this.scale = scaleOrdinal([...this.internSetDomain.values()], this.range);
-    }
-  }
-
-  domainIncludes(value: Domain): boolean {
-    return this.internSetDomain.has(value);
-  }
-}

package/src/lib/data-export/data-export-config.ts

@@ -1,98 +0,0 @@
-import { safeAssign } from '@mathstack/app-kit';
-import { valueFormat } from '../core/utilities/value-format';
-import { ValueUtilities } from '../core/utilities/values';
-
-export class VicColumnConfig {
-  title: string;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  valueAccessor: (x: any) => any;
-
-  constructor(options?: Partial<VicColumnConfig>) {
-    safeAssign(this, options);
-  }
-}
-
-export class VicDataExportConfig {
-  data: unknown[];
-  /**
-   * If true, the data will be flipped.
-   * Data: {a: 1, b: 2}, {a: 3, b: 4}
-   * Output CSV:
-   * a | 1 | 3
-   * b | 2 | 4
-   */
-  flipped = false;
-  /**
-   * If provided, the flipped data's header will be set.
-   * Data: {a: 1, b: 2, category: shrimp}, {a: 3, b: 4, category: lobster}
-   * Output CSV:
-   *     shrimp | lobster
-   * a | 1      | 3
-   * b | 2      | 4
-   */
-  flippedHeaderKey: string;
-  /**
-   * Specifies the keys on each object to include in the csv,
-   * using default titles (converts thisIsAKey to This Is A Key) and values (object.thisIsAKey).
-   * Data: {myKey: 1, otherKey: 2}, {myKey: 3, otherKey: 4}
-   * defaultColumnList: [myKey]
-   * Output CSV:
-   * My Key
-   * 1
-   * 3
-   */
-  defaultColumnList: string[] = [];
-  /**
-   * If true, all keys from the first object in the data array
-   * are used to populate defaultColumnList
-   */
-  includeAllKeysAsDefault = false;
-  /**
-   * A ColumnConfig needs to be provided for any column that can't use defaults
-   * e.g. if there's a special title, the data needs to be formatted in some way,
-   * sometimes certain fields are suppressed, etc.
-   */
-  columns: VicColumnConfig[] = [];
-  marginBottom = 0;
-  constructor(config?: Partial<VicDataExportConfig>) {
-    safeAssign(this, config);
-    if (this.includeAllKeysAsDefault && this.data) {
-      this.defaultColumnList = Object.keys(this.data[0]);
-    }
-    this.defaultColumnList.forEach((key) => {
-      this.columns.push(
-        new VicColumnConfig({
-          title: key !== this.flippedHeaderKey ? this.convertToTitle(key) : key,
-          valueAccessor: (x) =>
-            x[key] instanceof Date
-              ? ValueUtilities.d3Format(x[key], valueFormat.monthYear)
-              : x[key],
-        })
-      );
-    });
-  }
-
-  convertToTitle(key: string): string {
-    /**
-     * Will convert:
-     * - thisString -> This String
-     * - 123String -> 123 String
-     * - 123string -> 123 string
-     * - string123 -> String 123
-     * - thisSTRING -> This STRING
-     * - thisSTRiNG -> This STRi NG
-     */
-    let converted_key =
-      key.charAt(0).toUpperCase() +
-      key.slice(1).replace(/([a-z])([A-Z])/g, (match, p1, p2) => p1 + ' ' + p2);
-    converted_key = converted_key.replace(
-      /([a-zA-Z])(\d+)/g,
-      (match, p1, p2) => p1 + ' ' + p2
-    );
-    converted_key = converted_key.replace(
-      /(\d+)([a-zA-Z])/g,
-      (match, p1, p2) => p1 + ' ' + p2
-    );
-    return converted_key;
-  }
-}

package/src/lib/data-export/data-export.spec.ts

@@ -1,33 +0,0 @@
-import { TestBed } from '@angular/core/testing';
-
-import { VicDataExport } from './data-export';
-import { VicDataExportConfig } from './data-export-config';
-
-describe('DataExport', () => {
-  let service: VicDataExport;
-
-  beforeEach(() => {
-    TestBed.configureTestingModule({
-      providers: [VicDataExport],
-    });
-    service = TestBed.inject(VicDataExport);
-  });
-
-  it('should be created', () => {
-    expect(service).toBeTruthy();
-  });
-
-  describe('convertToTitle function', () => {
-    it('should convert camel case to title', () => {
-      const dataExportConfig = new VicDataExportConfig();
-      expect(dataExportConfig.convertToTitle('thisString')).toBe('This String');
-      expect(dataExportConfig.convertToTitle('123String')).toBe('123 String');
-      expect(dataExportConfig.convertToTitle('123string')).toBe('123 string');
-      expect(dataExportConfig.convertToTitle('string123')).toBe('String 123');
-      expect(dataExportConfig.convertToTitle('thisSTRING')).toBe('This STRING');
-      expect(dataExportConfig.convertToTitle('thisSTRiNG')).toBe(
-        'This STRi NG'
-      );
-    });
-  });
-});

package/src/lib/data-export/data-export.ts

@@ -1,87 +0,0 @@
-import { Injectable } from '@angular/core';
-import { saveAs } from 'file-saver';
-import { cloneDeep } from 'lodash-es';
-import { unparse } from 'papaparse';
-import { VicDataExportConfig } from './data-export-config';
-
-@Injectable({ providedIn: 'root' })
-export class VicDataExport {
-  saveCSV(name: string, dataConfigs: VicDataExportConfig[]): void {
-    const blobParts = [];
-    for (const dataConfig of dataConfigs) {
-      let csv: string;
-
-      let csvData = cloneDeep(dataConfig.data);
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      csvData = csvData.map((datum: any) => {
-        const returnObj = {};
-        for (const column of dataConfig.columns) {
-          returnObj[column.title] = column.valueAccessor(datum);
-          // handle common unicode character replacements
-          // d3 format's strange default minus character https://observablehq.com/@d3/d3-format
-          if (typeof returnObj[column.title] === 'string') {
-            returnObj[column.title] = returnObj[column.title].replace(
-              /\u2212/g,
-              '-'
-            );
-          }
-        }
-        return returnObj;
-      });
-
-      if (dataConfig.flipped) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const data: any = csvData.reduce((acc: any, curr: any) => {
-          for (const key in curr) {
-            if (
-              dataConfig.flippedHeaderKey &&
-              key === dataConfig.flippedHeaderKey
-            )
-              continue;
-
-            const valueToAdd =
-              curr[key] instanceof String || typeof curr[key] === 'string'
-                ? `"${curr[key]}"`
-                : curr[key];
-            if (key in acc) {
-              acc[key] += `,${valueToAdd}`;
-            } else {
-              acc[key] = `${valueToAdd}`;
-            }
-          }
-          return acc;
-        }, {});
-
-        csv = '';
-        if (dataConfig.flippedHeaderKey) {
-          csv += ',';
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          csv += csvData.reduce((acc: any, curr: any) => {
-            if (acc !== '') {
-              acc += `,${curr[dataConfig.flippedHeaderKey]}`;
-            } else {
-              acc += `${curr[dataConfig.flippedHeaderKey]}`;
-            }
-            return acc;
-          }, '');
-        }
-
-        for (const key of Object.keys(data)) {
-          if (csv !== '') {
-            csv += '\r\n';
-          }
-          csv += `${key},${data[key]}`;
-        }
-      } else {
-        csv = unparse(csvData);
-      }
-
-      for (let i = 0; i < dataConfig.marginBottom; i++) {
-        csv = `${csv}\r\n`;
-      }
-      blobParts.push(csv);
-    }
-    const blob = new Blob(blobParts, { type: 'text/csv;charset=utf-8' });
-    saveAs.saveAs(blob, `${name}.csv`);
-  }
-}

package/src/lib/data-export/index.ts

@@ -1,2 +0,0 @@
-export * from './data-export';
-export * from './data-export-config';