@martinomagnifico/tablechart 1.0.3 → 1.0.4

package/dist/tablechart-core.d.ts

@@ -1,313 +0,0 @@
-/** A Markdown table, or a caption with chart attributes, is wrapped in a div with the caption and annotations beside it. */
-export declare const adoptTables: (figures: HTMLElement[]) => HTMLElement[];
-
-/** `create` runs before layout, so a translation script finds its text; `draw` only places it. */
-declare interface AnnotationType {
-    create: (spec: HTMLElement, plot: HTMLElement) => HTMLElement | null;
-    draw: (spec: HTMLElement, badge: HTMLElement | null, geo: Geometry) => void;
-}
-
-/** Writes translation keys such as `harvest-row1` onto a figure with `data-chart-keys`; a duplicate prefix gets a number. */
-export declare const assignKeys: (figures: HTMLElement[], langattribute: string | false) => void;
-
-/** Pass 2: everything a reader will read, before a translation script looks. */
-export declare const build: (figure: HTMLElement, config: Config, asKind?: string | null) => ChartState | null;
-
-declare interface Cell {
-    raw: string;
-    /** As written, so its decimal places survive. Empty when the cell holds no number. */
-    number: string;
-    /** Text around the number, such as `%` or a footnote `*`, kept either side of the formatted number. */
-    prefix: string;
-    suffix: string;
-    /** No number, such as "n/a": no mark, and the label says what the cell says. Counts as zero. */
-    missing: boolean;
-    value: number;
-}
-
-export declare interface ChartState {
-    figure: HTMLElement;
-    plot: HTMLElement;
-    svg: SVGSVGElement;
-    rows: Row[];
-    decimals: number;
-    type: ChartType;
-    values: HTMLElement[];
-    series: Series[];
-    seriesValues: HTMLElement[][];
-    names: HTMLElement[];
-    categories: HTMLElement[];
-    centre: HTMLElement | null;
-    stacked: boolean;
-    totals: HTMLElement[];
-    totalCell: HTMLElement | null;
-    /** In screen pixels from the plot's corner. Null for a chart whose rows are not side by side. */
-    rowAt: ((x: number, y: number) => number | null) | null;
-    /** As percentages: left, top, width and height. */
-    rowBox: ((index: number) => [number, number, number, number]) | null;
-    annotations: {
-        spec: HTMLElement;
-        type: AnnotationType;
-        badge: HTMLElement | null;
-        /** From 0; `data-series` counts from 1. */
-        series: number;
-        after: number;
-    }[];
-    /** The steps of a chart that steps (`data-fragment`); null for one that does not. */
-    plan: StepPlan | null;
-    /** How many steps are shown. */
-    step: number;
-    /** The Previous and Next buttons, if Tablechart made them. */
-    controls: HTMLElement | null;
-    checks: Check[];
-}
-
-declare interface ChartType {
-    aspect?: number;
-    /** A row marked as a total goes in the middle rather than among the marks. */
-    centre?: boolean;
-    /** A break in the scale works here; a waterfall keeps its floating steps clear of it. */
-    breakable?: boolean;
-    stackable?: boolean;
-    /** A stack is a running sum, so each line follows the one under it; otherwise values below zero stack down from zero. */
-    running?: boolean;
-    totals?: boolean;
-    /** The sample in front of a legend name when it is not a line; the legend shows only when asked. */
-    swatch?: "box";
-    categories?: "under" | "beside";
-    series?: boolean;
-    /** With several series, always a legend, with a sample of this shape. */
-    legend?: "box";
-    headroom?: (geo: HeadroomInput) => number;
-    minHeight?: (input: {
-        labelHeight: number;
-        nameHeight: number;
-        unit: number;
-        rows: number;
-        series: number;
-        stacked: boolean;
-    }) => number;
-    /** Room under the baseline for numbers that hang below a mark near it. */
-    footroom?: (geo: HeadroomInput) => number;
-    /** Default: one bar per row from the baseline. */
-    segments?: (rows: Row[]) => Segment[];
-    draw: (geo: Geometry) => void;
-}
-
-declare interface Check {
-    label: string;
-    computed: number;
-    stated: number;
-    agrees: boolean;
-}
-
-export declare interface Config {
-    /** Which elements Tablechart turns into charts. */
-    selector: string;
-    /** Height of the plot as a share of its width. */
-    aspect: number;
-    /** Share of a band that a bar fills. */
-    barfill: number;
-    /** Share of a donut's radius that the ring itself takes. */
-    ringfill: number;
-    /** Locale for numbers. Unset, the document's language is used and followed when it changes. */
-    locale?: string;
-    /** Animate a chart when it builds. `"up"` grows lines and areas from zero instead of across; a figure overrides it with `data-chart-animate`. */
-    animate: boolean | "across" | "up";
-    /** How far an animated parent is in before its chart builds: 0 when it starts moving, 1 when it is in. A figure overrides it with `data-chart-entrance`. */
-    entrance: number;
-    /** Where a column's number goes: on the bar, or inside it. A figure overrides it with `data-chart-labels`. */
-    labels: "outside" | "inside";
-    /** How a line or area runs between points: `straight`, `step` or `smooth`. A figure overrides it with `data-chart-shape`. */
-    shape: "straight" | "step" | "smooth";
-    /** Names of several lines in a legend instead of at the end of each line. A figure overrides it with `data-chart-legend`. */
-    legend: boolean;
-    /** Pointing at a row shows numbers that were left out for lack of room. A figure turns it off with `data-chart-hover="false"`. */
-    hover: boolean;
-    /** The name of the total that a donut without a total row works out, for screen readers. */
-    totallabel: string;
-    /** Previous and Next buttons under a chart that steps (`data-fragment`). `false` leaves them out, for buttons of your own. */
-    controls: boolean;
-    /** The text of the Previous button. */
-    previouslabel: string;
-    /** The text of the Next button. */
-    nextlabel: string;
-    /** Read by screen readers after the text of each button, so they know it only changes the chart. */
-    stephint: string;
-    /** How much of a chart must be in view before it builds, from 0 to 1. */
-    threshold: number;
-    /** Build again each time a chart scrolls back into view, not only the first time. */
-    replay: boolean;
-    /** The attribute for translation keys, for a translation script. `false` turns keys off. */
-    langattribute: string | false;
-    /** Show messages in the console for whoever is working on the page. */
-    debug?: boolean;
-}
-
-export declare const defaultConfig: Config;
-
-/** How far an animated parent is in before the chart builds: the figure's `data-chart-entrance`, or else the option. */
-export declare const entranceOf: (figure: HTMLElement, config: Config) => number;
-
-/** Scales only, no pixel positions, so an annotation follows the data. */
-declare interface Geometry {
-    rows: Row[];
-    segments: Segment[];
-    cx: (index: number) => number;
-    y: (value: number) => number;
-    barWidth: number;
-    barMax: number;
-    height: number;
-    /** viewBox units per screen pixel. */
-    unit: number;
-    labelHeight: number;
-    badgeHeight: number;
-    /** How many stagger steps the data takes, so commentary can land after it. */
-    after: number;
-    /** An annotation's number in the figure, from 1, set as `data-note` on its marks. Zero for the chart. */
-    note: number;
-    /** Where the break's mark goes, as a value. Null when the scale runs straight through. */
-    breakAt: number | null;
-    /** The break itself, for a chart that makes a scale of its own, such as a bar chart. */
-    squeeze: Squeeze | null;
-    /** The empty space where the scale jumps, in viewBox units. */
-    breakGap: number;
-    /** Where a bar chart is cut across, in viewBox units; set by its drawing. */
-    breakX?: number;
-    labels: "outside" | "inside";
-    /** Where a number inside its bar goes, from `--tablechart-inside-align`; null for the chart's own default. */
-    insideAlign: "start" | "center" | "end" | null;
-    stacked: boolean;
-    shape: Shape;
-    /** Empty when the chart is not stacked or its kind shows no totals. */
-    totals: HTMLElement[];
-    svg: SVGSVGElement;
-    plot: HTMLElement;
-    /** Made by `build`; a chart only places them. */
-    values: HTMLElement[];
-    series: Series[];
-    seriesValues: HTMLElement[][];
-    /** Empty with one series. */
-    names: HTMLElement[];
-    /** A chart with its names beside the marks places these; one with them under the plot does not. */
-    categories: HTMLElement[];
-    centre: HTMLElement | null;
-    config: Config;
-    /** Numbers an annotation worked out, against the ones the author wrote. */
-    checks: Check[];
-}
-
-declare interface HeadroomInput {
-    labelHeight: number;
-    badgeHeight: number;
-    hasAnnotations: boolean;
-    unit: number;
-    series: number;
-    focused: boolean;
-    stacked: boolean;
-}
-
-/** Pass 3. Needs layout; makes no text, only places it. */
-export declare const layout: (state: ChartState, config: Config) => boolean;
-
-/** `data-chart-src` fills the figure's table with the rows of a JSON file, keeping a header row the author wrote; a file that fails is reported. */
-export declare const loadSources: (figures: HTMLElement[]) => Promise<void>;
-
-export declare const PLACED_CLASS = "is-placed";
-
-export declare const PLOT_CLASS = "tablechart-plot";
-
-/** Turns elements into figures with a table and translation keys, all at once, so duplicate keys are found. */
-export declare const prepare: (found: HTMLElement[], config: Config) => Promise<HTMLElement[]>;
-
-export declare const QUEUED_CLASS = "tablechart-queued";
-
-/** In a Markdown table, a bold label makes the row a total, and a bold header puts that series in focus. */
-export declare const readMarkdownRows: (figures: HTMLElement[]) => void;
-
-/** Numbers are reformatted in place, so a language change costs no redraw. */
-export declare const relabel: (state: ChartState, config: Config) => void;
-
-export declare interface Row extends Cell {
-    label: string;
-    key: string | null;
-    cells: Cell[];
-    /** Copied to everything drawn for the row, so one class styles all of it. */
-    classes: string[];
-    isTotal: boolean;
-    /** The stagger counts from here. */
-    slot: number;
-}
-
-declare interface Segment extends Row {
-    from: number;
-    to: number;
-    kind: "bar" | "up" | "down" | "total";
-}
-
-export declare interface Series {
-    name: string;
-    key: string | null;
-    /** `data-kind="focus"`, or bold in Markdown: the others are shown fainter. */
-    focus: boolean;
-    /** `data-marker` on the header, such as `square` or `diamond open`. */
-    marker: string | null;
-    line: "dashed" | "dotted" | null;
-}
-
-/** One class, `is-shown`, starts the whole build. */
-export declare const setShown: (state: ChartState, shown: boolean) => void;
-
-/** How a line or an area runs from one point to the next. */
-declare type Shape = "straight" | "step" | "smooth";
-
-export declare const SHOWN_CLASS = "is-shown";
-
-/** A break in the scale: values from `lo` to `hi` get `share` of the length, and the cut is at `gap`. */
-declare interface Squeeze {
-    lo: number;
-    hi: number;
-    gap: number;
-    share: number;
-}
-
-/** The steps of one chart: which step shows each row, column and annotation, and how many steps there are. */
-export declare interface StepPlan {
-    rows: {
-        step: number | null;
-        slot: number;
-    }[];
-    series: {
-        step: number | null;
-    }[];
-    /** A cell on a step of its own, by row and then by column. */
-    cells: {
-        step: number | null;
-        slot: number;
-    }[][];
-    notes: {
-        step: number | null;
-        after: number;
-    }[];
-    count: number;
-    /** The `data-fragment-index` of each step, if it asked for one, so a presentation can make a fragment for each. */
-    indexes: (string | null)[];
-}
-
-/**
- * Shows the chart up to step `step`, from 0 (only what has no step) to the number of steps (all of it).
- * Says so with a `tablechart:step` event on the figure, unless `quietly`.
- */
-export declare const stepTo: (state: ChartState, step: number, quietly?: boolean) => void;
-
-/** Removes what `build` added, so the chart can be built again. */
-export declare const unbuild: (state: ChartState) => void;
-
-export { }
-
-
-declare global {
-    interface HTMLElement {
-        tablechart?: TablechartChart;
-    }
-}

