vccs 0.5.0 → 1.0.0-beta.1

package/dist/cartesian/error-bar/ErrorBar.d.ts

@@ -1,8 +1,8 @@
-import { PropType } from 'vue';
-import { ErrorBarDirection } from '../../types/bar';
-export declare const ErrorBarVueProps: {
+import { ExtractPropTypes, PropType } from 'vue';
+import { ErrorBarDirection } from '../../types/bar.js';
+export declare const ErrorBar: import('../../utils/attributes.js').WithAttributes<import('vue').DefineComponent<ExtractPropTypes<{
     dataKey: {
-        type: PropType<string | number | ((obj: any) => any)>;
+        type: PropType<string | number | ((obj: unknown) => unknown)>;
         required: true;
     };
     width: {
@@ -17,13 +17,14 @@ export declare const ErrorBarVueProps: {
         default: string;
     };
     strokeWidth: {
-        type: (NumberConstructor | StringConstructor)[];
+        type: (StringConstructor | NumberConstructor)[];
         default: number;
     };
-};
-export declare const ErrorBar: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+}>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<ExtractPropTypes<{
     dataKey: {
-        type: PropType<string | number | ((obj: any) => any)>;
+        type: PropType<string | number | ((obj: unknown) => unknown)>;
         required: true;
     };
     width: {
@@ -38,31 +39,11 @@ export declare const ErrorBar: import('vue').DefineComponent<import('vue').Extra
         default: string;
     };
     strokeWidth: {
-        type: (NumberConstructor | StringConstructor)[];
-        default: number;
-    };
-}>, () => import("vue/jsx-runtime").JSX.Element, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
-    dataKey: {
-        type: PropType<string | number | ((obj: any) => any)>;
-        required: true;
-    };
-    width: {
-        type: NumberConstructor;
-        default: number;
-    };
-    direction: {
-        type: PropType<ErrorBarDirection>;
-    };
-    stroke: {
-        type: StringConstructor;
-        default: string;
-    };
-    strokeWidth: {
-        type: (NumberConstructor | StringConstructor)[];
+        type: (StringConstructor | NumberConstructor)[];
         default: number;
     };
 }>> & Readonly<{}>, {
     width: number;
     stroke: string;
     strokeWidth: string | number;
-}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>, import('../../utils/attributes.js').SvgTemplateAttributes>;

package/dist/cartesian/error-bar/ErrorBarContext.d.ts

@@ -1,27 +1,24 @@
+import { ChartDataKey } from '../../types/base.js';
 import { Ref, ShallowRef } from 'vue';
-import { ErrorBarDirection } from '../../types/bar';
-import { DataKey } from '../../types';
-import { AxisId } from '../../state/cartesianAxisSlice';
-import { ErrorBarsSettings } from '../../state/graphicalItemsSlice';
-export interface ErrorBarDataItem {
-    x: number | undefined;
-    y: number | undefined;
-    value: number;
-    errorVal?: number[] | number;
-}
-export type ErrorBarDataPointFormatter<T> = (entry: T, dataKey: DataKey<any>, direction: ErrorBarDirection) => ErrorBarDataItem;
+import { ErrorBarDirection } from '../../types/bar.js';
+import { AxisId } from '../../types/axisSettings.js';
+import { ErrorBarsSettings } from '../../types/graphical.js';
+import { ErrorBarDataItem } from '../../core/errorBar.js';
+export type ErrorBarDataPointFormatter<T> = (entry: T, dataKey: ChartDataKey, direction: ErrorBarDirection) => ErrorBarDataItem;
 export interface ErrorBarContextType {
-    data: Readonly<ShallowRef<readonly any[]>>;
+    data: Readonly<ShallowRef<readonly unknown[] | undefined>>;
     xAxisId: AxisId;
     yAxisId: AxisId;
-    dataPointFormatter: ErrorBarDataPointFormatter<any>;
+    dataPointFormatter: ErrorBarDataPointFormatter<unknown>;
     errorBarOffset: Ref<number>;
 }
