vue-chrts 2.0.0 → 2.1.0-beta-2

package/dist/components/DagreGraph/types.d.ts

@@ -0,0 +1,249 @@
+import { BulletLegendItemInterface, LegendPosition } from '../../types';
+/**
+ * Dagre layout direction options
+ */
+export type DagreRankDir = "TB" | "BT" | "LR" | "RL";
+/**
+ * Dagre layout alignment options
+ */
+export type DagreAlign = "UL" | "UR" | "DL" | "DR";
+/**
+ * Dagre ranking algorithm options
+ */
+export type DagreRanker = "network-simplex" | "tight-tree" | "longest-path";
+/**
+ * Node shape options
+ */
+export type NodeShape = "circle" | "square" | "triangle" | "diamond";
+/**
+ * Link arrow position options
+ */
+export type LinkArrowPosition = "start" | "end" | "both" | "none";
+/**
+ * Configuration for Dagre layout algorithm
+ */
+export interface DagreLayoutSettings {
+    /**
+     * Direction of the layout: 'TB' (top-to-bottom), 'BT' (bottom-to-top),
+     * 'LR' (left-to-right), 'RL' (right-to-left)
+     * @default 'TB'
+     */
+    rankdir?: DagreRankDir;
+    /**
+     * Alignment of nodes: 'UL' (up-left), 'UR' (up-right), 'DL' (down-left), 'DR' (down-right)
+     */
+    align?: DagreAlign;
+    /**
+     * Horizontal spacing between nodes in pixels
+     * @default 50
+     */
+    nodesep?: number;
+    /**
+     * Spacing between edges in pixels
+     * @default 10
+     */
+    edgesep?: number;
+    /**
+     * Vertical spacing between ranks in pixels
+     * @default 50
+     */
+    ranksep?: number;
+    /**
+     * Algorithm to use for ranking nodes
+     * @default 'network-simplex'
+     */
+    ranker?: DagreRanker;
+    /**
+     * Horizontal margin in pixels
+     * @default 0
+     */
+    marginx?: number;
+    /**
+     * Vertical margin in pixels
+     * @default 0
+     */
+    marginy?: number;
+}
+/**
+ * Node data structure for the graph
+ */
+export interface GraphNodeDatum {
+    /**
+     * Unique identifier for the node
+     */
+    id: string;
+    /**
+     * Display label for the node
+     */
+    label?: string;
+    /**
+     * Node level (for hierarchical data)
+     */
+    level?: number;
+    /**
+     * Additional data associated with the node
+     */
+    [key: string]: any;
+}
+/**
+ * Link/Edge data structure for the graph
+ */
+export interface GraphLinkDatum {
+    /**
+     * Source node ID
+     */
+    source: string;
+    /**
+     * Target node ID
+     */
+    target: string;
+    /**
+     * Label for the link
+     */
+    label?: string;
+    /**
+     * Additional data associated with the link
+     */
+    [key: string]: any;
+}
+/**
+ * Graph data structure containing nodes and links
+ */
+export interface GraphData<N = GraphNodeDatum, L = GraphLinkDatum> {
+    /**
+     * Array of node data
+     */
+    nodes: N[];
+    /**
+     * Array of link data
+     */
+    links: L[];
+}
+/**
+ * Props for the DagreGraph component
+ */
+export interface DagreGraphProps<N = GraphNodeDatum, L = GraphLinkDatum> {
+    /**
+     * The graph data containing nodes and links
+     */
+    data: GraphData<N, L>;
+    /**
+     * The height of the graph container in pixels
+     * @default 600
+     */
+    height?: number;
+    /**
+     * The width of the graph container in pixels
+     * @default undefined (auto)
+     */
+    width?: number;
+    /**
+     * Dagre layout configuration
+     */
+    dagreLayoutSettings?: DagreLayoutSettings;
+    /**
+     * Function or value to determine node size
+     * @default 40
+     */
+    nodeSize?: number | ((node: N, index: number) => number);
+    /**
+     * Function to extract node label
+     */
+    nodeLabel?: (node: N, index: number) => string;
+    /**
+     * Function or value to determine node shape
+     */
+    nodeShape?: NodeShape | ((node: N, index: number) => NodeShape);
+    /**
+     * Function or value to determine node fill color
+     */
+    nodeFill?: string | ((node: N, index: number) => string);
+    /**
+     * Function or value to determine node stroke color
+     */
+    nodeStroke?: string | ((node: N, index: number) => string);
+    /**
+     * Function or value to determine node stroke width
+     */
+    nodeStrokeWidth?: number | ((node: N, index: number) => number);
+    /**
+     * Link arrow configuration
+     * @default 'end'
+     */
+    linkArrow?: LinkArrowPosition;
+    /**
+     * Function to extract link label
+     */
+    linkLabel?: (link: L, index: number) => string;
+    /**
+     * Function or value to determine link color
+     */
+    linkStroke?: string | ((link: L, index: number) => string);
+    /**
+     * Function or value to determine link width
+     */
+    linkWidth?: number | ((link: L, index: number) => number);
+    /**
+     * Link curvature amount (0-1)
+     * @default 0
+     */
+    linkCurvature?: number;
+    /**
+     * Optional padding applied to the graph
+     */
+    padding?: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+    };
+    /**
+     * If true, hides the tooltip
+     */
+    hideTooltip?: boolean;
+    /**
+     * Enable zoom and pan controls
+     * @default true
+     */
+    zoomEnabled?: boolean;
+    /**
+     * Zoom scale extent [min, max]
+     * @default [0.1, 10]
+     */
+    zoomScaleExtent?: [number, number];
+    /**
+     * Enable node dragging
+     * @default false
+     */
+    nodeDraggingEnabled?: boolean;
+    /**
+     * If true, hides the legend
+     */
+    hideLegend?: boolean;
+    /**
+     * Legend position
+     * @default LegendPosition.BottomCenter
+     */
+    legendPosition?: LegendPosition;
+    /**
+     * Legend style
+     */
+    legendStyle?: string | Record<string, string>;
+    /**
+     * Legend items configuration
+     */
+    legendItems?: BulletLegendItemInterface[];
+    /**
+     * Custom formatter for tooltip titles
+     */
+    tooltipTitleFormatter?: (node: N) => string | number;
+    /**
+     * Custom formatter for tooltip content
+     */
+    tooltipContentFormatter?: (node: N) => string;
+    /**
+     * Animation duration in milliseconds
+     * @default 600
+     */
+    duration?: number;
+}

