layerchart 2.0.0-next.0 → 2.0.0-next.2

package/dist/components/charts/PieChart.svelte.d.ts

@@ -1,361 +1,145 @@
-import { SvelteComponentTyped } from "svelte";
+export type PieChartExtraSnippetProps<TData> = {
+    key: Accessor<TData>;
+    label: Accessor<TData>;
+    value: Accessor<TData>;
+    visibleData: TData[];
+    getGroupProps: () => ComponentProps<typeof Group>;
+};
+export type PieChartPropsObjProp = Pick<SimplifiedChartPropsObject, 'pie' | 'group' | 'arc' | 'legend' | 'canvas' | 'svg' | 'tooltip'>;
+export type PieChartProps<TData> = Pick<SimplifiedChartProps<TData, typeof Arc, PieChartExtraSnippetProps<TData>>, 'aboveContext' | 'aboveMarks' | 'belowContext' | 'belowMarks' | 'children' | 'data' | 'debug' | 'legend' | 'marks' | 'onTooltipClick' | 'profile' | 'renderContext' | 'series' | 'tooltip' | 'tooltipContext' | 'cRange' | 'padding' | 'context'> & {
+    /**
+     * Key accessor
+     *
+     * @default 'key'
+     */
+    key?: Accessor<TData>;
+    /**
+     * Label accessor
+     *
+     * @default 'label'
+     */
+    label?: Accessor<TData>;
+    /**
+     * Value accessor
+     *
+     * @default 'value'
+     */
+    value?: Accessor<TData>;
+    /**
+     * Color accessor
+     *
+     * @default key
+     */
+    c?: Accessor<TData>;
+    /**
+     * Maximum possible value, useful when `data` is single item
+     */
+    maxValue?: number;
+    /**
+     * Range [min, max] in degrees.
+     *
+     * See also `startAngle`/`endAngle`
+     *
+     * @default [0, 360]
+     */
+    range?: [number, number];
+    props?: PieChartPropsObjProp;
+    /**
+     * Inner radius of the arc.
+     *   value >= 1: discrete value
+     *   value >  0: percent of `outerRadius`
+     *   value <  0: offset of `outerRadius`
+     */
+    innerRadius?: number;
+    /**
+     * Outer radius of the arc.
+     */
+    outerRadius?: number;
+    /**
+     * Corner radius of the arc
+     *
+     * @default 0
+     */
+    cornerRadius?: number;
+    /**
+     * Angle between the arcs
+     *
+     * @default 0
+     */
+    padAngle?: number;
+    /**
+     * Placement of the PieChart
+     *
+     * @default 'center'
+     */
+    placement?: 'left' | 'center' | 'right';
+    /**
+     * Center the chart.
+     *
+     * Override and use `props.group` for more control.
+     *
+     * @default placement === 'center'
+     */
+    center?: boolean;
+    /**
+     * Replace the default rendering of the `<Pie>` component internally with your own.
+     *
+     * Use the `props` snippet prop to access the default props.
+     */
+    pie?: SimplifiedChartSnippet<TData, typeof Arc, PieChartExtraSnippetProps<TData> & {
+        /**
+         * Default props to apply to the Pie component.
+         */
+        props: ComponentProps<typeof Pie>;
+        /**
+         * The index of the pie series currently being iterated over.
+         */
+        index: number;
+    }>;
+    /**
+     * Replace the default rendering of the `<Arc>` component internally with your own.
+     *
+     * Use the `props` snippet prop to access the default props.
+     */
+    arc?: SimplifiedChartSnippet<TData, typeof Arc, PieChartExtraSnippetProps<TData> & {
+        props: ComponentProps<typeof Arc>;
+        /**
+         * The index of the arc currently being iterated over
+         */
+        index: number;
+        /**
+         * The index of the series currently being iterated over.
+         */
+        seriesIndex: number;
+    }>;
+    /**
+     * A callback function triggered when the arc is clicked.
+     */
+    onArcClick?: (e: MouseEvent, detail: {
+        data: any;
+        series: SeriesData<TData, typeof Arc>;
+    }) => void;
+};
 import { type ComponentProps } from 'svelte';
 import Arc from '../Arc.svelte';
