@sisense/sdk-ui 2.29.0 → 2.30.0

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/sankey-chart/data-options/index.d.ts

@@ -0,0 +1,33 @@
+import { Attribute, Measure } from '@sisense/sdk-data';
+import { ChartDataOptions, ChartDataOptionsInternal, SankeyChartDataOptions, SankeyChartDataOptionsInternal } from '../../../../../../../../domains/visualizations/core/chart-data-options/types';
+/**
+ * Translates public Sankey data options to the internal format.
+ */
+declare function translateDataOptionsToInternal(dataOptions: SankeyChartDataOptions): SankeyChartDataOptionsInternal;
+/**
+ * Returns all category columns as query attributes.
+ */
+declare function getAttributes(internalDataOptions: SankeyChartDataOptionsInternal): Attribute[];
+/**
+ * Returns the value column as a query measure.
+ */
+declare function getMeasures(internalDataOptions: SankeyChartDataOptionsInternal): Measure[];
+/**
+ * Type guard: checks if data options are SankeyChartDataOptions (public).
+ * Key distinction: `value` is a single measure (not an array), `category` has at least two columns
+ * (flow stages), and the shape is not Cartesian (`breakBy` is absent).
+ */
+declare function isCorrectDataOptions(dataOptions: ChartDataOptions): dataOptions is SankeyChartDataOptions;
+/**
+ * Type guard: checks if internal data options are SankeyChartDataOptionsInternal.
+ */
+declare function isCorrectDataOptionsInternal(dataOptions: ChartDataOptionsInternal): dataOptions is SankeyChartDataOptionsInternal;
+/** Translator bundle for converting between public and internal Sankey data options. */
+export declare const dataOptionsTranslators: {
+    translateDataOptionsToInternal: typeof translateDataOptionsToInternal;
+    getAttributes: typeof getAttributes;
+    getMeasures: typeof getMeasures;
+    isCorrectDataOptions: typeof isCorrectDataOptions;
+    isCorrectDataOptionsInternal: typeof isCorrectDataOptionsInternal;
+};
+export {};

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/sankey-chart/design-options/index.d.ts

@@ -0,0 +1,21 @@
+import { ChartStyleOptions, SankeyStyleOptions } from '../../../../../../../../types';
+import { SankeyChartDesignOptions } from '../types';
+/**
+ * Translates SankeyStyleOptions to SankeyChartDesignOptions.
+ */
+declare function translateStyleOptionsToDesignOptions(styleOptions: SankeyStyleOptions): SankeyChartDesignOptions;
+/**
+ * Type guard: returns true only for plain (non-null, non-array) objects.
+ */
+declare function isCorrectStyleOptions(styleOptions: ChartStyleOptions): styleOptions is SankeyStyleOptions;
+/**
+ * Default style options for SankeyChart.
+ */
+declare function getDefaultStyleOptions(): SankeyStyleOptions;
+/** Translator bundle for converting between style and design options for the Sankey chart. */
+export declare const designOptionsTranslators: {
+    translateStyleOptionsToDesignOptions: typeof translateStyleOptionsToDesignOptions;
+    isCorrectStyleOptions: typeof isCorrectStyleOptions;
+    getDefaultStyleOptions: typeof getDefaultStyleOptions;
+};
+export {};

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/sankey-chart/highchart-options/highcharts-options-builder.d.ts

@@ -0,0 +1,3 @@
+import type { HighchartsOptionsBuilder } from '../../types';
+/** Builds Highcharts series/chart/plot options for the Sankey chart type. */
+export declare const sankeyHighchartsOptionsBuilder: HighchartsOptionsBuilder<'sankey'>;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/sankey-chart/sankey-chart-builder.d.ts

@@ -0,0 +1,3 @@
+import { ChartBuilder } from '../../types.js';
+/** Wires together data options, data, design options, and Highcharts renderer for the Sankey chart. */
+export declare const sankeyChartBuilder: ChartBuilder<'sankey'>;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/sankey-chart/sankey-node-colors.d.ts

@@ -0,0 +1,10 @@
+import { StyledColumn } from '../../../../../../../domains/visualizations/core/chart-data-options/types.js';
+import { MultiColumnValueToColorMap, ValueToColorMap } from '../../../../../../../types';
+/**
+ * Resolves an explicit color for a Sankey node from `seriesToColorMap`.
+ *
+ * Supports both {@link ValueToColorMap} (flat, keyed by display name) and
+ * {@link MultiColumnValueToColorMap} (nested, keyed by category column then display name).
+ * Multi-column lookup uses the column index encoded in the node id.
+ */
+export declare function getSankeyNodeColorFromMap(nodeId: string, displayName: string, categories: readonly StyledColumn[], seriesToColorMap?: ValueToColorMap | MultiColumnValueToColorMap): string | undefined;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/sankey-chart/types.d.ts

