src/render/datum.ts

Functions

Imports

It imports no other module of this repo. Imported by src/lite/bar.ts, src/lite/series.ts, src/render/bar-model.ts, src/render/line-model.ts, src/render/plot.ts.

Source

1/** What the enhancement layer reads from each drawn datum, as attributes on its element. */
2
3/** What the enhancement layer needs to know about one drawn datum. */
4export interface MarkDatum {
5  /** Unique within the chart and stable across re-renders of the same data (for transitions). */
6  readonly key: string;
7  /** The value a click filters on, and the name of the field it belongs to. */
8  readonly filter?: { readonly field: string; readonly value: string };
9  /** The x value as text, for brush and hover. */
10  readonly x?: string;
11  /** The series name, when the chart has series. */
12  readonly series?: string;
13  /**
14   * The mark's place for keyboard reading order: its category (column) and its position within
15   * the category (row). Taken from the data, not the drawing, so order is right in facets and in
16   * charts enhanced while hidden (F9).
17   */
18  readonly column?: number;
19  readonly row?: number;
20}
21
22/** A datum's keys as attribute names and values, in the order they are written. */
23export function datumAttributes(datum: MarkDatum): [string, string][] {
24  const out: [string, string][] = [["data-enarratio-key", datum.key]];
25  if (datum.filter) {
26    out.push(["data-enarratio-field", datum.filter.field]);
27    out.push(["data-enarratio-value", datum.filter.value]);
28  }
29  if (datum.x !== undefined) out.push(["data-enarratio-x", datum.x]);
30  if (datum.series !== undefined) out.push(["data-enarratio-series", datum.series]);
31  if (datum.column !== undefined) out.push(["data-enarratio-col", String(datum.column)]);
32  if (datum.row !== undefined) out.push(["data-enarratio-row", String(datum.row)]);
33  return out;
34}