@progress/kendo-charts 2.3.0-dev.202403071434 → 2.3.0-dev.202403191229

package/dist/npm/sankey.d.ts

@@ -1,4 +1,5 @@
 import { Group } from '@progress/kendo-drawing';
+import { Border, Margin, Padding } from './field-types';
 
 /**
  * Represents the highlight options of the Sankey links.
@@ -143,12 +144,7 @@ export interface SankeyLabel {
      *
      * @default `{ width: 0 }`
      */
-    border?: {
-        width?: number;
-        color?: string;
-        opacity?: number;
-        dashType?: string;
-    };
+    border?: Border;
     /**
      * The offset applied to the label's position.
      *
@@ -206,6 +202,71 @@ export interface SankeyNode {
     align?: 'stretch' | 'left' | 'right';
 }
 
+/**
+ * @hidden
+ */
+export interface SankeyTitle {
+    align?: 'center' | 'left' | 'right';
+    background?: string;
+    border?: Border;
+    color?: string;
+    font?: string;
+    margin?: Margin | number;
+    padding?: Padding | number;
+    position?: 'top' | 'bottom';
+    text?: string;
+    visible?: boolean;
+}
+
+/**
+ * @hidden
+ */
+export interface SankeyLegend {
+    align?: 'start' | 'center' | 'end';
+    background?: string;
+    border?: Border;
+    height?: number;
+    labels?: any;
+    margin?: Margin | number;
+    orientation?: 'vertical' | 'horizontal';
+    padding?: Padding | number;
+    position?: 'top' | 'bottom' | 'left' | 'right';
+    reverse?: boolean;
+    visible?: boolean;
+    width?: number;
+    inactiveItems?: any;
+    item?: any;
+    title?: any;
+}
+
+/**
+ * Represents the tooltips options of the Sankey widget.
+ */
+export interface SankeyTooltips {
+    /**
+     * The horizontal distance between the tooltip and the mouse pointer.
+     * The distance is measured in pixels.
+     *
+     * @default 10
+     */
+    offset?: number;
+
+    /**
+     * Indicates whether the tooltip will follow the mouse pointer.
+     *
+     * @default false
+     */
+    followPointer?: boolean;
+
+    /**
+     * Represents the delay of the tooltip displaying.
+     * The delay is measured in milliseconds.
+     *
+     * @default 1000
+     */
+    delay?: number;
+}
+
 /**
  * Represents the default link options of the Sankey widget.
  * The value will be applied to all links unless overridden by the `links` prop of the Sankey data option.
@@ -237,6 +298,9 @@ export interface SankeyOptions {
     links?: SankeyLinkDefaults;
     nodes?: SankeyNodeDefaults;
     disableAutoLayout?: boolean;
+    title?: SankeyTitle;
+    legend?: SankeyLegend;
+    tooltips?: SankeyTooltips;
 }
 
 export interface SankeyTheme {
@@ -269,12 +333,13 @@ export interface SankeyExportVisualOptions {
  * Represents the Kendo Sankey widget.
  */
 export class Sankey {
-    constructor(element: Element, options: SankeyOptions, theme?: SankeyTheme);
+    public element: HTMLElement;
+    constructor(element: HTMLElement, options: SankeyOptions, theme?: SankeyTheme);
 
     public setOptions(options: SankeyOptions): void;
     public bind(event: any, handlers: any): void;
     public unbind(event?: any, handlers?: any): void;
-    public exportVisual(options: SankeyExportVisualOptions): Group;
+    public exportVisual(options?: SankeyExportVisualOptions): Group;
     public destroy(): void;
 }
 
@@ -294,6 +359,10 @@ export interface SankeyEvent {
      * The event type.
      */
     type: string;
+    /**
+     * The dataItem of the related element.
+     */
+    dataItem: SankeyLinkDataItem | SankeyNodeDataItem;
     /**
      * Prevents the default action.
      */
@@ -303,3 +372,37 @@ export interface SankeyEvent {
      */
     isDefaultPrevented(): boolean;
 }
+
+export interface SankeyLinkDataItem extends SankeyLink {
+    source: SankeyNodeDataItem;
+    target: SankeyNodeDataItem;
+}
+
+export interface SankeyNodeDataItem extends SankeyNode {
+    sourceLinks: SankeyLinkDataItem[];
+    targetLinks: SankeyLinkDataItem[];
+}
+
+/**
+ * Represents the Sankey `tooltipShow` event object.
+ */
+export interface SankeyTooltipEvent extends SankeyEvent {
+    /**
+     * The tooltip data object.
+     */
+    tooltipData: {
+        popupOffset: { left: number, top: number };
+        popupAlign: { horizontal: string, vertical: string };
+    };
+
+    /**
+     * The tooltip target element type.
+     */
+    tooltipTargetType: 'node' | 'link';
+
+    /**
+     * The target element value.
+     * Available for the `node` tooltipTargetType.
+     */
+    nodeValue?: number;
+}