@@ -0,0 +1,38 @@
+import { SankeyChartDataOptionsInternal } from '../../../../../../../domains/visualizations/core/chart-data-options/types';
+import { ChartData } from '../../../../../../../domains/visualizations/core/chart-data/types';
+import { SankeyChartDesignOptions } from '../../../../../../../domains/visualizations/core/chart-options-processor/translations/design-options';
+import { SankeyStyleOptions } from '../../../../../../../types';
+/**
+ * A single flow link between two Sankey nodes.
+ */
+export type SankeyLink = {
+    from: string;
+    to: string;
+    weight: number;
+};
+/**
+ * A single node in a Sankey diagram.
+ */
+export type SankeyNode = {
+    id: string;
+    name?: string;
+    color?: string;
+    /** Raw query value for this node — used to build members filters on click. */
+    rawValue?: unknown;
+    /** When true, the node (and its links) should be visually dimmed for highlight mode. */
+    blur?: boolean;
+};
+/**
+ * Processed chart data ready for the Highcharts Sankey renderer.
+ */
+export type SankeyChartData = {
+    type: 'sankey';
+    links: SankeyLink[];
+    nodes: SankeyNode[];
+    /** Total links before truncation; undefined when no truncation occurred. */
+    totalLinksBeforeTruncation?: number;
+};
+export declare const isSankeyChartData: (chartData: ChartData) => chartData is SankeyChartData;
+export type { SankeyChartDataOptionsInternal };
+export type { SankeyChartDesignOptions };
+export type SankeyChartStyleOptions = SankeyStyleOptions;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/types.d.ts

@@ -2,7 +2,7 @@ import { TFunction } from '@sisense/sdk-common';
 import { HighchartsOptionsInternal } from '../../../../../../domains/visualizations/core/chart-options-processor/chart-options-service.js';
 import { CompleteThemeSettingsInternal } from '../../../../../../types';
 import { TypedChartData, TypedDataOptionsInternal, TypedDesignOptions } from '../types.js';
-export type HighchartBasedChartTypes = 'column' | 'bar' | 'line' | 'area' | 'streamgraph' | 'polar' | 'pie' | 'funnel' | 'treemap' | 'calendar-heatmap' | 'sunburst';
+export type HighchartBasedChartTypes = 'column' | 'bar' | 'line' | 'area' | 'streamgraph' | 'polar' | 'pie' | 'funnel' | 'treemap' | 'calendar-heatmap' | 'sunburst' | 'sankey';
 export type HighchartsOptionsBuilder<CT extends HighchartBasedChartTypes> = {
     getChart: (ctx: BuildContext<CT>) => HighchartsOptionsInternal['chart'];
     getSeries: (ctx: BuildContext<CT>) => HighchartsOptionsInternal['series'];
@@ -24,5 +24,6 @@ export type BuildContext<CT extends HighchartBasedChartTypes> = {
         themeSettings: CompleteThemeSettingsInternal;
         dateFormatter: (date: Date, format: string) => string;
         accessibilityEnabled: boolean;
+        defaultNumberFormattingEnabled: boolean;
     };
 };

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/types.d.ts

@@ -6,28 +6,29 @@ import { QueryDescription } from '../../../../../domains/query-execution/core/ex
 import type { ChartRendererProps } from '../../../../../domains/visualizations/components/chart';
 import { ScattermapProps } from '../../../../../domains/visualizations/components/chart/components/scattermap/scattermap';
 import { AreamapProps } from '../../../../../domains/visualizations/components/chart/restructured-charts/areamap-chart/renderer';
-import { AreamapChartDataOptions, AreamapChartDataOptionsInternal, CalendarHeatmapChartDataOptions, CalendarHeatmapChartDataOptionsInternal, CartesianChartDataOptions, CartesianChartDataOptionsInternal, CategoricalChartDataOptions, CategoricalChartDataOptionsInternal, ChartDataOptionsInternal, ScattermapChartDataOptions, ScattermapChartDataOptionsInternal } from '../../../../../domains/visualizations/core/chart-data-options/types';
+import { AreamapChartDataOptions, AreamapChartDataOptionsInternal, CalendarHeatmapChartDataOptions, CalendarHeatmapChartDataOptionsInternal, CartesianChartDataOptions, CartesianChartDataOptionsInternal, CategoricalChartDataOptions, CategoricalChartDataOptionsInternal, ChartDataOptionsInternal, SankeyChartDataOptions, SankeyChartDataOptionsInternal, ScattermapChartDataOptions, ScattermapChartDataOptionsInternal } from '../../../../../domains/visualizations/core/chart-data-options/types';
 import { DataTable } from '../../../../../domains/visualizations/core/chart-data-processor/table-processor';
 import type { CartesianChartData, CategoricalChartData, ScattermapChartData } from '../../../../../domains/visualizations/core/chart-data/types';
 import { DesignOptions } from '../../../../../domains/visualizations/core/chart-options-processor/translations/types';
 import { type ClientApplication } from '../../../../../infra/app/types';
-import type { AreamapStyleOptions, AreaStyleOptions, CalendarHeatmapStyleOptions, ChartDataOptions, ChartStyleOptions, FunnelStyleOptions, LineStyleOptions, PieStyleOptions, PolarStyleOptions, ScattermapStyleOptions, StackableStyleOptions, StreamgraphStyleOptions, SunburstStyleOptions, TreemapStyleOptions } from '../../../../../types';
+import type { AreamapStyleOptions, AreaStyleOptions, CalendarHeatmapStyleOptions, ChartDataOptions, ChartStyleOptions, FunnelStyleOptions, LineStyleOptions, PieStyleOptions, PolarStyleOptions, SankeyStyleOptions, ScattermapStyleOptions, StackableStyleOptions, StreamgraphStyleOptions, SunburstStyleOptions, TreemapStyleOptions } from '../../../../../types';
 import { AreamapData } from './areamap-chart/types';
 import { CalendarHeatmapChartData } from './highchart-based-charts/calendar-heatmap-chart/data';
 import { HighchartsBasedChartRendererProps } from './highchart-based-charts/highcharts-based-chart-renderer/highcharts-based-chart-renderer';