-export declare const useErrorBarContext: <T extends ErrorBarContextType = ErrorBarContextType>(fallback?: T) => T extends null ? ErrorBarContextType : ErrorBarContextType, provideErrorBarContext: (contextValue: ErrorBarContextType) => ErrorBarContextType;
+export declare function provideErrorBarContext(value: ErrorBarContextType): ErrorBarContextType;
+export declare function useErrorBarContext<T extends ErrorBarContextType | null | undefined = ErrorBarContextType>(fallback?: T): T extends null ? ErrorBarContextType | null : ErrorBarContextType;
 export interface ErrorBarRegistryType {
     errorBars: ShallowRef<ReadonlyArray<ErrorBarsSettings>>;
     register: (settings: ErrorBarsSettings) => void;
     unregister: (settings: ErrorBarsSettings) => void;
 }
-export declare const useErrorBarRegistry: <T extends ErrorBarRegistryType = ErrorBarRegistryType>(fallback?: T) => T extends null ? ErrorBarRegistryType : ErrorBarRegistryType, provideErrorBarRegistry: (contextValue: ErrorBarRegistryType) => ErrorBarRegistryType;
+export declare function provideErrorBarRegistry(value: ErrorBarRegistryType): ErrorBarRegistryType;
+export declare function useErrorBarRegistry<T extends ErrorBarRegistryType | null | undefined = ErrorBarRegistryType>(fallback?: T): T extends null ? ErrorBarRegistryType | null : ErrorBarRegistryType;
 export declare function createErrorBarRegistry(): ErrorBarRegistryType;

package/dist/cartesian/funnel/Funnel.d.ts

@@ -1,2 +1,161 @@
-import { FunnelPropsWithSVG } from './type';
-export declare const Funnel: import('vue').DefineComponent<FunnelPropsWithSVG, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<FunnelPropsWithSVG> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+import { ExtractPropTypes, PropType, SlotsType, VNode, VNodeChild } from 'vue';
+import { FunnelTrapezoidItem } from '../../types/funnel.js';
+export interface FunnelSlots {
+    shape?: (props: FunnelTrapezoidItem) => VNodeChild;
+    default?: () => VNode[];
+}
+export declare const Funnel: import('../../utils/attributes.js').WithAttributes<import('vue').DefineComponent<ExtractPropTypes<{
+    data: {
+        type: PropType<Array<Record<string, unknown>>>;
+        default: undefined;
+    };
+    dataKey: {
+        type: PropType<import('../../types/base.js').ChartDataKey>;
+        required: true;
+    };
+    nameKey: {
+        type: PropType<import('../../types/base.js').ChartDataKey>;
+        default: string;
+    };
+    name: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
+    lastShapeType: {
+        type: PropType<"triangle" | "rectangle">;
+        default: string;
+    };
+    reversed: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    fill: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    stroke: {
+        type: StringConstructor;
+        default: string;
+    };
+    legendType: {
+        type: PropType<import('../../types/legend.js').LegendType>;
+        default: string;
+    };
+    tooltipType: {
+        type: PropType<import('../../types/index.js').TooltipType>;
+        default: undefined;
+    };
+    hide: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    isAnimationActive: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    transition: {
+        type: PropType<import('motion-v').ValueAnimationTransition<number>>;
+        default: undefined;
+    };
+    width: {
+        type: PropType<number | string>;
+        default: undefined;
+    };
+    class: {
+        type: PropType<import('../../types/index.js').VueClassValue>;
+        default: undefined;
+    };
+}>, () => VNode<import('vue').RendererNode, import('vue').RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    click: (_entry: FunnelTrapezoidItem, _index: number, _event: MouseEvent) => boolean;
+    mouseenter: (_entry: FunnelTrapezoidItem, _index: number, _event: MouseEvent) => boolean;
+    mouseleave: (_entry: FunnelTrapezoidItem, _index: number, _event: MouseEvent) => boolean;
+    'animation-start': () => boolean;
+    'animation-end': () => boolean;
+}, string, import('vue').PublicProps, Readonly<ExtractPropTypes<{
+    data: {
+        type: PropType<Array<Record<string, unknown>>>;
+        default: undefined;
+    };
+    dataKey: {
+        type: PropType<import('../../types/base.js').ChartDataKey>;
+        required: true;
+    };
+    nameKey: {
+        type: PropType<import('../../types/base.js').ChartDataKey>;
+        default: string;
+    };
+    name: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
+    lastShapeType: {
+        type: PropType<"triangle" | "rectangle">;
+        default: string;
+    };
+    reversed: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    fill: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    stroke: {
+        type: StringConstructor;
+        default: string;
+    };
+    legendType: {
+        type: PropType<import('../../types/legend.js').LegendType>;
+        default: string;
+    };
+    tooltipType: {
+        type: PropType<import('../../types/index.js').TooltipType>;
+        default: undefined;
+    };
+    hide: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    isAnimationActive: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    transition: {
+        type: PropType<import('motion-v').ValueAnimationTransition<number>>;
+        default: undefined;
+    };
+    width: {
+        type: PropType<number | string>;
+        default: undefined;
+    };
+    class: {
+        type: PropType<import('../../types/index.js').VueClassValue>;
+        default: undefined;
+    };
+}>> & Readonly<{
+    onClick?: ((_entry: FunnelTrapezoidItem, _index: number, _event: MouseEvent) => any) | undefined;
+    onMouseenter?: ((_entry: FunnelTrapezoidItem, _index: number, _event: MouseEvent) => any) | undefined;
+    onMouseleave?: ((_entry: FunnelTrapezoidItem, _index: number, _event: MouseEvent) => any) | undefined;
+    "onAnimation-start"?: (() => any) | undefined;
+    "onAnimation-end"?: (() => any) | undefined;
+}>, {
+    name: string | number;
+    reversed: boolean;
+    hide: boolean;
+    width: string | number;
+    fill: string;
+    nameKey: import('../../types/base.js').ChartDataKey;
+    stroke: string;
+    class: import('../../types/index.js').VueClassValue;
+    data: Record<string, unknown>[];
+    isAnimationActive: boolean;
+    transition: import('motion-v').ValueAnimationTransition<number>;
+    tooltipType: "none";
+    legendType: import('../../types/legend.js').LegendType;
+    lastShapeType: "triangle" | "rectangle";
+}, SlotsType<{
+    shape?: (props: FunnelTrapezoidItem) => VNodeChild;
+    default?: () => VNode[];
+}>, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>, import('../../utils/attributes.js').SvgTemplateAttributes>;