package/dist/tablechart.d.ts

@@ -1,85 +0,0 @@
-/** Makes a chart of one element; returns the existing chart if there is one, or null without data. */
-export declare const create: (element: HTMLElement, options?: Partial<TablechartConfig>) => Promise<TablechartChart | null>;
-
-export declare const defaultConfig: TablechartConfig;
-
-/** Makes a chart of every element in `root` that matches the selector, skipping existing charts. */
-export declare const init: (options?: Partial<TablechartConfig>, root?: ParentNode) => Promise<TablechartInstance>;
-
-export declare interface TablechartChart {
-    figure: HTMLElement;
-    /** Lays the chart out again, for example after a script has changed its text. */
-    refresh(): void;
-    /** Stops watching scroll, size and language. The chart stays as it is. */
-    destroy(): void;
-    /** On a chart that steps (`data-fragment`): shows one step more. */
-    next(): void;
-    /** On a chart that steps: shows one step less. */
-    previous(): void;
-    /** On a chart that steps: shows the chart up to `step`, from 0 to `steps`. */
-    stepTo(step: number): void;
-    /** How many steps are shown. */
-    readonly step: number;
-    /** How many steps the chart has; 0 for a chart that does not step. */
-    readonly steps: number;
-}
-
-export declare interface TablechartConfig {
-    /** Which elements Tablechart turns into charts. */
-    selector: string;
-    /** Height of the plot as a share of its width. */
-    aspect: number;
-    /** Share of a band that a bar fills. */
-    barfill: number;
-    /** Share of a donut's radius that the ring itself takes. */
-    ringfill: number;
-    /** Locale for numbers. Unset, the document's language is used and followed when it changes. */
-    locale?: string;
-    /** Animate a chart when it builds. `"up"` grows lines and areas from zero instead of across; a figure overrides it with `data-chart-animate`. */
-    animate: boolean | "across" | "up";
-    /** How far an animated parent is in before its chart builds: 0 when it starts moving, 1 when it is in. A figure overrides it with `data-chart-entrance`. */
-    entrance: number;
-    /** Where a column's number goes: on the bar, or inside it. A figure overrides it with `data-chart-labels`. */
-    labels: "outside" | "inside";
-    /** How a line or area runs between points: `straight`, `step` or `smooth`. A figure overrides it with `data-chart-shape`. */
-    shape: "straight" | "step" | "smooth";
-    /** Names of several lines in a legend instead of at the end of each line. A figure overrides it with `data-chart-legend`. */
-    legend: boolean;
-    /** Pointing at a row shows numbers that were left out for lack of room. A figure turns it off with `data-chart-hover="false"`. */
-    hover: boolean;
-    /** The name of the total that a donut without a total row works out, for screen readers. */
-    totallabel: string;
-    /** Previous and Next buttons under a chart that steps (`data-fragment`). `false` leaves them out, for buttons of your own. */
-    controls: boolean;
-    /** The text of the Previous button. */
-    previouslabel: string;
-    /** The text of the Next button. */
-    nextlabel: string;
-    /** Read by screen readers after the text of each button, so they know it only changes the chart. */
-    stephint: string;
-    /** How much of a chart must be in view before it builds, from 0 to 1. */
-    threshold: number;
-    /** Build again each time a chart scrolls back into view, not only the first time. */
-    replay: boolean;
-    /** The attribute for translation keys, for a translation script. `false` turns keys off. */
-    langattribute: string | false;
-    /** Show messages in the console for whoever is working on the page. */
-    debug?: boolean;
-}
-
-export declare interface TablechartInstance {
-    charts: TablechartChart[];
-    /** Lays out every chart again, for example after a script has changed its text. */
-    refresh(): void;
-    /** Stops watching scroll, size and language. The charts stay as they are. */
-    destroy(): void;
-}
-
-export { }
-
-
-declare global {
-    interface HTMLElement {
-        tablechart?: TablechartChart;
-    }
-}