@progress/kendo-charts 2.3.0-dev.202404191639 → 2.3.0-dev.202404241357

package/dist/npm/sankey.d.ts

@@ -25,7 +25,13 @@ export interface SankeyLinkHighlight {
  * @default `{ top: 0, left: 0 }`
  */
 export interface SankeyOffset {
+    /**
+     * The left offset of the element.
+     */
     left?: number;
+    /**
+     * The top offset of the element.
+     */
     top?: number;
 }
 
@@ -74,6 +80,39 @@ export interface SankeyLink {
     highlight?: SankeyLinkHighlight;
 }
 
+/**
+ * Represents the horizontal margin of a Sankey element.
+ */
+export interface SankeyHorizontalMargin extends Pick<Margin, 'left' | 'right'> { }
+
+/**
+ * Represents the stroke options of the Sankey label.
+ */
+export interface SankeyLabelStroke {
+    /**
+     * The stroke color of the label.
+     * Accepts a valid CSS color string, including hex and rgb.
+    */
+    color?: string;
+    /**
+     * The stroke width of the label.
+     *
+     * @default 1
+     */
+    width?: number;
+    /**
+     * The line join option of the label.
+     *
+     * The supported values are:
+     * * `round`&mdash;The outer corners of the stroke will be rounded.
+     * * `bevel`&mdash;The outer corners of the stroke will be beveled.
+     * * `miter`&mdash;The outer corners of the stroke will be squared off.
+     *
+     * @default 'round'
+     */
+    lineJoin?: 'round' | 'bevel' | 'miter';
+}
+
 /**
  * Represents the labels options of the Sankey widget.
  */
@@ -96,12 +135,6 @@ export interface SankeyLabel {
      * The color of the label.
      */
     color?: string;
-    /**
-     * The opacity of the label.
-     *
-     * @default 1
-     */
-    opacity?: number;
     /**
      * The alignment of the label.
      *
@@ -130,10 +163,7 @@ export interface SankeyLabel {
      *
      * @default `{ left: 8, right: 8 }`
      */
-    margin?: {
-        left?: number;
-        right?: number;
-    };
+    margin?: SankeyHorizontalMargin;
     /**
      * The border of the label.
      *
@@ -152,11 +182,7 @@ export interface SankeyLabel {
      *
      * @default `{ width: 1, lineJoin: 'round' }`
      */
-    stroke?: {
-        color?: string;
-        width?: number;
-        lineJoin?: 'round' | 'bevel' | 'miter';
-    };
+    stroke?: SankeyLabelStroke;
 }
 
 /**
@@ -263,6 +289,55 @@ export interface SankeyTitle {
  */
 interface LegendTitle extends Omit<SankeyTitle, 'description'> { }
 
+/**
+ * Represents the legend item options of the Sankey widget.
+ */
+export interface SankeyLegendItem {
+    /**
+     * The background color of the legend item square element. Accepts a valid CSS color string, including HEX and RGB.
+     * Defaults to the corresponding node color.
+     */
+    areaBackground?: string;
+    /**
+     * The opacity of the legend item square element.
+     * Defaults to the corresponding node opacity.
+     */
+    areaOpacity?: number;
+    /**
+     * The [cursor style](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor) of the legend item.
+     */
+    cursor?: string;
+    /**
+     * A function that can be used to create a custom visual for the legend items. The available argument fields are:
+     *
+     * * `options`&mdash;The options of the legend item.
+     * * `createVisual`&mdash;A function for getting the default visual.
+     */
+    visual?: (args: { options: any; createVisual: () => Group }) => Group;
+}
+
+/**
+ * Represents the legend label options of the Sankey widget.
+ */
+export interface SankeyLegendLabel {
+    /**
+     * The color of the legend item label.
+     */
+    color?: string;
+    /**
+     * The font of the legend item label.
+     */
+    font?: string;
+    /**
+     * The margin of the legend item label.
+     */
+    margin?: Margin | number;
+    /**
+     * The padding of the legend item label.
+     */
+    padding?: Padding | number;
+}
+
 /**
  * Represents the legend options of the Sankey widget.
  */
@@ -286,21 +361,11 @@ export interface SankeyLegend {
     /**
      * The item options of the legend. The item options apply to the legend items and will override the default options.
      */
-    item?: {
-        areaBackground?: string;
-        areaOpacity?: number;
-        cursor?: string;
-        visual?: any;
-    };
+    item?: SankeyLegendItem;
     /**
      * The labels options of the legend.
      */
-    labels?: {
-        color?: string;
-        font?: string;
-        margin?: Margin | number;
-        padding?: Padding | number;
-    };
+    labels?: SankeyLegendLabel;
     /**
      * The margin of the legend.
      */
@@ -397,24 +462,63 @@ export interface SankeyLabelDefaults extends Omit<SankeyLabel, 'text'> { }
  */
 export interface SankeyNodeDefaults extends Omit<SankeyNode, 'id' | 'label'> { }
 
+/**
+ * Represents the Sankey data object.
+ */
+export interface SankeyData {
+    /**
+     * The links of the Sankey. The links are the connections between the nodes.
+     * Each link has a `sourceId` and `targetId` that correspond to the id of the source and target nodes, and a `value` that represents the value of the link.
+    */
+    links: SankeyLink[];
+    /**
+     * The nodes of the Sankey. The nodes are the elements that are connected by the links.
+     * Each node has an `id` that is used to connect the nodes with the links.
+     */
+    nodes: SankeyNode[];
+}
+
 /**
  * Sankey options.
  */
 export interface SankeyOptions {
-    data: {
-        links: SankeyLink[];
-        nodes: SankeyNode[];
-    };
-
+    /**
+     * The data of the Sankey. The data object contains the Sankey nodes and links configuration.
+     */
+    data: SankeyData;
+    /**
+     * The default label options of the Sankey.
+     */
     labels?: SankeyLabelDefaults;
+    /**
+     * The default link options of the Sankey.
+     */
     links?: SankeyLinkDefaults;
+    /**
+     * The default node options of the Sankey.
+     */
     nodes?: SankeyNodeDefaults;
+    /**
+     * If set to `true`, the Sankey will not automatically reorder the nodes to reduce the number of links that cross over each other.
+     */
     disableAutoLayout?: boolean;
+    /**
+     * The Sankey title configuration options.
+     */
     title?: SankeyTitle;
+    /**
+     * The legend configuration options of the Sankey.
+     */
     legend?: SankeyLegend;
+    /**
+     * The tooltip configuration options of the Sankey.
+     */
     tooltip?: SankeyTooltip;
 }
 
+/**
+ * @hidden
+ */
 export interface SankeyTheme {
     labels?: SankeyLabelDefaults;
     links?: SankeyLinkDefaults;
@@ -489,14 +593,38 @@ export interface SankeyEvent {
     isDefaultPrevented(): boolean;
 }
 
-export interface SankeyLinkDataItem extends SankeyLink {
+/**
+ * Represents the Sankey dataItem of the link element.
+ */
+export interface SankeyLinkDataItem {
+    /**
+     * The source node dataItem.
+     */
     source: SankeyNodeDataItem;
+    /**
+     * The target node dataItem.
+     */
     target: SankeyNodeDataItem;
+    /**
+     * The value of the link.
+     */
+    value: number;
 }
 
+/**
+ * Represents the Sankey dataItem of the node element.
+ */
 export interface SankeyNodeDataItem extends SankeyNode {
-    sourceLinks: SankeyLinkDataItem[];
-    targetLinks: SankeyLinkDataItem[];
+    /**
+     * The source links that are connected to the node.
+     * Contains the `sourceId`, `targetId` and `value` of the links.
+     */
+    sourceLinks: SankeyLink[];
+    /**
+     * The target links that are connected to the node.
+     * Contains the `sourceId`, `targetId` and `value` of the links.
+     */
+    targetLinks: SankeyLink[];
 }
 
 /**