vue-chrts 2.1.0-beta-8 → 2.1.0-beta-9

package/dist/components/AreaChart/AreaChart.d.ts

@@ -0,0 +1,185 @@
+import { AxisConfig, axisFormatter, BulletLegendItemInterface, CrosshairConfig, MarkerConfig, TooltipConfig } from '../../types';
+import { CurveType, LegendPosition } from '../../enums';
+export interface AreaChartProps<T> {
+    /**
+     * The data to be displayed in the area 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.
+     */
+    yLabel?: 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 category keys to `BulletLegendItemInterface` objects.
+     * This defines the visual representation and labels for each category in the chart's legend.
+     */
+    categories: Record<string, BulletLegendItemInterface>;
+    /**
+     * A record mapping marker keys to show custom patterns.
+     */
+    markerConfig?: MarkerConfig;
+    /**
+     * @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 area chart lines.
+     * See `CurveType` for available options.
+     */
+    curveType?: CurveType;
+    /**
+     * If `true`, hides the area fill, displaying only the line.
+     */
+    hideArea?: boolean;
+    /**
+     * Edit the gradient stops for the area fill.
+     */
+    gradientStops?: Array<{
+        offset: string;
+        stopOpacity: number;
+    }>;
+    /**
+     * The width of the line in pixels. Default is 2px.
+     */
+    lineWidth?: number;
+    /**
+     * Line dash array, see SVG's stroke-dasharray. Default: `undefined`
+     */
+    lineDashArray?: 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;
+    /**
+     * Force specific ticks on the y-axis.
+     */
+    yExplicitTicks?: (number | string | Date)[];
+    /**
+     * 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 a stacked area chart where areas are stacked on top of each other.
+     * When false (default), areas are overlaid on top of each other.
+     */
+    stacked?: boolean;
+    /**
+     * Animation duration in milliseconds for the chart components.
+     */
+    duration?: number;
+    /**
+     * Configuration object for the chart tooltip.
+     */
+    tooltip?: TooltipConfig;
+}

package/dist/components/AreaChart/AreaChart.js

@@ -3,7 +3,7 @@ import { Position as $, CurveType as h } from "@unovis/ts";
 import { createScopedMarkers as ie } from "../../utils.js";
 import oe from "../Tooltip.js";
 import { VisXYContainer as ne, VisTooltip as ae, VisArea as B, VisLine as O, VisAxis as w, VisCrosshair as re, VisBulletLegend as le } from "@unovis/vue";