-export type SupportedChartType = 'areamap' | 'column' | 'bar' | 'line' | 'area' | 'polar' | 'pie' | 'funnel' | 'calendar-heatmap' | 'treemap' | 'sunburst' | 'streamgraph';
-export type TypedChartDataOptions<CT extends SupportedChartType> = CT extends 'areamap' ? AreamapChartDataOptions : CT extends 'scattermap' ? ScattermapChartDataOptions : CT extends 'pie' | 'funnel' | 'treemap' | 'sunburst' ? CategoricalChartDataOptions : CT extends 'column' | 'bar' | 'line' | 'area' | 'polar' | 'streamgraph' ? CartesianChartDataOptions : CT extends 'calendar-heatmap' ? CalendarHeatmapChartDataOptions : never;
-export type TypedDataOptionsInternal<CT extends SupportedChartType> = CT extends 'areamap' ? AreamapChartDataOptionsInternal : CT extends 'scattermap' ? ScattermapChartDataOptionsInternal : CT extends 'pie' | 'funnel' | 'treemap' | 'sunburst' ? CategoricalChartDataOptionsInternal : CT extends 'column' | 'bar' | 'line' | 'area' | 'polar' | 'streamgraph' ? CartesianChartDataOptionsInternal : CT extends 'calendar-heatmap' ? CalendarHeatmapChartDataOptionsInternal : never;
-export type TypedChartStyleOptions<CT extends SupportedChartType> = CT extends 'areamap' ? AreamapStyleOptions : CT extends 'scattermap' ? ScattermapStyleOptions : CT extends 'pie' ? PieStyleOptions : CT extends 'funnel' ? FunnelStyleOptions : CT extends 'treemap' ? TreemapStyleOptions : CT extends 'sunburst' ? SunburstStyleOptions : CT extends 'column' | 'bar' ? StackableStyleOptions : CT extends 'line' ? LineStyleOptions : CT extends 'area' ? AreaStyleOptions : CT extends 'polar' ? PolarStyleOptions : CT extends 'calendar-heatmap' ? CalendarHeatmapStyleOptions : CT extends 'streamgraph' ? StreamgraphStyleOptions : never;
+import { SankeyChartData } from './highchart-based-charts/sankey-chart/types';
+export type SupportedChartType = 'areamap' | 'column' | 'bar' | 'line' | 'area' | 'polar' | 'pie' | 'funnel' | 'calendar-heatmap' | 'treemap' | 'sunburst' | 'streamgraph' | 'sankey';
+export type TypedChartDataOptions<CT extends SupportedChartType> = CT extends 'areamap' ? AreamapChartDataOptions : CT extends 'scattermap' ? ScattermapChartDataOptions : CT extends 'pie' | 'funnel' | 'treemap' | 'sunburst' ? CategoricalChartDataOptions : CT extends 'column' | 'bar' | 'line' | 'area' | 'polar' | 'streamgraph' ? CartesianChartDataOptions : CT extends 'calendar-heatmap' ? CalendarHeatmapChartDataOptions : CT extends 'sankey' ? SankeyChartDataOptions : never;
+export type TypedDataOptionsInternal<CT extends SupportedChartType> = CT extends 'areamap' ? AreamapChartDataOptionsInternal : CT extends 'scattermap' ? ScattermapChartDataOptionsInternal : CT extends 'pie' | 'funnel' | 'treemap' | 'sunburst' ? CategoricalChartDataOptionsInternal : CT extends 'column' | 'bar' | 'line' | 'area' | 'polar' | 'streamgraph' ? CartesianChartDataOptionsInternal : CT extends 'calendar-heatmap' ? CalendarHeatmapChartDataOptionsInternal : CT extends 'sankey' ? SankeyChartDataOptionsInternal : never;
+export type TypedChartStyleOptions<CT extends SupportedChartType> = CT extends 'areamap' ? AreamapStyleOptions : CT extends 'scattermap' ? ScattermapStyleOptions : CT extends 'pie' ? PieStyleOptions : CT extends 'funnel' ? FunnelStyleOptions : CT extends 'treemap' ? TreemapStyleOptions : CT extends 'sunburst' ? SunburstStyleOptions : CT extends 'column' | 'bar' ? StackableStyleOptions : CT extends 'line' ? LineStyleOptions : CT extends 'area' ? AreaStyleOptions : CT extends 'polar' ? PolarStyleOptions : CT extends 'calendar-heatmap' ? CalendarHeatmapStyleOptions : CT extends 'streamgraph' ? StreamgraphStyleOptions : CT extends 'sankey' ? SankeyStyleOptions : never;
 export type TypedDesignOptions<CT extends SupportedChartType> = DesignOptions<CT>;