-import Canvas from '../layout/Canvas.svelte';
 import Group from '../Group.svelte';
-import Legend from '../Legend.svelte';
 import Pie from '../Pie.svelte';
-import Svg from '../layout/Svg.svelte';
-import * as Tooltip from '../tooltip/index.js';
 import { type Accessor } from '../../utils/common.js';
+import type { SeriesData, SimplifiedChartProps, SimplifiedChartPropsObject, SimplifiedChartSnippet } from './types.js';
 declare class __sveltets_Render<TData> {
-    props(): {
-        ssr?: boolean;
-        pointerEvents?: boolean;
-        position?: string;
-        percentRange?: boolean;
-        width?: number;
-        height?: number;
-        containerWidth?: number;
-        containerHeight?: number;
-        element?: HTMLDivElement;
-        data?: import("d3-sankey").SankeyGraph<any, any> | import("d3-hierarchy").HierarchyNode<TData> | TData[] | undefined;
-        flatData?: any[];
-        x?: Accessor<TData>;
-        y?: Accessor<TData>;
-        z?: Accessor<TData>;
-        r?: Accessor<TData>;
-        x1?: Accessor<TData>;
-        y1?: Accessor<TData>;
-        c?: Accessor<TData>;
-        xDomain?: import("../../utils/scales").DomainType;
-        yDomain?: import("../../utils/scales").DomainType;
-        zDomain?: import("../../utils/scales").DomainType;
-        rDomain?: import("../../utils/scales").DomainType;
-        x1Domain?: import("../../utils/scales").DomainType;
-        y1Domain?: import("../../utils/scales").DomainType;
-        cDomain?: import("../../utils/scales").DomainType;
-        xNice?: boolean | number;
-        yNice?: boolean | number;
-        zNice?: boolean | number;
-        rNice?: boolean | number;
-        xPadding?: [number, number];
-        yPadding?: [number, number];
-        zPadding?: [number, number];
-        rPadding?: [number, number];
-        xScale?: import("../../utils/scales").AnyScale;
-        yScale?: import("../../utils/scales").AnyScale;
-        zScale?: import("../../utils/scales").AnyScale;
-        rScale?: import("../../utils/scales").AnyScale;
-        x1Scale?: import("../../utils/scales").AnyScale;
-        y1Scale?: import("../../utils/scales").AnyScale;
-        cScale?: import("../../utils/scales").AnyScale;
-        xRange?: string[] | number[] | ((args: {
-            width: number;
-            height: number;
-        }) => number[] | string[]) | undefined;
-        yRange?: string[] | number[] | ((args: {
-            width: number;
-            height: number;
-        }) => number[] | string[]) | undefined;
-        zRange?: string[] | number[] | ((args: {
-            width: number;
-            height: number;
-        }) => number[] | string[]) | undefined;
-        rRange?: string[] | number[] | ((args: {
-            width: number;
-            height: number;
-        }) => number[] | string[]) | undefined;
-        x1Range?: string[] | number[] | ((args: {
-            xScale: import("../../utils/scales").AnyScale;
-            width: number;
-            height: number;
-        }) => number[] | string[]) | undefined;
-        y1Range?: string[] | number[] | ((args: {
-            yScale: import("../../utils/scales").AnyScale;
-            width: number;
-            height: number;
-        }) => number[] | string[]) | undefined;
-        cRange?: string[] | readonly string[];
-        xReverse?: boolean;
-        yReverse?: boolean;
-        zReverse?: boolean;
-        rReverse?: boolean;
-        xDomainSort?: boolean;
-        yDomainSort?: boolean;
-        zDomainSort?: boolean;
-        rDomainSort?: boolean;
-        padding?: {
-            top?: Number;
-            right?: Number;
-            bottom?: Number;
-            left?: Number;
-        } | undefined;
-        extents?: {
-            x?: [min: Number, max: Number];
-            y?: [min: Number, max: Number];
-            r?: [min: Number, max: Number];
-            z?: [min: Number, max: Number];
-        } | undefined;
-        custom?: Record<string, any>;
-        debug?: boolean;
-        verbose?: boolean;
-        xBaseline?: number | null;
-        yBaseline?: number | null;
-        radial?: boolean;
-        geo?: Partial<{
-            projection?: (() => import("d3-geo").GeoProjection) | undefined;
-            fitGeojson?: import("d3-geo").GeoPermissibleObjects | undefined;
-            fixedAspectRatio?: number | undefined;
-            clipAngle?: number | undefined;
-            clipExtent?: [[number, number], [number, number]] | undefined;
-            rotate?: {
-                yaw: number;
-                pitch: number;
-                roll: number;
-            } | undefined;
-            scale?: number | undefined;
-            translate?: [number, number] | undefined;
-            center?: [number, number] | undefined;
-            applyTransform?: ("scale" | "translate" | "rotate")[];
-            reflectX?: boolean | undefined;
-            reflectY?: boolean | undefined;
-            geo?: import("svelte/store").Writable<import("d3-geo").GeoProjection>;
-        }> | undefined;
-        geoProjection?: import("svelte/store").Writable<import("d3-geo").GeoProjection> | undefined;
-        tooltip?: boolean | Partial<{
-            mode?: "manual" | "bisect-x" | "bisect-y" | "band" | "bisect-band" | "bounds" | "voronoi" | "quadtree";
-            findTooltipData?: "closest" | "left" | "right";
-            raiseTarget?: boolean;
-            locked?: boolean;
-            radius?: number;
-            debug?: boolean;
-            onclick?: (e: MouseEvent, { data }: {
-                data: any;
-            }) => any;
-            tooltip?: import("svelte/store").Writable<{
-                x: number;
-                y: number;
-                data: any;
-                show: (e: PointerEvent, tooltipData?: any) => void;
-                hide: () => void;
-                mode: "manual" | "bisect-x" | "bisect-y" | "band" | "bisect-band" | "bounds" | "voronoi" | "quadtree";
-            }>;
-            hideDelay?: number;
-        }> | undefined;
-        tooltipContext?: import("svelte/store").Writable<{
-            x: number;
-            y: number;
-            data: any;
-            show: (e: PointerEvent, tooltipData?: any) => void;
-            hide: () => void;
-            mode: "manual" | "bisect-x" | "bisect-y" | "band" | "bisect-band" | "bounds" | "voronoi" | "quadtree";
-        }> | undefined;
-        transform?: Partial<{
-            mode?: "none" | "canvas" | "manual";
-            spring?: boolean | Parameters<typeof import("../../stores/motionStore").motionStore>[1]["spring"];
-            tweened?: boolean | Parameters<typeof import("../../stores/motionStore").motionStore>[1]["tweened"];
-            processTranslate?: (x: number, y: number, deltaX: number, deltaY: number) => {
-                x: number;
-                y: number;
-            };
-            disablePointer?: boolean;
-            initialScrollMode?: "none" | "scale" | "translate";
-            clickDistance?: number;
-            ondragstart?: (() => void) | undefined;
-            ondragend?: (() => void) | undefined;
-            ontransform?: ((e: {
-                scale: number;
-                translate: {
-                    x: number;
-                    y: number;
-                };
-            }) => void) | undefined;
-            initialTranslate?: {
-                x: number;
-                y: number;
-            } | undefined;
-            translate?: import("svelte/motion").Spring<{
-                x: number;
-                y: number;
-            }> | import("svelte/motion").Tweened<{
-                x: number;
-                y: number;
-            }> | import("svelte/store").Writable<{
-                x: number;
-                y: number;
-            }>;
-            initialScale?: number | undefined;
-            scale?: import("svelte/store").Writable<number> | import("svelte/motion").Spring<number> | import("svelte/motion").Tweened<number>;
-            setScrollMode?: (mode: "none" | "scale" | "translate") => void;
-            reset?: () => void;
-            zoomIn?: () => void;
-            zoomOut?: () => void;
-            translateCenter?: () => void;
-            zoomTo?: (center: {
-                x: number;
-                y: number;
-            }, rect?: {
-                width: number;
-                height: number;
-            }) => void;
-            setTranslate?: (point: {
-                x: number;
-                y: number;
-            }, options?: import("../../stores/motionStore").MotionOptions) => void;
-            setScale?: (value: number, options?: import("../../stores/motionStore").MotionOptions) => void;
-        }> | undefined;
-        transformContext?: import("..").TransformContext;
-        brush?: boolean | Partial<{
-            axis?: "x" | "y" | "both";
-            handleSize?: number;
-            resetOnEnd?: boolean;
-            xDomain?: import("../../utils/scales").DomainType;
-            yDomain?: import("../../utils/scales").DomainType;
-            mode?: "integrated" | "separated";
-            disabled?: boolean;
-            range?: Partial<import("svelte/elements").HTMLAttributes<HTMLDivElement>> | undefined;
-            handle?: Partial<import("svelte/elements").HTMLAttributes<HTMLDivElement>> | undefined;
-            classes?: {
-                root?: string;
-                frame?: string;
-                range?: string;
-                handle?: string;
-                labels?: string;
-            };
-            onchange?: (detail: {
-                xDomain?: import("../../utils/scales").DomainType;
-                yDomain?: import("../../utils/scales").DomainType;
-            }) => void;
-            onbrushstart?: (detail: {
-                xDomain?: import("../../utils/scales").DomainType;
-                yDomain?: import("../../utils/scales").DomainType;
-            }) => void;
-            onbrushend?: (detail: {
-                xDomain?: import("../../utils/scales").DomainType;
-                yDomain?: import("../../utils/scales").DomainType;
-            }) => void;
-            onreset?: (detail: {
-                xDomain?: import("../../utils/scales").DomainType;
-                yDomain?: import("../../utils/scales").DomainType;
-            }) => void;
-            brush?: import("svelte/store").Writable<import("../BrushContext.svelte").BrushContextValue>;
-        }> | undefined;
-        brushContext?: import("svelte/store").Writable<import("../BrushContext.svelte").BrushContextValue> | undefined;
-        onresize?: ((e: import("../ChartContext.svelte").ChartResizeDetail) => void) | undefined;
-        ondragstart?: (() => void) | undefined;
-        ondragend?: (() => void) | undefined;
-        ontransform?: ((e: {
-            scale: number;
-            translate: {
-                x: number;
-                y: number;
-            };
-        }) => void) | undefined;
-    } & {
-        cornerRadius?: number;
-        innerRadius?: number | undefined;
-        key?: Accessor<TData>;
-        label?: Accessor<TData>;
-        legend?: boolean | {
-            [x: string]: any;
-            scale?: any;
-            title?: string | undefined;
-            width?: number | undefined;
-            height?: number | undefined;
-            ticks?: number | undefined;
-            tickFormat?: import("@layerstack/utils").FormatType | undefined;
-            tickValues?: any[] | undefined | undefined;
-            tickFontSize?: number | undefined;
-            tickLength?: number | undefined;
-            placement?: ("bottom" | "left" | "right" | "top" | "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right") | undefined;
-            orientation?: "horizontal" | "vertical" | undefined;
-            onclick?: ((e: MouseEvent, detail: any) => any) | undefined | undefined;
-            onpointerenter?: ((e: MouseEvent, detail: any) => any) | undefined | undefined;
-            onpointerleave?: ((e: MouseEvent, detail: any) => any) | undefined | undefined;
-            variant?: "ramp" | "swatches" | undefined;
-            classes?: {
-                root?: string;
-                title?: string;
-                label?: string;
-                tick?: string;
-                swatches?: string;
-                swatch?: string;
-                item?: (item: any) => string;
-            } | undefined;
-        };
-        maxValue?: number | undefined;
-        outerRadius?: number | undefined;
-        padAngle?: number;
-        center?: boolean;
-        placement?: "left" | "right" | "center";
-        profile?: boolean;
-        debug?: boolean;
-        props?: {
-            pie?: Partial<ComponentProps<Pie>>;
-            group?: Partial<ComponentProps<Group>>;
-            arc?: Partial<ComponentProps<Arc>>;
-            legend?: Partial<ComponentProps<Legend>>;
-            canvas?: Partial<ComponentProps<Canvas>>;
-            svg?: Partial<ComponentProps<Svg>>;
-            tooltip?: {
-                context?: Partial<ComponentProps<Tooltip.Context>>;
-                root?: Partial<ComponentProps<Tooltip.Root>>;
-                header?: Partial<ComponentProps<Tooltip.Header>>;
-                list?: Partial<ComponentProps<Tooltip.List>>;
-                item?: Partial<ComponentProps<Tooltip.Item>>;
-                separator?: Partial<ComponentProps<Tooltip.Separator>>;
-            } | undefined;
-        } | undefined;
-        range?: number[];
-        series?: {
-            key: string | number;
-            label?: string;
-            value?: Accessor<TData>;
-            /** Provider series data, else uses chart data (with value/key accessor) */
-            data?: TData[] | undefined;
-            /** Maximum possible value, useful when `data` is single item */
-            maxValue?: number;
-            color?: string;
-            props?: Partial<ComponentProps<Arc>>;
-        }[] | undefined;
-        value?: Accessor<TData>;
-        renderContext?: "svg" | "canvas";
-        onarcclick?: ((e: MouseEvent, detail: {
-            data: any;
-            series: {
-                key: string | number;
-                label?: string;
-                value?: Accessor<TData>;
-                /** Provider series data, else uses chart data (with value/key accessor) */
-                data?: TData[] | undefined;
-                /** Maximum possible value, useful when `data` is single item */
-                maxValue?: number;
-                color?: string;
-                props?: Partial<ComponentProps<Arc>>;
-            };
-        }) => void) | undefined;
-        ontooltipclick?: ((e: MouseEvent, detail: {
-            data: any;
-        }) => void) | undefined;
-    };
-    events(): {} & {
-        [evt: string]: CustomEvent<any>;
-    };
-    slots(): {
-        default: any;
-        belowContext: any;
-        belowMarks: any;
-        marks: any;
-        aboveMarks: any;
-        aboveContext: any;
-        legend: any;
-        tooltip: any;
-    };
+    props(): PieChartProps<TData>;
+    events(): {};
+    slots(): {};
+    bindings(): "context";
+    exports(): {};
 }