-import { LegendPosition as ce } from "../../packages/shared/dist/index.js";
+import { LegendPosition as ce } from "../../enums.js";
 const se = ["id"], ue = {
   ref: "slotWrapper",
   style: { display: "none" }

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

@@ -1,4 +1,4 @@
-import { AreaChartProps } from './types';
+import { AreaChartProps } from './AreaChart';
 declare const _default: <T>(__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;

package/dist/components/AreaChart/index.d.ts

@@ -0,0 +1,2 @@
+export { default as AreaChart } from './AreaChart.vue';
+export * from './AreaChart';

package/dist/components/BarChart/BarChart.d.ts

@@ -0,0 +1,192 @@
+import { Orientation } from '@unovis/ts';
+import { axisFormatter, AxisConfig, TooltipConfig, BulletLegendItemInterface } from '../../types';
+import { LegendPosition } from '../../enums';
+export type BarChartPropsBase<T> = {
+    /**
+     * The data to be displayed in the bar 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[];
+    /**
+     * If `true`, creates a stacked bar chart instead of grouped bars.
+     */
+    stacked?: boolean;
+    /**
+     * The height of the chart in pixels.
+     */
+    height: number;
+    /**
+     * Optional label for the x-axis.
+     */
+    xLabel?: string;
+    /**
+     * Optional label for the y-axis.
+     */
+    yLabel?: 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 category keys to `BulletLegendItemInterface` objects.
+     * This defines the visual representation and labels for each category in the chart's legend.
+     */
+    categories: Record<string, BulletLegendItemInterface>;
+    /**
+     * @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 desired number of ticks on the y-axis.
+     */
+    yNumTicks?: number;
+    /**
+     * Force only first and last ticks on the x-axis.
+     */
+    minMaxTicksOnly?: boolean;
+    /**
+     * The desired number of ticks on the x-axis.
+     */
+    xNumTicks?: number;
+    /**
+     * Force specific ticks on the x-axis.
+     */
+    xExplicitTicks?: (number | string | Date)[];
+    /**
+     * An array of property keys from the data object type 'T' to be used for the y-axis values.
+     */
+    yAxis: (keyof T)[];
+    /**
+     * The padding between groups of bars in pixels.
+     */
+    groupPadding?: number;
+    /**
+     * Fractional padding between the bars in the range of [0,1). Default: 0
+     */
+    barPadding?: number;
+    /**
+     * Rounded corners for top bars. Boolean or number (to set the radius in pixels). Default: 2
+     */
+    radius?: number;
+    /**
+     * If `true`, hides the chart legend.
+     */
+    hideLegend?: boolean;
+    /**
+     * If `true`, hides the chart tooltip.
+     */
+    hideTooltip?: boolean;
+    /**
+     * The orientation of the bars (vertical or horizontal).
+     * See `Orientation` for available options.
+     */
+    orientation?: Orientation;
+    /**
+     * 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;
+    /**
+     * Specific spacing between stacked and grouped bars in pixels.
+     * Only applicable if `stackAndGrouped` is `true`.
+     */
+    stackedGroupedSpacing?: number;
+    /**
+     * Axis configuration object for customizing the appearance of the axes.
+     */
+    xAxisConfig?: AxisConfig;
+    /**
+     * Axis configuration object for customizing the appearance of the axes.
+     */
+    yAxisConfig?: AxisConfig;
+    /**
+     * Animation duration in milliseconds for the chart components.
+     */
+    duration?: number;
+    /**
+     * Configuration object for the chart tooltip.
+     */
+    tooltip?: TooltipConfig;
+};
+export type BarChartProps<T> = BarChartPropsBase<T> & {
+    /**
+     * Whether the bars should be stacked and grouped.
+     * If true, `valueLabel` is optional and `xAxis` is required.
+     */
+    stackAndGrouped?: boolean;
+    /**
+     * Configuration for the value label display.
+     * Required if `stackAndGrouped` is false and `xAxis` is present.
+     * Optional otherwise.
+     */
+    valueLabel?: ValueLabel;
+    /**
+     * The data key for the X-axis.
+     * Required if `stackAndGrouped` is true, or if `stackAndGrouped` is false AND `valueLabel` is present.
+     */
+    xAxis?: keyof T;
+};
+export type ValueLabel = {
+    label: (d: any, index: number) => string | number;
+    labelSpacing?: number;
+    backgroundColor?: string;
+    color?: string;
+    labelFontSize?: number;
+};

package/dist/components/BarChart/BarChart.js

@@ -3,7 +3,7 @@ import { Orientation as g, StackedBar as U, GroupedBar as J } from "@unovis/ts";
 import { useStackedGrouped as K } from "./stackedGroupedUtils.js";
 import { VisXYContainer as Q, VisXYLabels as Z, VisTooltip as _, VisStackedBar as G, VisGroupedBar as ee, VisAxis as V, VisBulletLegend as te } from "@unovis/vue";
 import ae from "../Tooltip.js";
-import { LegendPosition as ie } from "../../packages/shared/dist/index.js";
+import { LegendPosition as ie } from "../../enums.js";
 const ne = {
   ref: "slotWrapper",
   style: { display: "none" }

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

@@ -1,4 +1,4 @@
-import { BarChartProps } from './types';
+import { BarChartProps } from './BarChart';
 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;

package/dist/components/BarChart/index.d.ts

@@ -0,0 +1,2 @@
+export { default as BarChart } from './BarChart.vue';
+export * from './BarChart';

package/dist/components/BubbleChart/BubbleChart.d.ts

@@ -0,0 +1,173 @@
+import { axisFormatter, BulletLegendItemInterface, CrosshairConfig, AxisConfig, TooltipConfig } from '../../types';
+import { LegendPosition } from '../../enums';
+import { NumericAccessor, Position } from '@unovis/ts';
+export interface SizeOptions {
+    minRadius?: number;
+    maxRadius?: number;
+}
+export interface BubbleChartProps<T> {
+    /**
+     * Accessor for x value (index, property, etc). If not provided, defaults to d.beakLength.
+     */
+    xAccessor?: NumericAccessor<T>;
+    /**
+     * Accessor for y value. If not provided, defaults to d.flipperLength.
+     */
+    yAccessor?: NumericAccessor<T>;
+    /**
+     * Accessor for bubble size. If not provided, defaults to 1.
+     */
+    sizeAccessor?: NumericAccessor<T>;
+    /**
+     * Label position for bubbles (default: Position.Bottom)
+     */
+    labelPosition?: Position;
+    /**
+     * Range for bubble sizes (default: [1, 20])
+     */
+    sizeRange?: [number, number];
+    /**
+     * Opacity for bubbles
+     */
+    opacity?: number;
+    /**
+     * Explicit tick values for x axis
+     */
+    xExplicitTicks?: (number | string | Date)[];
+    /**
+     * Only show min/max ticks for x axis
+     */
+    minMaxTicksOnly?: boolean;
+    /**
+     * The data to be displayed in the bubble 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[];
+    /**
+     * If `true`, hides the chart legend.
+     */
+    hideLegend?: boolean;
+    /**
+     * The height of the chart in pixels.
+     */
+    height: number;
+    /**
+     * Optional label for the x-axis.
+     */
+    xLabel?: string;
+    /**
+     * Optional label for the y-axis.
+     */
+    yLabel?: 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 category keys to `BulletLegendItemInterface` objects.
+     * This defines the visual representation and labels for each category in the chart's legend.
+     * REQUIRED: Each unique value in your data's categoryKey field must have a corresponding entry with a color.
+     */
+    categories: Record<string, BulletLegendItemInterface>;
+    categoryKey: 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;
+    /**
+     * Optional position for the legend, if applicable.
+     * See `LegendPosition` for available options.
+     */
+    legendPosition?: LegendPosition;
+    /**
+     * Optional inline CSS styles for the legend container.
+     */
+    legendStyle?: Record<string, string>;
+    /** Options for controlling bubble sizes. */
+    sizeOptions?: SizeOptions;
+    /**
+     * 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;
+    /**
+     * The desired number of ticks on the x-axis.
+     */
+    xNumTicks?: number;
+    /**
+     * The desired number of ticks on the y-axis.
+     */
+    yNumTicks?: number;
+    /**
+     * If `true`, hides the tooltip.
+     */
+    hideTooltip?: 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;
+    /**
+     * Animation duration in milliseconds for the chart components.
+     */
+    duration?: number;
+    /**
+     * Configuration object for the chart tooltip.
+     */
+    tooltip?: TooltipConfig;
+}

package/dist/components/BubbleChart/BubbleChart.js

@@ -1,7 +1,7 @@
 import { defineComponent as D, useSlots as N, useTemplateRef as O, ref as S, computed as p, openBlock as r, createElementBlock as g, normalizeStyle as d, createVNode as c, unref as t, withCtx as R, createBlock as u, createCommentVNode as n, mergeProps as x, createElementVNode as K, renderSlot as k } from "vue";
 import { Scatter as M, Position as E } from "@unovis/ts";
 import { VisXYContainer as G, VisTooltip as W, VisScatter as $, VisAxis as L, VisBulletLegend as j } from "@unovis/vue";
-import { LegendPosition as X } from "../../packages/shared/dist/index.js";
+import { LegendPosition as X } from "../../enums.js";
 import Y from "../Tooltip.js";
 const q = {
   ref: "slotWrapper",

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

@@ -1,4 +1,4 @@
-import { BubbleChartProps } from './types';
+import { BubbleChartProps } from './BubbleChart';
 declare const _default: <T>(__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;

package/dist/components/BubbleChart/index.d.ts

@@ -0,0 +1,2 @@
+export { default as BubbleChart } from './BubbleChart.vue';
+export * from './BubbleChart';