Date

Statistics

LineUp-lite computes the following statistics for a date attribute:

/**
 * on which granularity level is the histogram computed
 */
export declare type DateHistGranularity = 'year' | 'month' | 'day' | 'decade';

export interface IDateStats extends INumericStats<Date> {
  /**
   * the granularity in which the histogram is computed
   */
  readonly histGranularity: DateHistGranularity;
}

see IDateStats API Docs

Generator Function

The stats generator function has the following signature. It returns a function that can be used to compute statistics for a given array.

export function dateStatsGenerator(options: DateStatsOptions = {}): (arr: readonly (Date | null)[]) => IDateStats;

see dateStatsGenerator API Docs

Example

Live Editor

// import { dateStatsGenerator } from '@lineup-lite/components'; function Example() { const compute = dateStatsGenerator(); const data = [ new Date(2008, 11, 1), new Date(2008, 8, 1), new Date(2008, 4, 1), new Date(2009, 2, 1), new Date(2010, 9, 1), new Date(2010, 1, 1), new Date(2018, 1, 1), ]; const stats = compute(data); return <pre>{JSON.stringify(stats, null, 2)}</pre>; }

// import { dateStatsGenerator } from '@lineup-lite/components';

function Example() {
  const compute = dateStatsGenerator();
  const data = [
    new Date(2008, 11, 1),
    new Date(2008, 8, 1),
    new Date(2008, 4, 1),
    new Date(2009, 2, 1),
    new Date(2010, 9, 1),
    new Date(2010, 1, 1),
    new Date(2018, 1, 1),
  ];
  const stats = compute(data);

  return <pre>{JSON.stringify(stats, null, 2)}</pre>;
}

Result

Loading...

Visualization

Cell

DateLabel React component

Live Editor

// import { dateStatsGenerator, DateLabel } from '@lineup-lite/components'; function Example() { const compute = dateStatsGenerator(); const data = [ new Date(2008, 11, 1), new Date(2008, 8, 1), new Date(2008, 4, 1), new Date(2009, 2, 1), new Date(2010, 9, 1), new Date(2010, 1, 1), new Date(2018, 1, 1), ]; const stats = compute(data); return ( <div> <DateLabel value={data[0]} format={stats.format} /> <DateLabel value={data[1]} format={stats.format} /> <DateLabel value={data[2]} format={stats.format} /> </div> ); }

// import { dateStatsGenerator, DateLabel } from '@lineup-lite/components';

function Example() {
  const compute = dateStatsGenerator();
  const data = [
    new Date(2008, 11, 1),
    new Date(2008, 8, 1),
    new Date(2008, 4, 1),
    new Date(2009, 2, 1),
    new Date(2010, 9, 1),
    new Date(2010, 1, 1),
    new Date(2018, 1, 1),
  ];
  const stats = compute(data);

  return (
    <div>
      <DateLabel value={data[0]} format={stats.format} />
      <DateLabel value={data[1]} format={stats.format} />
      <DateLabel value={data[2]} format={stats.format} />
    </div>
  );
}

Result

Loading...

Aggregation

Histogram React component

Live Editor

// import { dateStatsGenerator, Histogram } from '@lineup-lite/components'; function Example() { const compute = dateStatsGenerator(); const data = [ new Date(2008, 11, 1), new Date(2008, 8, 1), new Date(2008, 4, 1), new Date(2009, 2, 1), new Date(2010, 9, 1), new Date(2010, 1, 1), new Date(2018, 1, 1), ]; const stats = compute(data); return <Histogram s={stats} style={{ height: 100 }} />; }

// import { dateStatsGenerator, Histogram } from '@lineup-lite/components';

function Example() {
  const compute = dateStatsGenerator();
  const data = [
    new Date(2008, 11, 1),
    new Date(2008, 8, 1),
    new Date(2008, 4, 1),
    new Date(2009, 2, 1),
    new Date(2010, 9, 1),
    new Date(2010, 1, 1),
    new Date(2018, 1, 1),
  ];
  const stats = compute(data);

  return <Histogram s={stats} style={{ height: 100 }} />;
}

Result

Loading...

Interactive Summary

FilterRangeHistogram React component

Live Editor

// import { dateStatsGenerator, FilterRangeHistogram } from '@lineup-lite/components'; function Example() { const compute = dateStatsGenerator(); const data = [ new Date(2008, 11, 1), new Date(2008, 8, 1), new Date(2008, 4, 1), new Date(2009, 2, 1), new Date(2010, 9, 1), new Date(2010, 1, 1), new Date(2018, 1, 1), ]; const stats = compute(data); const [filterValue, setFilter] = React.useState(null); const filtered = filterValue ? data.filter( (d) => (filterValue[0] == null || filterValue[0] <= d) && (filterValue[1] == null || d <= filterValue[1]) ) : data; const filteredStats = dateStatsGenerator({ min: stats.min, max: stats.max })(filtered); return ( <FilterRangeHistogram s={filteredStats} preFilter={stats} filterValue={filterValue} setFilter={setFilter} summary style={{ height: 100 }} /> ); }

// import { dateStatsGenerator, FilterRangeHistogram } from '@lineup-lite/components';

function Example() {
  const compute = dateStatsGenerator();
  const data = [
    new Date(2008, 11, 1),
    new Date(2008, 8, 1),
    new Date(2008, 4, 1),
    new Date(2009, 2, 1),
    new Date(2010, 9, 1),
    new Date(2010, 1, 1),
    new Date(2018, 1, 1),
  ];
  const stats = compute(data);

  const [filterValue, setFilter] = React.useState(null);
  const filtered = filterValue
    ? data.filter(
        (d) => (filterValue[0] == null || filterValue[0] <= d) && (filterValue[1] == null || d <= filterValue[1])
      )
    : data;
  const filteredStats = dateStatsGenerator({ min: stats.min, max: stats.max })(filtered);

  return (
    <FilterRangeHistogram
      s={filteredStats}
      preFilter={stats}
      filterValue={filterValue}
      setFilter={setFilter}
      summary
      style={{ height: 100 }}
    />
  );
}

Result

Loading...