package/dist/cartesian/funnel/type.d.ts

@@ -1,45 +1,26 @@
-import { AnimationOptions } from 'motion-v';
+import { ChartDataKey } from '../../types/base.js';
+import { ValueAnimationTransition } from 'motion-v';
 import { PropType } from 'vue';
-import { ViewBox } from '../type';
-import { TrapezoidProps } from '../../shape';
-import { Coordinate, DataKey, TooltipType, WithSVGProps } from '../../types';
-import { LegendType } from '../../types/legend';
-export interface FunnelTrapezoidItem extends TrapezoidProps {
-    value?: number | string;
-    payload?: any;
-    isActive: boolean;
-    tooltipPosition: Coordinate;
-    parentViewBox?: ViewBox;
-    labelViewBox?: ViewBox;
-}
-export interface FunnelProps {
-    data?: any[];
-    dataKey: DataKey<any>;
-    hide?: boolean;
-    id?: string;
-    isAnimationActive?: boolean;
-    transition?: AnimationOptions;
-    lastShapeType?: 'triangle' | 'rectangle';
-    legendType?: LegendType;
-    nameKey?: DataKey<any>;
-    onAnimationEnd?: () => void;
-    onAnimationStart?: () => void;
-    reversed?: boolean;
-    tooltipType?: TooltipType;
-}
+import { TooltipType } from '../../types/index.js';
+import { LegendType } from '../../types/legend.js';
 export declare const FunnelVueProps: {
     data: {
         type: PropType<Array<Record<string, unknown>>>;
-        default: any;
+        default: undefined;
     };
     dataKey: {
-        type: PropType<DataKey<any>>;
+        type: PropType<ChartDataKey>;
         required: true;
     };
     nameKey: {
-        type: PropType<DataKey<any>>;
+        type: PropType<ChartDataKey>;
         default: string;
     };
+    /** Series name for the tooltip; defaults to a string `dataKey`. */
+    name: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
     lastShapeType: {
         type: PropType<"triangle" | "rectangle">;
         default: string;
@@ -50,7 +31,7 @@ export declare const FunnelVueProps: {
     };
     fill: {
         type: StringConstructor;
-        default: string;
+        default: undefined;
     };
     stroke: {
         type: StringConstructor;
@@ -62,7 +43,7 @@ export declare const FunnelVueProps: {
     };
     tooltipType: {
         type: PropType<TooltipType>;
-        default: any;
+        default: undefined;
     };
     hide: {
         type: BooleanConstructor;
@@ -70,36 +51,18 @@ export declare const FunnelVueProps: {
     };
     isAnimationActive: {
         type: BooleanConstructor;
-        default: boolean;
+        default: undefined;
     };
     transition: {
-        type: PropType<AnimationOptions>;
-        default: () => {
-            duration: number;
-            ease: string;
-        };
-    };
-    onAnimationStart: {
-        type: PropType<() => void>;
-        default: any;
-    };
-    onAnimationEnd: {
-        type: PropType<() => void>;
-        default: any;
+        type: PropType<ValueAnimationTransition<number>>;
+        default: undefined;
     };
     width: {
         type: PropType<number | string>;
-        default: any;
+        default: undefined;
     };
     class: {
-        type: PropType<import('../../types').VueClassValue>;
-        default: any;
+        type: PropType<import('../../types/index.js').VueClassValue>;
+        default: undefined;
     };
 };
-export type FunnelPropsWithSVG = WithSVGProps<typeof FunnelVueProps>;
-type RealFunnelData = any;
-export type FunnelComposedData = {
-    trapezoids: ReadonlyArray<FunnelTrapezoidItem>;
-    data: RealFunnelData[];
-};
-export {};

package/dist/cartesian/getCartesianPosition.d.ts

@@ -0,0 +1,43 @@
+import { CartesianViewBoxRequired, TrapezoidViewBox } from '../types/viewBox.js';
+export type TextAnchor = 'start' | 'middle' | 'end' | 'inherit';
+export type TextVerticalAnchor = 'start' | 'middle' | 'end';
+/**
+ * @inline
+ */
+export type CartesianPosition = 'top' | 'left' | 'right' | 'bottom' | 'center' | 'insideLeft' | 'insideRight' | 'insideTop' | 'insideBottom' | 'insideTopLeft' | 'insideBottomLeft' | 'insideTopRight' | 'insideBottomRight' | {
+    x: number | string;
+    y: number | string;
+};
+export type GetCartesianPositionOptions = {
+    viewBox: TrapezoidViewBox | CartesianViewBoxRequired;
+    parentViewBox?: CartesianViewBoxRequired;
+    /**
+     * The offset to the specified "position". Direction of the offset depends on the position.
+     */
+    offset?: number;
+    /**
+     * The position of the element relative to the view box.
+     */
+    position?: CartesianPosition;
+    /**
+     * If true, the returned width and height will be clamped to keep the element within the parentViewBox.
+     * This is useful for preventing labels from overflowing the chart area.
+     */
+    clamp?: boolean;
+};
+export type CalculatedCartesianPosition = {
+    x: number;
+    y: number;
+    horizontalAnchor: TextAnchor;
+    verticalAnchor: TextVerticalAnchor;
+    width?: number;
+    height?: number;
+};
+/**
+ * Calculates the position and alignment for a generic element in a Cartesian coordinate system.
+ *
+ * @param options - The options including viewBox, position, and offset.
+ * @returns The calculated x, y, alignment and size.
+ */
+export declare function getCartesianPosition(options: GetCartesianPositionOptions): CalculatedCartesianPosition;
+export declare function isOutsidePosition(position: CartesianPosition | undefined): boolean;