-export type TypedChartData<CT extends SupportedChartType> = CT extends 'areamap' ? AreamapData : CT extends 'scattermap' ? ScattermapChartData : CT extends 'pie' | 'funnel' | 'treemap' | 'sunburst' ? CategoricalChartData : CT extends 'column' | 'bar' | 'line' | 'area' | 'polar' | 'streamgraph' ? CartesianChartData : CT extends 'calendar-heatmap' ? CalendarHeatmapChartData : never;
+export type TypedChartData<CT extends SupportedChartType> = CT extends 'areamap' ? AreamapData : CT extends 'scattermap' ? ScattermapChartData : CT extends 'pie' | 'funnel' | 'treemap' | 'sunburst' ? CategoricalChartData : CT extends 'column' | 'bar' | 'line' | 'area' | 'polar' | 'streamgraph' ? CartesianChartData : CT extends 'calendar-heatmap' ? CalendarHeatmapChartData : CT extends 'sankey' ? SankeyChartData : never;
 export type TypedLoadDataFunction<CT extends SupportedChartType> = (options: {
     app: ClientApplication;
     chartDataOptionsInternal: TypedDataOptionsInternal<CT>;
     queryDescription: QueryDescription;
     executionConfig?: QueryExecutionConfig;
 }) => Promise<QueryResultData>;
-export type TypedChartRendererProps<CT extends SupportedChartType> = CT extends 'areamap' ? AreamapProps : CT extends 'scattermap' ? ScattermapProps : CT extends 'column' | 'bar' | 'line' | 'area' | 'polar' | 'pie' | 'funnel' | 'calendar-heatmap' | 'treemap' | 'sunburst' | 'streamgraph' ? HighchartsBasedChartRendererProps<CT> : never;
+export type TypedChartRendererProps<CT extends SupportedChartType> = CT extends 'areamap' ? AreamapProps : CT extends 'scattermap' ? ScattermapProps : CT extends 'column' | 'bar' | 'line' | 'area' | 'polar' | 'pie' | 'funnel' | 'calendar-heatmap' | 'treemap' | 'sunburst' | 'streamgraph' | 'sankey' ? HighchartsBasedChartRendererProps<CT> : never;
 /**
  * Chart builder interface.
  */
@@ -68,7 +69,9 @@ export interface ChartBuilder<CT extends SupportedChartType = SupportedChartType
         /**
          * Translates the data table to the chart data.
          */
-        getChartData: (chartDataOptions: TypedDataOptionsInternal<CT>, dataTable: DataTable) => TypedChartData<CT>;
+        getChartData: (chartDataOptions: TypedDataOptionsInternal<CT>, dataTable: DataTable, options?: {
+            defaultNumberFormattingEnabled?: boolean;
+        }) => TypedChartData<CT>;
     };
     /**
      * Design options translation utils.

package/dist/packages/sdk-ui/src/domains/visualizations/components/pivot-table/formatters/data-cell-formatters/data-cell-value-formatter.d.ts

@@ -1,3 +1,3 @@
 import { type PivotTableDataOptions } from '../../../../../../domains/visualizations/core/chart-data-options/types.js';
 import { type DataCellFormatter } from '../types.js';
-export declare const createDataCellValueFormatter: (dataOptions: PivotTableDataOptions) => DataCellFormatter;
+export declare const createDataCellValueFormatter: (dataOptions: PivotTableDataOptions, defaultNumberFormattingEnabled?: boolean) => DataCellFormatter;

package/dist/packages/sdk-ui/src/domains/visualizations/components/pivot-table/formatters/header-cell-formatters/header-cell-value-formatter.d.ts

@@ -1,7 +1,7 @@
 import type { PivotTableDataOptions } from '../../../../../../domains/visualizations/core/chart-data-options/types.js';
 import { DateFormatter } from '../../../../../../shared/formatters/create-date-formatter.js';
 import type { HeaderCellFormatter } from '../types.js';
-export declare const createHeaderCellValueFormatter: (dataOptions: PivotTableDataOptions, dateFormatter: DateFormatter) => HeaderCellFormatter;
+export declare const createHeaderCellValueFormatter: (dataOptions: PivotTableDataOptions, dateFormatter: DateFormatter, defaultNumberFormattingEnabled?: boolean) => HeaderCellFormatter;
 /**
  * Formats the date time string or Date object.
  * If the date is invalid, it returns the original value.

package/dist/packages/sdk-ui/src/domains/visualizations/components/pivot-table/hooks/use-pivot-data-loading.d.ts

@@ -3,6 +3,7 @@ import { PivotBuilder } from '@sisense/sdk-pivot-ui';
 interface LoadingState {
     isLoading: boolean;
     isNoResults: boolean;
+    error?: Error;
 }
 /**
  * Hook that initiates loading if jaql is changed or force reload is triggered.

package/dist/packages/sdk-ui/src/domains/visualizations/components/pivot-table/resolve-pivot-container-size.d.ts

@@ -0,0 +1,28 @@
+import type { ContainerSize } from '../../../../shared/components/dynamic-size-container/dynamic-size-container';
+/**
+ * Resolves the pivot render viewport from the measured container size.
+ *
+ * In auto-height mode the pivot reports its own content height; holder height must not track
+ * outer layout changes (e.g. widget top-slot narrative growing), or the pivot remeasures in a loop.
+ * When auto-height is off, holder height follows the container so fixed-height widgets shrink correctly
+ * when drilldown breadcrumbs or other top-slot content appears.
+ *
+ * @param containerSize - Size reported by {@link DynamicSizeContainer}.
+ * @param padding - Pivot padding subtracted from the container size.
+ * @param previousSize - Previously resolved pivot viewport, if any.
+ * @param isAutoHeight - Whether the pivot is in auto-height mode.
+ * @returns The viewport size passed to the pivot renderer.
+ * @internal
+ */
+export declare function resolvePivotContainerSize(containerSize: ContainerSize, padding: {
+    readonly vertical: number;
+    readonly horizontal: number;
+}, previousSize: ContainerSize | null, isAutoHeight: boolean): ContainerSize;
+/**
+ * Returns whether the resolved pivot viewport differs from the previous value.
+ * @param previousSize - The previously resolved pivot viewport, or null on first measure.
+ * @param nextSize - The next resolved pivot viewport.
+ * @returns True if the resolved pivot viewport differs from the previous value, false otherwise.
+ * @internal
+ */
+export declare function hasPivotContainerSizeChanged(previousSize: ContainerSize | null, nextSize: ContainerSize): boolean;

