@dou-ui/chart 0.0.0-stage → 0.1.0-alpha.1

package/dist/types/overlay.vue.d.ts

@@ -0,0 +1,95 @@
+import { type Tone } from 'dou-ui';
+import { type ComputedRef, type VNodeChild } from 'vue';
+import type { TickLabel } from './core/layout';
+import type { PlacedDataLabel } from './core/labels';
+import type { LegendBox } from './core/layout';
+import type { MarkerLabel } from './core/marker';
+/**
+ * The text over the canvas: tick labels, titles, the legend and what goes
+ * in a donut's hole. Kept apart from the chart, so laying it out again
+ * doesn't render the chart's slot again: a part written with a new
+ * function each render (`:format="(v) => …"`) would otherwise be laid out
+ * again and again.
+ */
+export interface OverlayState {
+    shown: ComputedRef<boolean>;
+    labels: ComputedRef<Array<TickLabel & {
+        key: string;
+        axis: string;
+    }>>;
+    titles: ComputedRef<Array<{
+        key: string;
+        text: string;
+        left: number;
+        top: number;
+        align: 'start' | 'end';
+    }>>;
+    legend: ComputedRef<Array<{
+        index: number;
+        text: string;
+        left: number;
+        top: number;
+        color: string;
+        kind: string;
+        dashed: boolean;
+        /** Turned off. */
+        off: boolean;
+        /** The last one shown: it can't be turned off. */
+        locked: boolean;
+        /** The room it takes, swatch and name, in px. */
+        width: number;
+        /** Its name is cut short to the room down the side. */
+        clipped?: boolean;
+        /** A heatmap's scale: its colors, least to most, in a swatch `swatch` px wide. */
+        scale?: string[];
+        swatch?: number;
+        /** The pattern over its color, as a CSS background image and its size. */
+        pattern?: {
+            image: string;
+            size?: string;
+        };
+    }>>;
+    /** Where the legend shows; its entries scroll in it when they don't all fit. */
+    legendBox: ComputedRef<LegendBox | undefined>;
+    /** Turns the series (or slice) at `index` on or off. */
+    toggle: (index: number) => void;
+    /** Shows only the series (or slice) at `index`, or all again. */
+    isolate: (index: number) => void;
+    /** How to show one entry alone, read out with each entry. */
+    hint: ComputedRef<string>;
+    /** Brings the series at `index` forward while the pointer or focus is on its entry; `null` to stop. */
+    focus: (index: number | null) => void;
+    /** Where the donut's hole is, if there is one to fill. */
+    hole: ComputedRef<{
+        left: number;
+        top: number;
+        width: number;
+        above?: boolean;
+    } | null>;
+    center: () => VNodeChild;
+    /** The markers' labels. */
+    markers: ComputedRef<Array<MarkerLabel & {
+        key: string;
+        tone: Tone;
+        backdrop: boolean;
+    }>>;
+    /** Data labels: values by the points and on the bars; `ink` is their color, when not the default. */
+    data: ComputedRef<Array<PlacedDataLabel & {
+        ink?: string;
+        width?: number;
+    }>>;
+    /** Whether the data labels show (not while the series come in). */
+    dataShown: ComputedRef<boolean>;
+    /** The series brought forward: the other series' labels are faded too. */
+    dataFocus: ComputedRef<number | null>;
+    /** No series has a value: the empty message shows. */
+    empty: ComputedRef<boolean>;
+    emptyContent: () => VNodeChild;
+    loading: ComputedRef<boolean>;
+}
+type __VLS_Props = {
+    state: OverlayState;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/types/pointer.vue.d.ts

@@ -0,0 +1,53 @@
+import { type ComputedRef, type Ref } from 'vue';
+import type { Rect } from './core/painter';
+import type { ChartTooltipItem, ChartTooltipSlots } from './types';
+/** What is shown for the point (or x) under the pointer. */
+export interface Tip {
+    title?: string;
+    items: ChartTooltipItem[];
+    /** One of the items' series is under the pointer: the others are muted. */
+    focused?: boolean;
+    /** Where the tooltip points from, in px from the chart's top left. */
+    anchor: [number, number];
+    /** A hairline across the plot at the x. */
+    line?: Rect;
+    /** A shaded band over the x's room, for bars. */
+    band?: Rect;
+    /** A ring around a heatmap's cell. */
+    cell?: Rect;
+    /** Rings and dots on the points. */
+    marks: Array<{
+        left: number;
+        top: number;
+        color: string;
+        radius: number;
+        ring: boolean;
+        /** Its series is faded: another one is under the pointer. */
+        faded?: boolean;
+    }>;
+    /** Above the anchor rather than below, out from under a finger. */
+    above?: boolean;
+    /** A place to keep clear of (the x under a finger): the tooltip goes beside it. */
+    clear?: Rect;
+    /** A line under the values (slices left out of a pie). */
+    note?: string;
+    /** The x as given, for `select`. */
+    x?: unknown;
+}
+export interface PointerState {
+    tip: ComputedRef<Tip | null>;
+    /** The chart's size, to keep the tooltip inside it. */
+    size: ComputedRef<{
+        width: number;
+        height: number;
+    } | null>;
+    content: Ref<ChartTooltipSlots['default'] | undefined>;
+    /** Read out as the keys move. */
+    live: ComputedRef<string>;
+}
+type __VLS_Props = {
+    state: PointerState;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/types/static.vue.d.ts

@@ -0,0 +1,24 @@
+import { type ComputedRef } from 'vue';
+/**
+ * The chart drawn on the server, as an SVG filling the chart's box. Its own
+ * component, after the chart's parts: on the server those are known only
+ * once the chart's slot has rendered. In the browser it keeps the
+ * server's drawing until the canvas has drawn.
+ */
+export interface StaticState {
+    shown: ComputedRef<boolean>;
+    size: ComputedRef<{
+        width: number;
+        height: number;
+    }>;
+    /** The drawing; empty in the browser, which takes the server's. */
+    markup: ComputedRef<string>;
+    /** What the chart shows, read out. */
+    label: ComputedRef<string>;
+}
+type __VLS_Props = {
+    state: StaticState;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/types/table.vue.d.ts

@@ -0,0 +1,19 @@
+import type { ComputedRef } from 'vue';
+/** The chart's data as a table, shown in its place. */
+export interface TableState {
+    shown: ComputedRef<boolean>;
+    caption: ComputedRef<string>;
+    head: ComputedRef<string[]>;
+    /** Each row's cells; the first is the row's head. */
+    rows: ComputedRef<string[][]>;
+    /** A line under a table cut short. */
+    more: ComputedRef<string>;
+    /** Escape in the table: back to the chart. */
+    close: () => void;
+}
+type __VLS_Props = {
+    state: TableState;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;