@sisense/sdk-ui 2.28.0 → 2.30.0

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

@@ -1,5 +1,5 @@
-import { CalculatedMeasureColumn, Column, ForecastFormulaOptions, MeasureColumn, PivotGrandTotals, TotalsCalculation, TrendFormulaOptions } from '@sisense/sdk-data';
-import type { LineWidth, Markers, MultiColumnValueToColorMap, NumberFormatConfig, PivotRowsSort, SeriesChartType, SortDirection, ValueToColorMap } from '../../../../types';
+import { CalculatedColumn, CalculatedMeasureColumn, Column, ForecastFormulaOptions, MeasureColumn, PivotGrandTotals, TotalsCalculation, TrendFormulaOptions } from '@sisense/sdk-data';
+import type { GenericDataOptions, LineWidth, Markers, MultiColumnValueToColorMap, NumberFormatConfig, PivotRowsSort, SeriesChartType, SortDirection, ValueToColorMap } from '../../../../types';
 import { ConditionalDataColorOptions, DataColorOptions, UniformDataColorOptions } from '../chart-data/data-coloring';
 /**
  * Styles for a category/column when visualized in a chart
@@ -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. */
@@ -99,8 +98,8 @@ export interface CategoryStyle {
  * Also, see {@link StyledMeasureColumn}.
  */
 export interface StyledColumn extends CategoryStyle {
-    /** Wrapped Column */
-    column: Column;
+    /** Wrapped Column or CalculatedColumn (calculated dimension) */
+    column: Column | CalculatedColumn;
 }
 /**
  * Styles for a value/measure when it is visualized in a chart.
@@ -237,7 +236,7 @@ export interface StyledMeasureColumn extends ValueStyle, SeriesStyle {
 /**
  * @internal
  */
-export type AnyColumn = Column | StyledColumn | MeasureColumn | StyledMeasureColumn | CalculatedMeasureColumn;
+export type AnyColumn = Column | CalculatedColumn | StyledColumn | MeasureColumn | StyledMeasureColumn | CalculatedMeasureColumn;
 /**
  * Configuration for how to query aggregate data and assign data
  * to axes of a {@link CartesianChartType | Cartesian chart}.
@@ -251,7 +250,7 @@ export interface CartesianChartDataOptions {
      *
      * Typically, the X-axis represents descriptive data.
      */
-    category: (Column | StyledColumn)[];
+    category: (Column | CalculatedColumn | StyledColumn)[];
     /**
      * Measure columns (or measures) whose values are scaled to the Y-axis of the chart.
      *
@@ -265,7 +264,7 @@ export interface CartesianChartDataOptions {
      * Each group is represented by a different visual encoding - for example, color of bars in a bar chart,
      * and is automatically added to the chart's legend.
      */
-    breakBy: (Column | StyledColumn)[];
+    breakBy: (Column | CalculatedColumn | StyledColumn)[];
     /**
      * Optional mapping of each of the series to colors.
      */
@@ -288,7 +287,7 @@ export interface CategoricalChartDataOptions {
      *
      * For funnel charts, only the first 50 categories will be used.
      */
-    category: (Column | StyledColumn)[];
+    category: (Column | CalculatedColumn | StyledColumn)[];
     /**
      * Optional mapping of each of the series to colors.
      * ({@link MultiColumnValueToColorMap} used only for the Sunburst Chart component)
@@ -323,14 +322,14 @@ export interface ScatterChartDataOptions {
      * Typically, the X-axis of a Scatter Chart is used to represent numeric data.
      * Alternatively, Descriptive data is also supported. At most one column is allowed.
      */
-    x?: Column | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
+    x?: Column | CalculatedColumn | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
     /**
      * A column or measure column whose values are placed on the Y-axis.
      *
      * Typically, the Y-axis of a Scatter Chart is used to represent numeric data.
      * Alternatively, Descriptive data is also supported. At most one column is allowed.
      */
-    y?: Column | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
+    y?: Column | CalculatedColumn | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
     /**
      * A column to be scattered across the chart as circles;
      * one point (circle) appears on the chart for each member of this column.
@@ -338,7 +337,7 @@ export interface ScatterChartDataOptions {
      *
      * You can only add a break-by point if either the X-axis or the Y-axis was defined to represent numeric data.
      */
-    breakByPoint?: Column | StyledColumn;
+    breakByPoint?: Column | CalculatedColumn | StyledColumn;
     /**
      * Select a column by which to break (group) the columns in the chart.
      * This must be a descriptive column. If you select descriptive data,
@@ -353,7 +352,7 @@ export interface ScatterChartDataOptions {
      * the darkest color and the lowest value is the lightest color.
      *
      */
-    breakByColor?: Column | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
+    breakByColor?: Column | CalculatedColumn | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
     /**
      * Column that determines the size of the circle. It must be numeric data.
      *
@@ -370,7 +369,7 @@ export interface ScatterChartDataOptions {
  */
 export interface AreamapChartDataOptions {
     /** Column or attribute representing the countries (or states) on the map. */
-    geo: [Column | StyledColumn];
+    geo: [Column | CalculatedColumn | StyledColumn];
     /** Measure column (or measure) encoded by the color of the countries (or states) on the map. */
     color?: [MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn];
 }
@@ -380,7 +379,7 @@ export interface AreamapChartDataOptions {
  */
 export interface CalendarHeatmapChartDataOptions {
     /** Date column representing dates on the calendar heatmap. */
-    date: Column | StyledColumn;
+    date: Column | CalculatedColumn | StyledColumn;
     /** Measure column (or measure) assigned to the calendar cells. */
     value: MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
 }
@@ -391,7 +390,7 @@ export interface TableDataOptions {
     /**
      * Columns (or attributes) whose values represent data columns in table
      */
-    columns: (Column | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn)[];
+    columns: (Column | CalculatedColumn | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn)[];
 }
 /**
  * Configuration for how to query data and assign data to tabular charts.
@@ -407,13 +406,13 @@ export interface PivotTableDataOptions {
      *
      * @category Data Options
      */
-    rows?: (Column | StyledColumn)[];
+    rows?: (Column | CalculatedColumn | StyledColumn)[];
     /**
      * Dimensions for the columns of the pivot table
      *
      * @category Data Options
      */
-    columns?: (Column | StyledColumn)[];
+    columns?: (Column | CalculatedColumn | StyledColumn)[];
     /**
      * Measures for the values of the pivot table
      *
@@ -446,7 +445,7 @@ export interface ScattermapChartDataOptions {
      * Support field(s) that contain geographic data (Country, City, State/Province, etc)
      * To visualize latitude and longitude data, you have to add one field containing latitude data, and another field containing longitude data, in this order.
      */
-    geo: (Column | StyledColumn)[];
+    geo: (Column | CalculatedColumn | StyledColumn)[];
     /**
      * Measure column (or measure) representing the size of the points on the map.
      */
@@ -458,7 +457,7 @@ export interface ScattermapChartDataOptions {
     /**
      * Column or measure column representing the additional details for the points on the map.
      */
-    details?: Column | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
+    details?: Column | CalculatedColumn | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
 }
 /**
  * Represents the type of box whisker data algorithm, which can be either `iqr`, `extremums`, or `standardDeviation`.
@@ -475,7 +474,7 @@ export type BoxplotChartDataOptions = {
     /**
      * Columns (or attributes) whose values represent categories in the chart.
      */
-    category: [(Column | StyledColumn)?];
+    category: [(Column | CalculatedColumn | StyledColumn)?];
     /**
      * Columns (or attributes) whose values represent the target numeric value column for computing boxplot metrics according to the selected `boxType`
      */
@@ -500,7 +499,7 @@ export type BoxplotChartCustomDataOptions = {
     /**
      * Columns (or attributes) whose values represent categories in the chart.
      */
-    category: [(Column | StyledColumn)?];
+    category: [(Column | CalculatedColumn | StyledColumn)?];
     /**
      * Measure columns (or measures) representing the target numeric values used for computing boxplot metrics.
      */
@@ -530,7 +529,7 @@ export interface RangeChartDataOptions {
      *
      * Typically, the X-axis represents descriptive data.
      */
-    category: (Column | StyledColumn)[];
+    category: (Column | CalculatedColumn | StyledColumn)[];
     /**
      * An array of measure columns used to represent the target numeric values for computing the metrics
      * in an area range chart.
@@ -545,7 +544,7 @@ export interface RangeChartDataOptions {
      * Each group is represented by a different visual encoding - for example, color of bars in a bar chart,
      * and is automatically added to the chart's legend.
      */
-    breakBy: (Column | StyledColumn)[];
+    breakBy: (Column | CalculatedColumn | StyledColumn)[];
     /**
      * Optional mapping of each of the series to colors.
      */
@@ -564,10 +563,14 @@ export interface RangeChartDataOptions {
  * {@link ScattermapChartDataOptions | Scattermap} charts.
  */
 export type ChartDataOptions = RegularChartDataOptions | TabularChartDataOptions;
+/**
+ * Union of data options for all supported CSDK visualization (chart) types
+ */
+export type CommonDataOptions = ChartDataOptions | PivotTableDataOptions | GenericDataOptions;
 /**
  * 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[];
@@ -641,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[];
@@ -671,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-data-options/utils.d.ts

@@ -1,4 +1,4 @@
-import { Attribute, CalculatedMeasureColumn, Column, Measure, MeasureColumn } from '@sisense/sdk-data';
+import { Attribute, CalculatedColumn, CalculatedMeasureColumn, Column, Measure, MeasureColumn } from '@sisense/sdk-data';
 import { AnyColumn, CategoryStyle, StyledColumn, StyledMeasureColumn, ValueStyle } from './types.js';
 type AnyObject = Record<string, any>;
 /**
@@ -21,7 +21,7 @@ export declare const safeMerge: <T extends AnyObject, S extends AnyObject>(sourc
  */
 export declare const safeCombine: <T extends AnyObject>(sourceWithInheritance: T, sourceToAbsorb: AnyObject) => T;
 export declare const splitColumn: <C extends AnyColumn>(targetColumn: C) => {
-    column: Column | MeasureColumn | CalculatedMeasureColumn;
+    column: Column | MeasureColumn | CalculatedMeasureColumn | CalculatedColumn;
     style: CategoryStyle | ValueStyle;
 } | {
     column: C;
@@ -44,7 +44,7 @@ export declare function isMeasureColumn(arg: AnyColumn): arg is MeasureColumn |
 export declare const getDataOptionTitle: (styledColumn: StyledColumn | StyledMeasureColumn) => string;
 export declare const getDataOptionGranularity: ({ column, granularity }: StyledColumn) => string;
 /** @internal */
-export declare const translateColumnToAttribute: (c: Column | StyledColumn) => Attribute;
+export declare const translateColumnToAttribute: (c: Column | CalculatedColumn | StyledColumn) => Attribute;
 export declare const translateColumnToMeasure: (c: MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn) => Measure;
 /**
  * Checks if column is a StyledColumns.
@@ -60,7 +60,7 @@ export declare function isStyledColumn(targetColumn: AnyColumn): targetColumn is
  * @internal
  */
 export declare function isCategoryStyle(category: Column | CategoryStyle): category is CategoryStyle;
-export declare function normalizeColumn(targetColumn: Column | StyledColumn, defaultStyle?: CategoryStyle): StyledColumn;
+export declare function normalizeColumn(targetColumn: Column | CalculatedColumn | StyledColumn, defaultStyle?: CategoryStyle): StyledColumn;
 export declare function normalizeMeasureColumn(targetColumn: MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn, defaultStyle?: ValueStyle): StyledMeasureColumn;
 export declare function normalizeAnyColumn(targetColumn: AnyColumn, defaultStyle?: CategoryStyle | ValueStyle): StyledColumn | StyledMeasureColumn;
 export {};

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 {};

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

@@ -1,7 +1,7 @@
 import { AreamapChartDesignOptions } from '../../../../../domains/visualizations/components/chart/restructured-charts/areamap-chart/types';
 import { StreamgraphChartDesignOptions } from '../../../../../domains/visualizations/components/chart/restructured-charts/highchart-based-charts/cartesians/stackable/streamgraph-chart/types';
 import { ChartType } from '../../../../../types';
-import { AreaChartDesignOptions, AreaRangeChartDesignOptions, BarChartDesignOptions, BaseDesignOptionsType, BoxplotChartDesignOptions, CalendarHeatmapChartDesignOptions, ColumnChartDesignOptions, FunnelChartDesignOptions, IndicatorChartDesignOptions, LineChartDesignOptions, PieChartDesignOptions, PolarChartDesignOptions, ScatterChartDesignOptions, ScattermapChartDesignOptions, SunburstChartDesignOptions, TreemapChartDesignOptions } from './design-options';
+import { AreaChartDesignOptions, AreaRangeChartDesignOptions, BarChartDesignOptions, BaseDesignOptionsType, BoxplotChartDesignOptions, CalendarHeatmapChartDesignOptions, ColumnChartDesignOptions, FunnelChartDesignOptions, IndicatorChartDesignOptions, LineChartDesignOptions, PieChartDesignOptions, PolarChartDesignOptions, SankeyChartDesignOptions, ScatterChartDesignOptions, ScattermapChartDesignOptions, SunburstChartDesignOptions, TreemapChartDesignOptions } from './design-options';
 /**
  * Style configuration for text elements in charts and UI components.
  * Defines the visual appearance and behavior of text rendering.
@@ -91,11 +91,19 @@ export type CalendarHeatmapChartType = (typeof CALENDAR_HEATMAP_CHART_TYPES)[num
 export declare const RANGE_CHART_TYPES: readonly ["arearange"];
 /** AreaRange chart types  @expandType */
 export type RangeChartType = (typeof RANGE_CHART_TYPES)[number];
+export declare const SANKEY_CHART_TYPES: readonly ["sankey"];
+/**
+ * Sankey chart types
+ *
+ * @expandType
+ * @beta
+ */
+export type SankeyChartType = (typeof SANKEY_CHART_TYPES)[number];
 export type ChartDataType = 'cartesian' | 'categorical' | 'scatter' | 'table' | 'indicator' | 'areamap' | 'arearange';
 /**
  * Design options for a specific chart type
  */
-export type DesignOptions<SpecificChartType extends ChartType = ChartType> = SpecificChartType extends 'line' ? LineChartDesignOptions : SpecificChartType extends 'area' ? AreaChartDesignOptions : SpecificChartType extends 'bar' ? BarChartDesignOptions : SpecificChartType extends 'column' ? ColumnChartDesignOptions : SpecificChartType extends 'streamgraph' ? StreamgraphChartDesignOptions : SpecificChartType extends 'pie' ? PieChartDesignOptions : SpecificChartType extends 'funnel' ? FunnelChartDesignOptions : SpecificChartType extends 'polar' ? PolarChartDesignOptions : SpecificChartType extends 'indicator' ? IndicatorChartDesignOptions : SpecificChartType extends 'scatter' ? ScatterChartDesignOptions : SpecificChartType extends 'treemap' ? TreemapChartDesignOptions : SpecificChartType extends 'sunburst' ? SunburstChartDesignOptions : SpecificChartType extends 'boxplot' ? BoxplotChartDesignOptions : SpecificChartType extends 'areamap' ? AreamapChartDesignOptions : SpecificChartType extends 'scattermap' ? ScattermapChartDesignOptions : SpecificChartType extends 'calendar-heatmap' ? CalendarHeatmapChartDesignOptions : SpecificChartType extends 'arearange' ? AreaRangeChartDesignOptions : never;
+export type DesignOptions<SpecificChartType extends ChartType = ChartType> = SpecificChartType extends 'line' ? LineChartDesignOptions : SpecificChartType extends 'area' ? AreaChartDesignOptions : SpecificChartType extends 'bar' ? BarChartDesignOptions : SpecificChartType extends 'column' ? ColumnChartDesignOptions : SpecificChartType extends 'streamgraph' ? StreamgraphChartDesignOptions : SpecificChartType extends 'pie' ? PieChartDesignOptions : SpecificChartType extends 'funnel' ? FunnelChartDesignOptions : SpecificChartType extends 'polar' ? PolarChartDesignOptions : SpecificChartType extends 'indicator' ? IndicatorChartDesignOptions : SpecificChartType extends 'scatter' ? ScatterChartDesignOptions : SpecificChartType extends 'treemap' ? TreemapChartDesignOptions : SpecificChartType extends 'sunburst' ? SunburstChartDesignOptions : SpecificChartType extends 'boxplot' ? BoxplotChartDesignOptions : SpecificChartType extends 'areamap' ? AreamapChartDesignOptions : SpecificChartType extends 'scattermap' ? ScattermapChartDesignOptions : SpecificChartType extends 'calendar-heatmap' ? CalendarHeatmapChartDesignOptions : SpecificChartType extends 'arearange' ? AreaRangeChartDesignOptions : SpecificChartType extends 'sankey' ? SankeyChartDesignOptions : never;
 /** A unique identifier for a series to be found in {@link ChartDataOptionsInternal} */
 type SeriesId = string;
 /**
@@ -123,6 +131,7 @@ export declare const isBoxplot: (chartType: ChartType) => chartType is "boxplot"
 export declare const isAreamap: (chartType: ChartType) => chartType is "areamap";
 export declare const isRange: (chartType: ChartType) => chartType is "arearange";
 export declare const isCalendarHeatmap: (chartType: ChartType) => chartType is "calendar-heatmap";
-export declare const ALL_CHART_TYPES: readonly ["line", "area", "bar", "column", "streamgraph", "polar", "pie", "funnel", "treemap", "sunburst", "scatter", "table", "indicator", "boxplot", "areamap", "image", "scattermap", "calendar-heatmap", "arearange"];
+export declare const isSankey: (chartType: ChartType) => chartType is "sankey";
+export declare const ALL_CHART_TYPES: readonly ["line", "area", "bar", "column", "streamgraph", "polar", "pie", "funnel", "treemap", "sunburst", "scatter", "table", "indicator", "boxplot", "areamap", "image", "scattermap", "calendar-heatmap", "arearange", "sankey"];
 export type DynamicChartType = (typeof ALL_CHART_TYPES)[number];
 export {};

package/dist/packages/sdk-ui/src/domains/visualizations/core/query-definition/filter-to-readable-label.d.ts

@@ -0,0 +1,14 @@
+import type { Filter } from '@sisense/sdk-data';
+/**
+ * Builds a human-readable one-line label for a {@link Filter}, covering common
+ * `filterType` variants (`members`, `exclude`, `text`, `numeric`, `dateRange`, etc.).
+ *
+ * Discrimination uses the `filterType` string rather than `instanceof` so the helper
+ * stays robust when multiple `@sisense/sdk-data` copies exist in a workspace.
+ *
+ * @param filter - Filter instance to describe
+ * @param attributeName - Optional display name override (e.g. i18n date-level label)
+ * @returns Readable pill label; falls back to the attribute name when composition fails
+ * @sisenseInternal
+ */
+export declare function toReadableFilterLabel(filter: Filter, attributeName?: string): string;

package/dist/packages/sdk-ui/src/domains/visualizations/core/query-definition/index.d.ts

@@ -3,6 +3,7 @@ export type { QueryDefinitionProps } from './query-definition';
 export { QueryPill } from './query-pill';
 export type { QueryPillProps } from './query-pill';
 export { baseQueryParamsToViewModel } from './query-params-to-view-model';
+export { toReadableFilterLabel } from './filter-to-readable-label';
 export { getQueryPillTooltipModel } from './compose-code-to-readable';
 export type { TooltipModel } from './compose-code-to-readable';
 export type { QueryPillCategory, QueryPillItem, ConnectorItem, QueryDefinitionViewModel, } from './types';

package/dist/packages/sdk-ui/src/domains/visualizations/core/query-definition/query-definition.d.ts

@@ -16,6 +16,11 @@ export interface QueryDefinitionProps {
      * root is only one row tall and must not be used as boundary (breaks vertical placement).
      */
     tooltipBoundaryElement?: HTMLElement | null;
+    /**
+     * Maximum number of characters shown in each pill label before truncation (default `25`).
+     * Pass `0` to show the full label.
+     */
+    maxPillLength?: number;
 }
 /**
  * Read-only query definition as colored pills above the widget.

package/dist/packages/sdk-ui/src/domains/visualizations/core/query-definition/query-pill.d.ts

@@ -9,6 +9,11 @@ export interface QueryPillProps {
     item: QueryPillItem;
     showTooltip?: boolean;
     tooltipBoundaryElement?: HTMLElement | null;
+    /**
+     * Maximum number of characters shown in the pill label before truncation.
+     * When `0` or omitted, the full label is shown.
+     */
+    maxLength?: number;
 }
 /**
  * Read-only query-definition pill; JSON tooltip is a portal bubble with a real triangle.

package/dist/packages/sdk-ui/src/domains/visualizations/core/query-definition/truncate-pill-label.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Truncates a pill label when it exceeds `maxLength`. When `maxLength` is zero or negative,
+ * the label is returned unchanged.
+ *
+ * @param label - Full pill label
+ * @param maxLength - Maximum number of characters before truncation; `0` disables truncation
+ * @returns Truncated label with an ellipsis suffix when shortened
+ * @internal
+ */
+export declare function truncatePillLabel(label: string, maxLength: number): string;

package/dist/packages/sdk-ui/src/domains/widgets/change-events.d.ts

@@ -69,5 +69,11 @@ export type PivotTableWidgetChangeEvent = PivotTableWidgetDrilldownSelectionsCha
  *   }
  * }}
  * ```
+ *
+ * Persistable state changes (e.g. scroll position, future title/customOptions)
+ * flow through {@link WidgetPropsUpdate} and `DashboardPersistenceManager.updateWidget`,
+ * NOT through this channel. Use `WidgetChangeEvent` for transient/interactive
+ * events; use `WidgetPropsUpdate` for "if this is lost on reload, the user
+ * notices."
  */
 export type WidgetChangeEvent = ChartWidgetChangeEvent | PivotTableWidgetChangeEvent;

package/dist/packages/sdk-ui/src/domains/widgets/components/chart-widget/types.d.ts

@@ -2,7 +2,7 @@ import { ReactNode } from 'react';
 import { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
 import type { ChartWidgetChangeEvent, ChartWidgetDrilldownSelectionsChangedEvent } from '../../../../domains/widgets/change-events';
 import type { ChartEventProps } from '../../../../props';
-import { ChartDataOptions, ChartType, ChartWidgetStyleOptions, DrilldownOptions } from '../../../../types';
+import { ChartDataOptions, ChartType, ChartWidgetStyleOptions, DrilldownOptions, WidgetAiOptions } from '../../../../types';
 import { WidgetConfig } from '../widget/types';
 export type { ChartWidgetChangeEvent, ChartWidgetDrilldownSelectionsChangedEvent };
 /**
@@ -48,6 +48,13 @@ export interface ChartWidgetProps extends ChartEventProps {
      * @category Widget
      */
     styleOptions?: ChartWidgetStyleOptions;
+    /**
+     * Configuration for AI-powered widget features such as automated narrative generation
+     *
+     * @category Widget
+     * @alpha
+     */
+    aiOptions?: WidgetAiOptions;
     /**
      * List of categories to allow drilldowns on
      *

package/dist/packages/sdk-ui/src/domains/widgets/components/chart-widget/use-chart-widget-excel-download.d.ts

@@ -1,6 +1,6 @@
 import type { WidgetHeaderConfig } from '../../../../domains/widgets/shared/widget-header/types.js';
 import type { ChartWidgetProps } from './types.js';
-export type UseChartWidgetExcelDownloadParams = Pick<ChartWidgetProps, 'title' | 'dataOptions' | 'chartType' | 'config' | 'dataSource' | 'id'> & {
+export type UseChartWidgetExcelDownloadParams = Pick<ChartWidgetProps, 'title' | 'dataOptions' | 'chartType' | 'config' | 'dataSource' | 'filters' | 'id'> & {
     baseHeaderConfig: WidgetHeaderConfig;
 };
 export type UseChartWidgetExcelDownloadResult = {

package/dist/packages/sdk-ui/src/domains/widgets/components/chart-widget/use-chart-widget-narrative.d.ts

@@ -0,0 +1,28 @@
+import { type ReactNode } from 'react';
+import type { RefObject } from 'react';
+import type { ChartWidgetStyleOptions } from '../../../../types';
+import type { ChartWidgetProps } from './types';
+type UseChartWidgetNarrativeParams = {
+    propsWithDrilldown: ChartWidgetProps;
+    styleOptions: ChartWidgetStyleOptions | undefined;
+};
+type UseChartWidgetNarrativeReturn = {
+    /** Ref to pass to WidgetContainer — measures the content area for height constraints. */
+    contentAreaRef: RefObject<HTMLDivElement | null>;
+    /** styleOptions extended with the narrative trigger button injected into the header toolbar when applicable. */
+    styleOptionsWithNarrative: ChartWidgetStyleOptions | undefined;
+    /** Narrative element for the top slot; non-null only when displayLocation is `above` and narrative is visible. */
+    narrativeTopSlot: ReactNode;
+    /** Narrative element for the bottom slot; non-null only when displayLocation is `below` and narrative is visible. */
+    narrativeBottomSlot: ReactNode;
+    /** Narrative element used as widget content; non-null only when displayLocation is `alone` and narrative is visible. */
+    narrativeAloneContent: ReactNode;
+};
+/**
+ * Encapsulates all narrative-related logic for ChartWidget:
+ * options resolution, visibility state, trigger-button toolbar injection, and height constraints.
+ *
+ * @internal
+ */
+export declare function useChartWidgetNarrative({ propsWithDrilldown, styleOptions, }: UseChartWidgetNarrativeParams): UseChartWidgetNarrativeReturn;
+export {};