@progress/kendo-charts 2.3.0-dev.202404011240 → 2.3.0-dev.202404030928

package/dist/npm/sankey.d.ts

@@ -124,12 +124,7 @@ export interface SankeyLabel {
      *
      * @default 0
      */
-    padding?: number | {
-        left?: number;
-        right?: number;
-        top?: number;
-        bottom?: number;
-    };
+    padding?: number | Padding;
     /**
      * The margin of the label.
      *
@@ -214,40 +209,154 @@ export interface SankeyNode {
 }
 
 /**
- * @hidden
+ * Represents the title options of the Sankey widget.
  */
 export interface SankeyTitle {
+    /**
+     * The alignment of the title.
+     */
     align?: 'center' | 'left' | 'right';
+    /**
+     * The background of the title. Accepts a valid CSS color string, including hex and rgb.
+     */
     background?: string;
+    /**
+     * The border of the title.
+     */
     border?: Border;
+    /**
+     * The color of the title. Accepts a valid CSS color string, including hex and rgb.
+     */
     color?: string;
+    /**
+     * The font of the title.
+     */
     font?: string;
+    /**
+     * The margin of the title.
+     */
     margin?: Margin | number;
+    /**
+     * The padding of the title.
+     */
     padding?: Padding | number;
+    /**
+     * The position of the title.
+     */
     position?: 'top' | 'bottom';
+    /**
+     * The text of the title.
+     */
     text?: string;
+    /**
+     * The accessible description of the Sankey. The description is announced by screen readers when the Sankey is focused.
+     */
+    description?: string;
+    /**
+     * The visibility of the title. If set to `false`, the title will not be displayed.
+     */
     visible?: boolean;
 }
 
 /**
  * @hidden
  */
+interface LegendTitle extends Omit<SankeyTitle, 'description'> { }
+
+/**
+ * Represents the legend options of the Sankey widget.
+ */
 export interface SankeyLegend {
+    /**
+     * The alignment of the legend.
+     */
     align?: 'start' | 'center' | 'end';
+    /**
+     * The background of the legend. Accepts a valid CSS color string, including hex and rgb.
+     */
     background?: string;
+    /**
+     * The border of the legend.
+     */
     border?: Border;
+    /**
+     * The height of the legend.
+     */
     height?: number;
-    labels?: any;
+    /**
+     * 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;
+    };
+    /**
+     * The labels options of the legend.
+     */
+    labels?: {
+        color?: string;
+        font?: string;
+        margin?: Margin | number;
+        padding?: Padding | number;
+    };
+    /**
+     * The margin of the legend.
+     */
     margin?: Margin | number;
+    /**
+     * The X offset of the Sankey legend. The offset is relative to the default position of the legend.
+     * For instance, a value of 20 will move the legend 20 pixels to the right of its initial position.
+     * A negative value will move the legend to the left of its current position.
+     */
+    offsetX?: number;
+    /**
+     * The Y offset of the Sankey legend.  The offset is relative to the current position of the legend.
+     * For instance, a value of 20 will move the legend 20 pixels down from its initial position.
+     * A negative value will move the legend upwards from its current position.
+     */
+    offsetY?: number;
+    /**
+     * The orientation of the legend items.
+     */
     orientation?: 'vertical' | 'horizontal';
+    /**
+     * The padding of the legend. A numeric value will set all paddings.
+     */
     padding?: Padding | number;
-    position?: 'top' | 'bottom' | 'left' | 'right';
+    /**
+     * The position of the legend.
+     *
+     * The supported values are:
+     *
+     * * `top`&mdash;The legend is positioned on the top.
+     * * `bottom`&mdash;The legend is positioned on the bottom.
+     * * `left`&mdash;The legend is positioned on the left.
+     * * `right`&mdash;The legend is positioned on the right.
+     * * `custom`&mdash;The legend is positioned based on the `offsetX` and `offsetY` options.
+     */
+    position?: 'top' | 'bottom' | 'left' | 'right' | 'custom';
+    /**
+     * If set to `true` the legend items will be reversed.
+     */
     reverse?: boolean;
+    /**
+     * The spacing between the labels in pixels when the `legend.orientation` is "horizontal".
+     */
+    spacing?: number;
+    /**
+     * The title options of the legend.
+     */
+    title?: LegendTitle;
+    /**
+     * The visibility of the legend.
+     */
     visible?: boolean;
+    /**
+     * The width of the legend.
+     */
     width?: number;
-    inactiveItems?: any;
-    item?: any;
-    title?: any;
 }
 
 /**