-export type PieChartProps<TData> = ReturnType<__sveltets_Render<TData>['props']>;
-export type PieChartEvents<TData> = ReturnType<__sveltets_Render<TData>['events']>;
-export type PieChartSlots<TData> = ReturnType<__sveltets_Render<TData>['slots']>;
-export default class PieChart<TData> extends SvelteComponentTyped<PieChartProps<TData>, PieChartEvents<TData>, PieChartSlots<TData>> {
+interface $$IsomorphicComponent {
+    new <TData>(options: import('svelte').ComponentConstructorOptions<ReturnType<__sveltets_Render<TData>['props']>>): import('svelte').SvelteComponent<ReturnType<__sveltets_Render<TData>['props']>, ReturnType<__sveltets_Render<TData>['events']>, ReturnType<__sveltets_Render<TData>['slots']>> & {
+        $$bindings?: ReturnType<__sveltets_Render<TData>['bindings']>;
+    } & ReturnType<__sveltets_Render<TData>['exports']>;
+    <TData>(internal: unknown, props: ReturnType<__sveltets_Render<TData>['props']> & {}): ReturnType<__sveltets_Render<TData>['exports']>;
+    z_$$bindings?: ReturnType<__sveltets_Render<any>['bindings']>;
 }
-export {};
+declare const PieChart: $$IsomorphicComponent;
+type PieChart<TData> = InstanceType<typeof PieChart<TData>>;
+export default PieChart;