layerchart 2.0.0-next.1 → 2.0.0-next.11

package/dist/components/Sankey.svelte.d.ts

@@ -1,32 +1,62 @@
-import { SvelteComponentTyped } from "svelte";
-import { type SankeyNode } from 'd3-sankey';
-declare const __propDef: {
-    props: {
-        nodes?: (d: any) => any;
-        nodeId?: (d: any) => any;
-        /**
-           * see: https://github.com/d3/d3-sankey#alignments
-           */ nodeAlign?: ((node: SankeyNode<any, any>, n: number) => number) | "left" | "right" | "center" | "justify";
-        nodeWidth?: number;
-        nodePadding?: number;
-        nodeSort?: undefined;
-        links?: (d: any) => any;
-        linkSort?: undefined;
-        onupdate?: ((data: import("d3-sankey").SankeyGraph<{}, {}>) => void) | undefined;
-    };
-    events: {
-        [evt: string]: CustomEvent<any>;
-    };
-    slots: {
-        default: {
-            nodes: SankeyNode<Record<string, any>, any>[];
-            links: any[];
-        };
-    };
+import type { Snippet } from 'svelte';
+export type NodeExtraProperties = Record<string, any>;
+export type SankeyProps = {
+    /**
+     * The function to get the nodes from the data.
+     * @default (d: any) => d.nodes
+     */
+    nodes?: (d: any) => any;
+    /**
+     * The function to get the node ID from the node data.
+     *
+     * @default (d: any) => d.index
+     */
+    nodeId?: (d: any) => any;
+    /**
+     * @see https://github.com/d3/d3-sankey#alignments
+     *
+     * @default sankeyJustify
+     */
+    nodeAlign?: ((node: SankeyNode<any, any>, n: number) => number) | 'left' | 'right' | 'center' | 'justify';
+    /**
+     * The width of the nodes.
+     *
+     * @default 4
+     */
+    nodeWidth?: number;
+    /**
+     * The padding between nodes.
+     *
+     * @default 10
+     */
+    nodePadding?: number;
+    /**
+     * The function to sort the nodes.
+     */
+    nodeSort?: (a: SankeyNode<any, any>, b: SankeyNode<any, any>) => number | undefined;
+    /**
+     * The function to get the links from the data.
+     *
+     * @default (d: any) => d.links
+     */
+    links?: (d: any) => any;
+    /**
+     * The function to sort the links.
+     *
+     */
+    linkSort?: (a: SankeyLink<any, any>, b: SankeyLink<any, any>) => number | undefined;
+    /**
+     * A function to be called when the data is updated.
+     */
+    onUpdate?: (data: SankeyGraph<{}, {}>) => void;
+    children?: Snippet<[
+        {
+            nodes: SankeyNode<NodeExtraProperties, any>[];
+            links: SankeyNode<NodeExtraProperties, any>[];
+        }
+    ]>;
 };
-export type SankeyProps = typeof __propDef.props;
-export type SankeyEvents = typeof __propDef.events;
-export type SankeySlots = typeof __propDef.slots;
-export default class Sankey extends SvelteComponentTyped<SankeyProps, SankeyEvents, SankeySlots> {
-}
-export {};
+import { type SankeyNode, type SankeyLink, type SankeyGraph } from 'd3-sankey';
+declare const Sankey: import("svelte").Component<SankeyProps, {}, "">;
+type Sankey = ReturnType<typeof Sankey>;
+export default Sankey;