@progress/kendo-charts 2.0.0-dev.202401111417 → 2.1.0-dev.202401181402

package/dist/npm/sankey.d.ts

@@ -0,0 +1,244 @@
+/**
+ * Represents the highlight options of the Sankey links.
+ */
+export interface SankeyLinkHighlight {
+    /**
+     * The opacity of the link.
+     */
+    opacity?: number;
+    /**
+     * The opacity of the inactive link.
+     */
+    inactiveOpacity?: number;
+}
+
+/**
+ * Represents the offset option of the Sankey node and label elements.
+ */
+export interface SankeyOffset {
+    left?: number;
+    top?: number;
+}
+
+/**
+ * Represents the links options of the Sankey widget.
+ */
+export interface SankeyLink {
+    /**
+     * The source node ID of the link.
+     */
+    sourceId: string | number;
+    /**
+     * The target node ID of the link.
+     */
+    targetId: string | number;
+    /**
+     * The value of the link.
+     */
+    value: number;
+    /**
+     * The color type of the link.
+     * The supported values are:
+     * * `static`—The link color is static. The color is determined by the link's `color` option.
+     * * `source`—The link color is the same as the source node color.
+     * * `target`—The link color is the same as the target node color.
+     */
+    colorType?: 'static' | 'source' | 'target';
+    /**
+     * The color of the link.
+     * The color is used when the `colorType` option is set to `static`.
+     */
+    color?: string;
+    /**
+     * The opacity of the link.
+     */
+    opacity?: number;
+    /**
+     * The highlight options of the link.
+     */
+    highlight?: SankeyLinkHighlight;
+}
+
+/**
+ * Represents the labels options of the Sankey widget.
+ */
+export interface SankeyLabel {
+    /**
+     * The text of the label.
+     */
+    text?: string;
+    /**
+     * The visibility of the label.
+     */
+    visible?: boolean;
+    /**
+     * The font of the label.
+     */
+    font?: string;
+    /**
+     * The color of the label.
+     */
+    color?: string;
+    /**
+     * The opacity of the label.
+     */
+    opacity?: number;
+    /**
+     * The alignment of the label.
+     */
+    align?: 'left' | 'right' | 'center';
+    /**
+     * The position of the label.
+     *
+     * The supported values are:
+     * * `inside`—The label is positioned after the node, except for the nodes at the end of the sankey, that are placed before the node.
+     * * `before`—The label is positioned before the node.
+     * * `after`—The label is positioned after the node.
+     *
+     * @default 'inside'
+     */
+    position?: 'inside' | 'before' | 'after';
+    /**
+     * The padding of the label.
+     */
+    padding?: number | {
+        left?: number;
+        right?: number;
+        top?: number;
+        bottom?: number;
+    };
+    /**
+     * The margin of the label.
+     */
+    margin?: {
+        left?: number;
+        right?: number;
+    };
+    /**
+     * The border of the label.
+     */
+    border?: {
+        width?: number;
+        color?: string;
+        opacity?: number;
+        dashType?: string;
+    };
+    /**
+     * The offset of the label applied to the label position.
+     *
+     * @default `{ top: 0, left: 0 }`
+     */
+    offset?: SankeyOffset;
+}
+
+/**
+ * Represents the nodes options of the Sankey widget.
+ */
+export interface SankeyNode {
+    /**
+     * The ID of the node.
+     */
+    id: string | number;
+    /**
+     * The label options of the node.
+     */
+    label: SankeyLabel;
+    /**
+     * The color of the node.
+     */
+    color?: string;
+    /**
+     * The opacity of the node.
+     */
+    opacity?: number;
+    /**
+     * The offset of the node applied to the node position.
+     *
+     * @default `{ top: 0, left: 0 }`
+     */
+    offset?: SankeyOffset;
+    /**
+     * The minimum vertical space between two nodes.
+     */
+    padding?: number;
+    /**
+     * The width of the node.
+     */
+    width?: number;
+}
+
+/**
+ * Represents the default links options of the Sankey widget.
+ * The value will be applied to all links unless overridden by the `links` prop of the Sankey data option.
+ */
+export interface SankeyLinkDefaults extends Omit<SankeyLink, 'sourceId' | 'targetId' | 'value'> { }
+/**
+ * Represents the default labels options of the Sankey widget.
+ * The value will be applied to all labels unless overridden by the `nodes` label prop of the Sankey data option.
+ */
+export interface SankeyLabelDefaults extends Omit<SankeyLabel, 'text'> { }
+
+/**
+ * Represents the default nodes options of the Sankey widget.
+ * The value will be applied to all nodes unless overridden by the `nodes` prop of the Sankey data option.
+ */
+export interface SankeyNodeDefaults extends Omit<SankeyNode, 'id' | 'label'> { }
+
+/**
+ * Sankey options.
+ */
+export interface SankeyOptions {
+    data: {
+        links: SankeyLink[];
+        nodes: SankeyNode[];
+    };
+
+    labels?: SankeyLabelDefaults;
+    links?: SankeyLinkDefaults;
+    nodes?: SankeyNodeDefaults;
+}
+
+export interface SankeyTheme {
+    labels?: SankeyLabelDefaults;
+    links?: SankeyLinkDefaults;
+    nodes?: SankeyNodeDefaults;
+    nodesColors: string[];
+}
+
+/**
+ * Represents the Kendo Sankey widget.
+ */
+export class Sankey {
+    constructor(element: Element, options: SankeyOptions, theme?: SankeyTheme);
+
+    public setOptions(options: SankeyOptions): void;
+    public bind(event: any, handlers: any): void;
+    public unbind(event?: any, handlers?: any): void;
+    public destroy(): void;
+}
+
+/**
+ * Represents the Sankey widget event object.
+ */
+export interface SankeyEvent {
+    /**
+     * The Sankey widget instance.
+     */
+    sender: Sankey;
+    /**
+     * The native DOM event.
+     */
+    originalEvent: Event;
+    /**
+     * The event type.
+     */
+    type: string;
+    /**
+     * Prevents the default action.
+     */
+    preventDefault(): void;
+    /**
+     * Indicates whether the default action has been prevented.
+     */
+    isDefaultPrevented(): boolean;
+}