package/dist/packages/sdk-ui/src/domains/visualizations/components/sankey-chart.d.ts

@@ -0,0 +1,30 @@
+/// <reference types="react" />
+import { SankeyChartProps } from '../../../props';
+/**
+ * A React component that visualizes flow and volume between nodes using a Sankey diagram.
+ * Node width represents the total flow through that node; link width represents the flow
+ * between two connected nodes.
+ *
+ * @beta
+ *
+ * ## Example
+ *
+ * ```tsx
+ * <SankeyChart
+ *   dataSet={DM.DataSource}
+ *   dataOptions={{
+ *     category: [DM.Commerce.Gender, DM.Commerce.AgeRange],
+ *     value: measureFactory.sum(DM.Commerce.Revenue),
+ *   }}
+ *   styleOptions={{
+ *     orientation: 'horizontal',
+ *     nodeAlignment: 'top',
+ *   }}
+ * />
+ * ```
+ *
+ * @param props - Sankey chart properties
+ * @returns Sankey Chart component
+ * @group Charts
+ */
+export declare const SankeyChart: import("react").FunctionComponent<SankeyChartProps>;

package/dist/packages/sdk-ui/src/domains/visualizations/components/table/pure-table/helpers/format-numbers.d.ts

@@ -1,3 +1,3 @@
 import { TableDataOptionsInternal } from '../../../../../../domains/visualizations/core/chart-data-options/types';
 import { DataTable } from '../../../../../../domains/visualizations/core/chart-data-processor/table-processor';
-export declare const formatNumbers: (table: DataTable, chartDataOptions: TableDataOptionsInternal) => DataTable;
+export declare const formatNumbers: (table: DataTable, chartDataOptions: TableDataOptionsInternal, defaultNumberFormattingEnabled?: boolean) => DataTable;

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-data/cartesian-data.d.ts

