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

package/dist/npm/sankey.d.ts

@@ -517,3 +517,52 @@ export interface SankeyTooltipEvent extends SankeyEvent {
      */
     nodeValue?: number;
 }
+
+/**
+ * Converts data objects to Sankey data.
+ *
+ * @param data - The data objects.
+ * @param dimensions - The dimensions of the data.
+ * @param measure - The measure of the data.
+ * @returns The Sankey data.
+ *
+ * @example
+ * ```ts
+ * const data = [
+ *  { gender: 'Female', device: 'Tablet', age: '< 18', value: 4 },
+ *  { gender: 'Female', device: 'Tablet', age: "> 40", value: 8 },
+ *  { gender: 'Female', device: 'Mobile', age: '< 18', value: 4 },
+ *  { gender: 'Female', device: 'Mobile', age: '18-26', value: 24 },
+ *  { gender: 'Female', device: 'Mobile', age: '27-40', value: 10 },
+ *  { gender: 'Female', device: 'Mobile', age: '> 40', value: 2 },
+ *  { gender: 'Female', device: 'Desktop', age: '18-26', value: 11 },
+ *  { gender: 'Female', device: 'Desktop', age: '27-40', value: 28 },
+ *  { gender: 'Female', device: 'Desktop', age: '> 40', value: 9 },
+ *  { gender: 'Male', device: 'Mobile', age: '< 18', value: 4 },
+ *  { gender: 'Male', device: 'Mobile', age: '18-26', value: 11 },
+ *  { gender: 'Male', device: 'Mobile', age: '27-40', value: 28 },
+ *  { gender: 'Male', device: 'Mobile', age: '> 40', value: 9 },
+ *  { gender: 'Male', device: 'Desktop', age: '18-26', value: 11 },
+ *  { gender: 'Male', device: 'Desktop', age: '27-40', value: 28 },
+ *  { gender: 'Male', device: 'Desktop', age: '> 40', value: 9 },
+ * ];
+ *
+ * const dimensions = [
+ *  { value: item => item.gender },
+ *  { value: item => item.device },
+ *  { value: item => 'Age ' + item.age }
+ * ];
+ * const measure = { value: item => item.value };
+ *
+ * const sankeyData = createSankeyData(data, dimensions, measure);
+ *
+ * const sankey = new Sankey(document.getElementById('sankey'), {
+ *  data: sankeyData
+ * });
+ * ```
+ */
+export function createSankeyData(
+    data: object[],
+    dimensions: { value: (item: object) => string }[],
+    measure: { value: (item: object) => number }
+): { links: SankeyLink[]; nodes: SankeyNode[] };