package/dist/components/DualChart/DualChart.js

@@ -0,0 +1,206 @@
+import { defineComponent as N, useSlots as W, useTemplateRef as E, ref as G, computed as c, createElementBlock as m, openBlock as o, normalizeStyle as f, createVNode as x, createCommentVNode as u, createElementVNode as z, unref as a, withCtx as H, createBlock as d, Fragment as X, renderList as j, mergeProps as k, renderSlot as p } from "vue";
+import { Orientation as y, CurveType as A, Position as L, StackedBar as q, GroupedBar as $ } from "@unovis/ts";
+import { VisXYContainer as R, VisTooltip as U, VisGroupedBar as I, VisStackedBar as J, VisLine as K, VisAxis as B, VisCrosshair as Q, VisBulletLegend as Z } from "@unovis/vue";
+import _ from "../Tooltip.js";
+import { LegendPosition as ee } from "../../types.js";
+const te = {
+  ref: "slotWrapper",
+  style: { display: "none" }
+}, de = /* @__PURE__ */ N({
+  __name: "DualChart",
+  props: {
+    data: {},
+    height: {},
+    xLabel: {},
+    yLabel: {},
+    yLabelSecondary: {},
+    padding: { default: () => ({
+      top: 5,
+      right: 5,
+      bottom: 5,
+      left: 5
+    }) },
+    barCategories: {},
+    lineCategories: {},
+    barYAxis: {},
+    lineYAxis: {},
+    xFormatter: {},
+    yFormatter: {},
+    tooltipTitleFormatter: {},
+    curveType: { default: A.MonotoneX },
+    lineWidth: { default: 2 },
+    xNumTicks: {},
+    xExplicitTicks: {},
+    minMaxTicksOnly: { type: Boolean },
+    yNumTicks: {},
+    hideLegend: { type: Boolean, default: !1 },
+    hideTooltip: { type: Boolean, default: !1 },
+    legendPosition: { default: ee.BottomCenter },
+    legendStyle: { default: void 0 },
+    xDomainLine: { type: Boolean },
+    yDomainLine: { type: Boolean },
+    xTickLine: { type: Boolean },
+    yTickLine: { type: Boolean },
+    xGridLine: { type: Boolean },
+    yGridLine: { type: Boolean, default: !0 },
+    hideXAxis: { type: Boolean },
+    hideYAxis: { type: Boolean },
+    crosshairConfig: {},
+    xAxisConfig: {},
+    yAxisConfig: {},
+    yDomain: {},
+    xDomain: {},
+    stacked: { type: Boolean },
+    groupPadding: { default: 0 },
+    barPadding: { default: 0.2 },
+    radius: {},
+    orientation: { default: y.Vertical }
+  },
+  emits: ["click"],
+  setup(e, { emit: Y }) {
+    const P = Y, t = e, V = W(), g = E("slotWrapper"), s = G();
+    if (!t.barYAxis || t.barYAxis.length === 0)
+      throw console.error("[DualChart] barYAxis prop is required and must contain at least one field key"), new Error("DualChart: 'barYAxis' is required and must contain at least one field key. Provide an array of property keys from your data type (e.g., ['revenue', 'costs'])");
+    if (!t.lineYAxis || t.lineYAxis.length === 0)
+      throw console.error("[DualChart] lineYAxis prop is required and must contain at least one field key"), new Error("DualChart: 'lineYAxis' is required and must contain at least one field key. Provide an array of property keys from your data type (e.g., ['profit', 'target'])");
+    const h = c(() => t.barYAxis.map((n) => (l) => l[n])), D = c(() => t.lineYAxis.map((n) => (l) => l[n])), v = (n, l) => {
+      var i;
+      return (i = Object.values(t.barCategories)[l]) == null ? void 0 : i.color;
+    }, b = c(() => ({
+      ...t.barCategories,
+      ...t.lineCategories
+    })), F = c(() => t.legendPosition.startsWith("top")), w = c(() => t.legendPosition.includes("left") ? "flex-start" : t.legendPosition.includes("right") ? "flex-end" : "center");
+    function C(n) {
+      s.value = n;
+    }
+    function M(n) {
+      return typeof window > "u" ? "" : g.value ? g.value.innerHTML : "";
+    }
+    function O(n) {
+      return s.value = n, M();
+    }
+    return (n, l) => (o(), m("div", {
+      style: f({
+        display: "flex",
+        flexDirection: F.value ? "column-reverse" : "column",
+        gap: "var(--vis-legend-spacing)"
+      }),
+      onClick: l[0] || (l[0] = (i) => P("click", i, s.value))
+    }, [
+      x(a(R), {
+        padding: e.padding,
+        height: e.height,
+        data: e.data
+      }, {
+        default: H(() => [
+          e.hideTooltip ? u("", !0) : (o(), d(a(U), {
+            key: 0,
+            triggers: {
+              [a($).selectors.bar]: (i) => {
+                var r;
+                return C(i), i ? (r = g.value) == null ? void 0 : r.innerHTML : "";
+              },
+              [a(q).selectors.bar]: (i) => {
+                var r;
+                return C(i), i ? (r = g.value) == null ? void 0 : r.innerHTML : "";
+              }
+            },
+            "horizontal-placement": a(L).Right,
+            "vertical-placement": a(L).Top
+          }, null, 8, ["triggers", "horizontal-placement", "vertical-placement"])),
+          e.stacked ? (o(), d(a(J), {
+            key: 2,
+            data: e.data,
+            x: (i, r) => r,
+            y: h.value,
+            color: v,
+            "rounded-corners": e.radius ?? 0,
+            "group-padding": e.groupPadding ?? 0,
+            "bar-padding": e.barPadding ?? 0.2,
+            orientation: e.orientation ?? a(y).Vertical
+          }, null, 8, ["data", "x", "y", "rounded-corners", "group-padding", "bar-padding", "orientation"])) : (o(), d(a(I), {
+            key: 1,
+            data: e.data,
+            x: (i, r) => r,
+            y: h.value,
+            color: v,
+            "rounded-corners": e.radius ?? 0,
+            "group-padding": e.groupPadding ?? 0,
+            "bar-padding": e.barPadding ?? 0.2,
+            orientation: e.orientation ?? a(y).Vertical
+          }, null, 8, ["data", "x", "y", "rounded-corners", "group-padding", "bar-padding", "orientation"])),
+          (o(!0), m(X, null, j(D.value, (i, r) => {
+            var T;
+            return o(), d(a(K), {
+              key: `line-${r}`,
+              data: e.data,
+              x: (ie, S) => S,
+              y: i,
+              color: (T = Object.values(t.lineCategories)[r]) == null ? void 0 : T.color,
+              "curve-type": e.curveType ?? a(A).MonotoneX,
+              "line-width": e.lineWidth
+            }, null, 8, ["data", "x", "y", "color", "curve-type", "line-width"]);
+          }), 128)),
+          e.hideXAxis ? u("", !0) : (o(), d(a(B), k({
+            key: 3,
+            type: "x",
+            "tick-format": e.xFormatter,
+            label: e.xLabel,
+            "grid-line": e.xGridLine,
+            "domain-line": !!e.xDomainLine,
+            "tick-line": e.xTickLine,
+            "num-ticks": e.xNumTicks,
+            "tick-values": e.xExplicitTicks,
+            minMaxTicksOnly: e.minMaxTicksOnly
+          }, e.xAxisConfig), null, 16, ["tick-format", "label", "grid-line", "domain-line", "tick-line", "num-ticks", "tick-values", "minMaxTicksOnly"])),
+          e.hideYAxis ? u("", !0) : (o(), d(a(B), k({
+            key: 4,
+            type: "y",
+            label: e.yLabel,
+            "grid-line": e.orientation !== a(y).Horizontal && e.yGridLine,
+            "domain-line": !!e.yDomainLine,
+            "tick-format": e.yFormatter,
+            "num-ticks": e.yNumTicks,
+            "tick-line": e.yTickLine
+          }, e.yAxisConfig), null, 16, ["label", "grid-line", "domain-line", "tick-format", "num-ticks", "tick-line"])),
+          e.hideTooltip ? u("", !0) : (o(), d(a(Q), k({ key: 5 }, e.crosshairConfig, { template: O }), null, 16))
+        ]),
+        _: 1
+      }, 8, ["padding", "height", "data"]),
+      t.hideLegend ? u("", !0) : (o(), m("div", {
+        key: 0,
+        style: f({
+          display: "flex",
+          justifyContent: w.value
+        })
+      }, [
+        x(a(Z), {
+          style: f([
+            t.legendStyle,
+            "display: flex; gap: var(--vis-legend-spacing);"
+          ]),
+          items: Object.values(b.value).map((i) => ({
+            ...i,
+            color: Array.isArray(i.color) ? i.color[0] : i.color
+          }))
+        }, null, 8, ["style", "items"])
+      ], 4)),
+      z("div", te, [
+        a(V).tooltip ? p(n.$slots, "tooltip", {
+          key: 0,
+          values: s.value
+        }) : s.value ? p(n.$slots, "fallback", { key: 1 }, () => [
+          x(_, {
+            data: s.value,
+            categories: b.value,
+            "title-formatter": t.tooltipTitleFormatter,
+            yFormatter: t.orientation === a(y).Horizontal ? t.xFormatter : t.yFormatter
+          }, null, 8, ["data", "categories", "title-formatter", "yFormatter"])
+        ]) : u("", !0)
+      ], 512)
+    ], 4));
+  }
+});
+export {
+  de as default
+};