@@ -10,6 +10,6 @@ export declare const validateCartesianChartDataOptions: (chartDataOptions: Carte
  * @param dataTable - Data table
  * @returns Cartesian chart data
  */
-export declare const cartesianData: (dataOptions: CartesianChartDataOptionsInternal, dataTable: DataTable) => CartesianChartData;
+export declare const cartesianData: (dataOptions: CartesianChartDataOptionsInternal, dataTable: DataTable, defaultNumberFormattingEnabled?: boolean) => CartesianChartData;
 export declare const sortDirection: (sortType: SortDirection | undefined) => 1 | 0 | -1;
 export declare const getOrderedXValues: (dataTable: DataTable, sortedMeasures: StyledMeasureColumn[], xColumns: Column[], rownumColumnName?: string) => CategoricalXValues[];

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-data/categorical-data.d.ts

@@ -2,4 +2,4 @@ import { CategoricalChartDataOptionsInternal } from '../chart-data-options/types
 import { DataTable } from '../chart-data-processor/table-processor';
 import { CategoricalChartData } from './types.js';
 export declare const validateCategoricalChartDataOptions: (chartDataOptions: CategoricalChartDataOptionsInternal) => CategoricalChartDataOptionsInternal;
-export declare const categoricalData: (dataOptions: CategoricalChartDataOptionsInternal, dataTable: DataTable) => CategoricalChartData;
+export declare const categoricalData: (dataOptions: CategoricalChartDataOptionsInternal, dataTable: DataTable, defaultNumberFormattingEnabled?: boolean) => CategoricalChartData;

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-data/chart-data-service.d.ts

@@ -2,4 +2,4 @@ import type { ChartType } from '../../../../types';
 import { ChartDataOptionsInternal } from '../chart-data-options/types';
 import { DataTable } from '../chart-data-processor/table-processor';
 import { ChartData } from './types';
-export declare const chartDataService: (chartType: ChartType, chartDataOptions: ChartDataOptionsInternal, dataTable: DataTable) => ChartData;
+export declare const chartDataService: (chartType: ChartType, chartDataOptions: ChartDataOptionsInternal, dataTable: DataTable, defaultNumberFormattingEnabled?: boolean) => ChartData;

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-data/scatter-data.d.ts

@@ -12,7 +12,7 @@ export interface DataOptionsIndexes {
 }
 export declare const buildCategories: (data: ScatterDataTable, axisColumnName: AxisColumnName) => string[];
 export declare const createCategoriesMap: (xCategories?: ScatterCategories, yCategories?: ScatterCategories) => ScatterAxisCategoriesMap;
-export declare const groupData: (dataOptions: ScatterChartDataOptionsInternal, dataTable: DataTable) => ScatterDataTable;
+export declare const groupData: (dataOptions: ScatterChartDataOptionsInternal, dataTable: DataTable, defaultNumberFormattingEnabled?: boolean) => ScatterDataTable;
 /**
  * Creates data for scatter charts given chart data table and data options
  *
@@ -20,4 +20,4 @@ export declare const groupData: (dataOptions: ScatterChartDataOptionsInternal, d
  * @param dataTable - Chart data table
  * @returns Scatter chart data
  */
-export declare const scatterData: (dataOptions: ScatterChartDataOptionsInternal, dataTable: DataTable) => ScatterChartData;
+export declare const scatterData: (dataOptions: ScatterChartDataOptionsInternal, dataTable: DataTable, defaultNumberFormattingEnabled?: boolean) => ScatterChartData;

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-data/types.d.ts

@@ -1,6 +1,7 @@
 import { Coordinates } from '../../../../domains/visualizations/components/chart/components/scattermap/types';
 import { AreamapData } from '../../../../domains/visualizations/components/chart/restructured-charts/areamap-chart/types';
 import { CalendarHeatmapChartData } from '../../../../domains/visualizations/components/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/data';
+import { SankeyChartData } from '../../../../domains/visualizations/components/chart/restructured-charts/highchart-based-charts/sankey-chart/types';
 import { ComparableData, Value } from '../../../../domains/visualizations/core/chart-data-processor/table-processor';
 import { IndicatorChartType } from '../../../../domains/visualizations/core/chart-options-processor/translations/types';
 import { NumberFormatConfig } from '../../../../types';
@@ -141,5 +142,5 @@ export type BoxplotChartData = {
  *
  * @internal
  */
-export type ChartData = CartesianChartData | CategoricalChartData | ScatterChartData | IndicatorChartData | BoxplotChartData | AreamapData | ScattermapChartData | RangeChartData | CalendarHeatmapChartData;
+export type ChartData = CartesianChartData | CategoricalChartData | ScatterChartData | IndicatorChartData | BoxplotChartData | AreamapData | ScattermapChartData | RangeChartData | CalendarHeatmapChartData | SankeyChartData;
 export {};

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-data-options/apply-styled-options-to-query.d.ts

@@ -72,12 +72,12 @@ export declare function isForecastMeasure(measure: Measure): boolean;
  */
 export type AdaptMeasuresForQueryOptions = {
     /**
-     * When `true`, trend and forecast companion measures are not appended (e.g. narrative when the
-     * backend does not yet support them).
+     * When `true` (default), trend and forecast will be included if present.
+     * When `false`, trend and forecast will be omitted if they are present.
      *
-     * @default false
+     * @default true
      */
-    ignoreTrendAndForecast?: boolean;
+    includeTrendAndForecast?: boolean;
 };
 /**
  * Applies sort, trend, and forecast companion measures (NLQ JSON → query semantics).

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-data-options/types.d.ts

@@ -10,12 +10,11 @@ export interface CategoryStyle {
     /** {@inheritDoc NumberFormatConfig} */
     numberFormatConfig?: NumberFormatConfig;
     /**
-     * Date format.
+     * Date format for display using [date-fns `format` token syntax](https://date-fns.org/v2.29.3/docs/format)
+     * (for example `yyyy`, `MM`, `dd`, `HH:mm:ss`, or `yy-MM`). This is **not** the ECMAScript Date Time String Format.
      *
-     * See [ECMAScript Date Time String Format](https://tc39.es/ecma262/multipage/numbers-and-dates.html#sec-date-time-string-format)
-     *
-     * Note that 'YYYY' and 'DD' have been disabled since they often get confused with 'yyyy' and 'dd'
-     * and can produce unexpected results.
+     * Note that `YYYY` and `DD` are discouraged since they are often confused with `yyyy` and `dd` and can produce
+     * unexpected results.
      */
     dateFormat?: string;
     /** Boolean flag to toggle continuous timeline on this date column. */
@@ -571,7 +570,7 @@ export type CommonDataOptions = ChartDataOptions | PivotTableDataOptions | Gener
 /**
  * Configuration for how to query aggregate data and assigning data to chart encodings of regular charts.
  */
-export type RegularChartDataOptions = CartesianChartDataOptions | CategoricalChartDataOptions | ScatterChartDataOptions | IndicatorChartDataOptions | BoxplotChartDataOptions | BoxplotChartCustomDataOptions | AreamapChartDataOptions | ScattermapChartDataOptions | RangeChartDataOptions | CalendarHeatmapChartDataOptions;
+export type RegularChartDataOptions = CartesianChartDataOptions | CategoricalChartDataOptions | ScatterChartDataOptions | IndicatorChartDataOptions | BoxplotChartDataOptions | BoxplotChartCustomDataOptions | AreamapChartDataOptions | ScattermapChartDataOptions | RangeChartDataOptions | CalendarHeatmapChartDataOptions | SankeyChartDataOptions;
 /** @internal */
 export interface CartesianChartDataOptionsInternal {
     x: StyledColumn[];
@@ -645,7 +644,7 @@ export interface PivotTableDataOptionsInternal {
     grandTotals?: PivotGrandTotals;
 }
 /** @internal */
-export type ChartDataOptionsInternal = CartesianChartDataOptionsInternal | CategoricalChartDataOptionsInternal | ScatterChartDataOptionsInternal | IndicatorChartDataOptionsInternal | BoxplotChartDataOptionsInternal | AreamapChartDataOptionsInternal | ScattermapChartDataOptionsInternal | RangeChartDataOptionsInternal | CalendarHeatmapChartDataOptionsInternal;
+export type ChartDataOptionsInternal = CartesianChartDataOptionsInternal | CategoricalChartDataOptionsInternal | ScatterChartDataOptionsInternal | IndicatorChartDataOptionsInternal | BoxplotChartDataOptionsInternal | AreamapChartDataOptionsInternal | ScattermapChartDataOptionsInternal | RangeChartDataOptionsInternal | CalendarHeatmapChartDataOptionsInternal | SankeyChartDataOptionsInternal;
 /** @internal */
 export type IndicatorChartDataOptionsInternal = {
     value?: StyledMeasureColumn[];
@@ -675,3 +674,44 @@ export type CalendarHeatmapChartDataOptionsInternal = {
     date: StyledColumn;
     value: StyledMeasureColumn;
 };
+/**
+ * Configuration for how to query aggregate data and assign data
+ * to a {@link SankeyChartType | Sankey chart}.
+ *
+ * @group Charts
+ * @beta
+ *
+ * @example
+ * ```tsx
+ * <SankeyChart
+ *   dataSet={dataSource}
+ *   dataOptions={{
+ *     category: [DM.Commerce.Gender, DM.Commerce.AgeRange],
+ *     value: measureFactory.sum(DM.Commerce.Revenue),
+ *   }}
+ * />
+ * ```
+ */
+export interface SankeyChartDataOptions {
+    /**
+     * Columns (or attributes) representing the nodes in each stage of the flow.
+     * Must contain at least 2 items to define source and target nodes.
+     * When more than 2 items are provided the chart displays multi-stage flows.
+     */
+    category: (Column | CalculatedColumn | StyledColumn)[];
+    /**
+     * Measure column whose aggregated values determine the flow weight between nodes.
+     * Use a styled measure column to apply {@link StyledMeasureColumn.numberFormatConfig | number formatting}.
+     */
+    value: MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
+    /**
+     * Optional mapping of node names to colors.
+     */
+    seriesToColorMap?: ValueToColorMap | MultiColumnValueToColorMap;
+}
+/** @internal */
+export type SankeyChartDataOptionsInternal = {
+    category: StyledColumn[];
+    value: StyledMeasureColumn;
+    seriesToColorMap?: ValueToColorMap | MultiColumnValueToColorMap;
+};

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/chart-options-service.d.ts

@@ -148,6 +148,7 @@ export type PlotOptions = {
     scatter?: ChartPlotOptions;
     arearange?: ChartPlotOptions;
     heatmap?: ChartPlotOptions;
+    sankey?: ChartPlotOptions;
     streamgraph?: {
         lineWidth?: number;
         fillOpacity?: number;
@@ -179,6 +180,8 @@ export type HighchartsOptionsInternal = {
         spacing?: number[];
         marginTop?: number;
         alignTicks?: boolean;
+        /** When true, x and y axes are swapped (e.g. vertical Sankey). */
+        inverted?: boolean;
         polar: boolean;
         zoomType?: 'x' | 'y';
         scrollablePlotArea?: {

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/tooltip.d.ts

@@ -1,4 +1,4 @@
 import { ChartDataOptionsInternal } from '../chart-data-options/types';
 import { HighchartsDataPointContext, HighchartsDataPointContextNode, TooltipSettings } from './translations/tooltip-utils.js';
 export type { TooltipSettings, HighchartsDataPointContext, HighchartsDataPointContextNode };
-export declare const getCategoryTooltipSettings: (showDecimals: boolean | undefined, chartDataOptions: ChartDataOptionsInternal) => TooltipSettings;
+export declare const getCategoryTooltipSettings: (showDecimals: boolean | undefined, chartDataOptions: ChartDataOptionsInternal, defaultNumberFormattingEnabled?: boolean) => TooltipSettings;

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/design-options.d.ts

@@ -1,5 +1,5 @@
 import { CalendarDayOfWeek } from '../../../../../domains/visualizations/components/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils';
-import { CalendarHeatmapSubtype, CalendarHeatmapViewType, Convolution, FunnelSeriesLabels, LegendOptions, LineOptions, PieSeriesLabels, ScattermapMarkers, SeriesLabels, SunburstStyleOptions, TotalLabels, TreemapStyleOptions } from '../../../../../types';
+import { CalendarHeatmapSubtype, CalendarHeatmapViewType, Convolution, FunnelSeriesLabels, LegendOptions, LineOptions, PieSeriesLabels, SankeyStyleOptions, ScattermapMarkers, SeriesLabels, SunburstStyleOptions, TotalLabels, TreemapStyleOptions } from '../../../../../types';
 import { Axis } from './axis-section';
 import { FunnelDirection, FunnelSize, FunnelType } from './funnel-plot-options';
 import { Marker } from './marker-section';
@@ -103,6 +103,15 @@ export type FunnelChartDesignOptions = Omit<BaseDesignOptionsType, 'seriesLabels
 };
 export type TreemapChartDesignOptions = BaseDesignOptionsType & TreemapStyleOptions;
 export type SunburstChartDesignOptions = BaseDesignOptionsType & SunburstStyleOptions;
+export type SankeyChartDesignOptions = BaseDesignOptionsType & {
+    /** Resolved flow direction from {@link SankeyStyleOptions.orientation} (defaults to horizontal). */
+    orientation?: 'horizontal' | 'vertical';
+    curveFactor?: SankeyStyleOptions['curveFactor'];
+    linkOpacity?: SankeyStyleOptions['linkOpacity'];
+    nodeWidth?: SankeyStyleOptions['nodeWidth'];
+    nodePadding?: SankeyStyleOptions['nodePadding'];
+    nodeAlignment?: SankeyStyleOptions['nodeAlignment'];
+};
 export type ScatterChartDesignOptions = BaseDesignOptionsType & {
     markerSize?: ScatterMarkerSize;
 };

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/funnel-plot-options.d.ts

@@ -46,4 +46,4 @@ export declare const DEFAULT_SHIFT = 50;
 export declare const funnelWidthPercentage: (renderTo: RenderTo | null) => number;
 export declare const funnelNeckWidth: (widthPercentage: number, funnelSize: FunnelSize) => number;
 export declare const funnelNeckHeight: (type: FunnelType) => number;
-export declare const getFunnelPlotOptions: (funnelDesignOptions: FunnelChartDesignOptions, chartDataOptions: ChartDataOptionsInternal) => PlotOptions;
+export declare const getFunnelPlotOptions: (funnelDesignOptions: FunnelChartDesignOptions, chartDataOptions: ChartDataOptionsInternal, defaultNumberFormattingEnabled?: boolean) => PlotOptions;

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/number-format-config.d.ts

@@ -8,3 +8,15 @@ export declare const getCompleteNumberFormatConfig: (partialConfig?: NumberForma
 export declare const applyFormatStaticMarkup: (config: CompleteNumberFormatConfig, value: number) => string;
 export declare const applyFormat: (config: CompleteNumberFormatConfig, value: number) => string;
 export declare const applyFormatPlainText: (config: CompleteNumberFormatConfig, value: number) => string;
+/**
+ * Formats a number value, respecting the `defaultNumberFormatting.enabled` setting.
+ * Returns the formatted value when default formatting is enabled OR an explicit config is provided.
+ * Falls back to `String(value)` when default formatting is disabled and no explicit config exists.
+ *
+ * @param value - The numeric value to format.
+ * @param partialConfig - Optional explicit number format config set on the data option.
+ * @param isDefaultNumberFormattingEnabled - Whether default number formatting is active.
+ * @param formatter - Formatting function to use; defaults to `applyFormat`.
+ * @returns Formatted string when default formatting is enabled or an explicit config is provided; `String(value)` otherwise.
+ */
+export declare function formatNumberWithFallback(value: number, partialConfig: NumberFormatConfig | undefined, isDefaultNumberFormattingEnabled: boolean, formatter?: (config: CompleteNumberFormatConfig, value: number) => string): string;

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/pie-plot-options.d.ts

@@ -35,6 +35,7 @@ export type GetPiePlotOptionsParams = {
     chartDataOptions: ChartDataOptionsInternal;
     themeSettings?: CompleteThemeSettingsInternal;
     semiCircle?: boolean;
+    defaultNumberFormattingEnabled?: boolean;
 };
-export declare const getPiePlotOptions: ({ pieType, seriesLabels, chartDataOptions, themeSettings, semiCircle, }: GetPiePlotOptionsParams) => PlotOptions;
+export declare const getPiePlotOptions: ({ pieType, seriesLabels, chartDataOptions, themeSettings, semiCircle, defaultNumberFormattingEnabled, }: GetPiePlotOptionsParams) => PlotOptions;
 export {};

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/sunburst/sunburst-levels.d.ts

@@ -3,7 +3,7 @@ import { CompleteThemeSettingsInternal } from '../../../../../../types';
 import { CategoricalChartDataOptionsInternal } from '../../../chart-data-options/types';
 import { CategoricalChartData } from '../../../chart-data/types';
 import { SunburstChartDesignOptions } from '../design-options';
-export declare function prepareSunburstLevels(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, themeSettings?: CompleteThemeSettingsInternal): ({
+export declare function prepareSunburstLevels(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, themeSettings?: CompleteThemeSettingsInternal, defaultNumberFormattingEnabled?: boolean): ({
     level: number;
     color: string;
     dataLabels: {

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/sunburst/sunburst-options.d.ts

@@ -7,7 +7,7 @@ import { SunburstChartDesignOptions } from '../design-options';
 /**
  * Prepares the series configuration for sunburst chart
  */
-export declare function prepareSunburstSeries(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, themeSettings?: CompleteThemeSettingsInternal): ({
+export declare function prepareSunburstSeries(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, themeSettings?: CompleteThemeSettingsInternal, defaultNumberFormattingEnabled?: boolean): ({
     name: string;
     showInLegend: boolean;
     color: string;

package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/treemap/treemap-tooltip.d.ts

@@ -7,6 +7,6 @@ type TooltipFormatterOptions = {
     displayColorCircles: boolean;
     shouldSkip: (context: HighchartsDataPointContext) => boolean;
 };
-export declare const getTreemapTooltipSettings: (chartDataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions, translate: TFunction, formatterOptions?: TooltipFormatterOptions) => TooltipSettings;
-export declare function treemapTooltipFormatter(context: HighchartsDataPointContext, chartDataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions, translate: TFunction, formatterOptions?: TooltipFormatterOptions): string | false;
+export declare const getTreemapTooltipSettings: (chartDataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions, translate: TFunction, formatterOptions?: TooltipFormatterOptions, defaultNumberFormattingEnabled?: boolean) => TooltipSettings;
+export declare function treemapTooltipFormatter(context: HighchartsDataPointContext, chartDataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions, translate: TFunction, formatterOptions?: TooltipFormatterOptions, defaultNumberFormattingEnabled?: boolean): string | false;
 export {};