package/dist/components/DualChart/DualChart.vue.d.ts

@@ -0,0 +1,21 @@
+import { DualChartProps } from './types';
+declare const _default: <T extends {}>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: __VLS_PrettifyLocal<Pick<Partial<{}> & Omit<{
+        readonly onClick?: ((event: MouseEvent, values?: T | undefined) => any) | undefined;
+    } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>, "onClick"> & DualChartProps<T> & Partial<{}>> & import('vue').PublicProps;
+    expose(exposed: import('vue').ShallowUnwrapRef<{}>): void;
+    attrs: any;
+    slots: {
+        tooltip?(_: {
+            values: T | undefined;
+        }): any;
+        fallback?(_: {}): any;
+    };
+    emit: (e: "click", event: MouseEvent, values?: T) => void;
+}>) => import('vue').VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/components/DualChart/DualChart2.js

@@ -0,0 +1,4 @@
+import f from "./DualChart.js";
+export {
+  f as default
+};

package/dist/components/DualChart/types.d.ts

@@ -0,0 +1,186 @@
+import { axisFormatter, CrosshairConfig, LegendPosition, AxisConfig, BulletLegendItemInterface, Orientation, CurveType } from '../../types';
+export interface DualChartProps<T> {
+    /**
+     * The data to be displayed in the dual chart.
+     * Each element of the array represents a data point.
+     * The structure of 'T' should be compatible with the chart's rendering logic.
+     */
+    data: T[];
+    /**
+     * The height of the chart in pixels.
+     */
+    height: number;
+    /**
+     * Optional label for the x-axis.
+     */
+    xLabel?: string;
+    /**
+     * Optional label for the y-axis (used for both bar and line by default).
+     */
+    yLabel?: string;
+    /**
+     * Optional label for the secondary y-axis (line chart).
+     */
+    yLabelSecondary?: string;
+    /**
+     * Optional padding applied to the chart.
+     * Allows specifying individual padding values for the top, right, bottom, and left sides.
+     */
+    padding?: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+    };
+    /**
+     * A record mapping bar category keys to `BulletLegendItemInterface` objects.
+     * This defines the visual representation and labels for bar categories in the chart's legend.
+     */
+    barCategories: Record<string, BulletLegendItemInterface>;
+    /**
+     * A record mapping line category keys to `BulletLegendItemInterface` objects.
+     * This defines the visual representation and labels for line categories in the chart's legend.
+     */
+    lineCategories: Record<string, BulletLegendItemInterface>;
+    /**
+     * An array of property keys from the data object type 'T' to be used for the bar chart y-axis values.
+     */
+    barYAxis: (keyof T)[];
+    /**
+     * An array of property keys from the data object type 'T' to be used for the line chart y-axis values.
+     */
+    lineYAxis: (keyof T)[];
+    /**
+     * @param {number|Date} tick - The value of the tick. This can be a number or a Date object depending on the scale of the x-axis.
+     * @param {number} i - The index of the tick in the `ticks` array.
+     * @param {(number[]|Date[])} ticks - An array of all tick values for the x-axis.
+     * @returns {string} The formatted string representation of the tick.
+     */
+    xFormatter?: axisFormatter;
+    /**
+     * @param {number|Date} tick - The value of the tick. This can be a number or a Date object depending on the scale of the y-axis.
+     * @param {number} i - The index of the tick in the `ticks` array.
+     * @param {(number[]|Date[])} ticks - An array of all tick values for the y-axis.
+     * @returns {string} The formatted string representation of the tick.
+     */
+    yFormatter?: axisFormatter;
+    /**
+     * Use custom formatter for tooltip titles
+     */
+    tooltipTitleFormatter?: (data: T) => string | number;
+    /**
+     * The type of curve to use for the line chart lines.
+     * See `CurveType` for available options.
+     */
+    curveType?: CurveType;
+    /**
+     * The width of the line in pixels. Default is 2px.
+     */
+    lineWidth?: number;
+    /**
+     * The desired number of ticks on the x-axis.
+     */
+    xNumTicks?: number;
+    /**
+     * Force specific ticks on the x-axis.
+     */
+    xExplicitTicks?: (number | string | Date)[];
+    /**
+     * Force only first and last ticks on the x-axis.
+     */
+    minMaxTicksOnly?: boolean;
+    /**
+     * The desired number of ticks on the y-axis.
+     */
+    yNumTicks?: number;
+    /**
+     * If `true`, hides the chart legend.
+     */
+    hideLegend?: boolean;
+    /**
+     * If `true`, hides the chart tooltip.
+     */
+    hideTooltip?: boolean;
+    /**
+     * Optional position for the legend, if applicable.
+     * See `LegendPosition` for available options.
+     */
+    legendPosition?: LegendPosition;
+    /**
+     * Optional style object for the legend container. Allows custom CSS styling.
+     */
+    legendStyle?: string | Record<string, string>;
+    /**
+     * If `true`, displays a domain line (axis line) along the x-axis.
+     */
+    xDomainLine?: boolean;
+    /**
+     * If `true`, displays a domain line (axis line) along the y-axis.
+     */
+    yDomainLine?: boolean;
+    /**
+     * If `true`, displays tick lines on the x-axis.
+     */
+    xTickLine?: boolean;
+    /**
+     * If `true`, displays tick lines on the y-axis.
+     */
+    yTickLine?: boolean;
+    /**
+     * If `true`, displays grid lines along the x-axis.
+     */
+    xGridLine?: boolean;
+    /**
+     * If `true`, displays grid lines along the y-axis.
+     */
+    yGridLine?: boolean;
+    /**
+     * If `true`, hide the x-axis.
+     */
+    hideXAxis?: boolean;
+    /**
+     * If `true`, hide the y-axis.
+     */
+    hideYAxis?: boolean;
+    /**
+     * Crosshair configuration object for customizing the appearance of the crosshair line.
+     */
+    crosshairConfig?: CrosshairConfig;
+    /**
+     * Axis configuration object for customizing the appearance of the axes.
+     */
+    xAxisConfig?: AxisConfig;
+    /**
+     * Axis configuration object for customizing the appearance of the axes.
+     */
+    yAxisConfig?: AxisConfig;
+    /**
+     * The domain for the y-axis, specified as a tuple of two values.
+     */
+    yDomain?: [number | undefined, number | undefined];
+    /**
+     * The domain for the x-axis, specified as a tuple of two values.
+     */
+    xDomain?: [number | undefined, number | undefined];
+    /**
+     * If `true`, creates stacked bars.
+     */
+    stacked?: boolean;
+    /**
+     * The padding between groups of bars in pixels.
+     */
+    groupPadding?: number;
+    /**
+     * Fractional padding between the bars in the range of [0,1). Default: 0.2
+     */
+    barPadding?: number;
+    /**
+     * Rounded corners for top bars. Boolean or number (to set the radius in pixels). Default: 2
+     */
+    radius?: number;
+    /**
+     * The orientation of the bars (vertical or horizontal).
+     * See `Orientation` for available options.
+     */
+    orientation?: Orientation;
+}