@sisense/sdk-ui 2.29.0 → 2.31.0

package/dist/packages/sdk-ui/src/shared/utils/color/color-interpolation.d.ts

@@ -1,4 +1,4 @@
-import Color from 'colorjs.io';
+import { Color } from './colorjs';
 export declare const TRIANGLE_COLOR_ADJUSTMENT = 0.15;
 export type ColorArg = string | Color;
 export declare const toColor: (color: ColorArg) => Color;

package/dist/packages/sdk-ui/src/shared/utils/color/colorjs.d.ts

@@ -0,0 +1,36 @@
+/** colorjs.io color-space coordinate accessor: indexable by channel name and by index. */
+type SpaceAccessor = Record<string, number> & number[];
+/** Minimal shape of the plain color object returned by colorjs.io `range`/`mix`/`steps`. */
+interface PlainColor {
+    space: unknown;
+    coords: number[];
+    alpha: number;
+}
+interface ColorInstance {
+    alpha: number;
+    hsl: SpaceAccessor;
+    hsv: SpaceAccessor;
+    srgb: SpaceAccessor;
+    set(property: string, value: number): ColorInstance;
+    to(space: string): ColorInstance;
+    toString(options?: {
+        format?: string;
+    }): string;
+}
+type ColorInput = string | ColorInstance | PlainColor;
+interface ColorRangeOptions {
+    space?: string;
+    outputSpace?: string;
+}
+interface ColorConstructor {
+    new (color: ColorInput): ColorInstance;
+    range(color1: ColorInput, color2: ColorInput, options?: ColorRangeOptions): (percentage: number) => PlainColor;
+    mix(color1: ColorInput, color2: ColorInput, ratio?: number, options?: ColorRangeOptions): PlainColor;
+    steps(color1: ColorInput, color2: ColorInput, options?: ColorRangeOptions & {
+        steps?: number;
+    }): PlainColor[];
+}
+declare const Color_base: ColorConstructor;
+export declare class Color extends Color_base {
+}
+export {};

package/dist/packages/sdk-ui/src/shared/utils/gradient.d.ts

@@ -392,13 +392,14 @@ export declare const toGradientHighchartsFormat: (gradient: GradientColor) => Hi
 export declare const fromHighchartsGradientFormat: (highchartGradient: HighchartsGradientColorObject) => GradientColor;
 /**
  * Converts a color to the inner Highcharts format if it is a gradient, otherwise returns the color as is.
+ * Maps `null` to `undefined` so callers can omit a color without inline checks.
  *
  * @param color - The color to convert
- * @returns The inner format gradient color object or the color as is
+ * @returns The inner format gradient color object, the color as is, or `undefined` when absent/cleared
  *
  * @internal
  */
-export declare const withGradientConversion: <T>(color: T) => HighchartsGradientColorObject | Exclude<T, GradientColor>;
+export declare function withGradientConversion(color: string | GradientColor | HighchartsGradientColorObject | null | undefined): string | HighchartsGradientColorObject | undefined;
 /**
  * Converts a GradientColor to a valid CSS gradient string.
  *

package/dist/packages/sdk-ui/src/types.d.ts

@@ -12,7 +12,7 @@ import { IndicatorComponents, TableColorOptions } from './domains/visualizations
 import { FunnelDirection, FunnelSize, FunnelType } from './domains/visualizations/core/chart-options-processor/translations/funnel-plot-options';
 import { LegendPosition } from './domains/visualizations/core/chart-options-processor/translations/legend-section';
 import { ScatterMarkerSize } from './domains/visualizations/core/chart-options-processor/translations/scatter-plot-options';
-import { AreamapChartType, BoxplotChartType, CalendarHeatmapChartType, CartesianChartType, CategoricalChartType, IndicatorChartType, RangeChartType, ScatterChartType, ScattermapChartType, TableChartType, TextStyle } from './domains/visualizations/core/chart-options-processor/translations/types';
+import { AreamapChartType, BoxplotChartType, CalendarHeatmapChartType, CartesianChartType, CategoricalChartType, IndicatorChartType, RangeChartType, SankeyChartType, ScatterChartType, ScattermapChartType, TableChartType, TextStyle } from './domains/visualizations/core/chart-options-processor/translations/types';
 import { DataPointsEventHandler } from './props';
 import { GradientColor } from './shared/utils/gradient';
 import { SoftUnion } from './shared/utils/utility-types';
@@ -20,9 +20,9 @@ export type { SortDirection, PivotRowsSort } from '@sisense/sdk-data';
 export type { AppConfig } from './infra/app/types';
 export type { DateConfig } from './domains/query-execution/core/date-formats';
 export type { CalendarDayOfWeek } from './domains/visualizations/components/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils';
-export type { CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, CalendarHeatmapChartDataOptions, StyledColumn, StyledMeasureColumn, } from './domains/visualizations/core/chart-data-options/types';
+export type { CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, CalendarHeatmapChartDataOptions, SankeyChartDataOptions, StyledColumn, StyledMeasureColumn, } from './domains/visualizations/core/chart-data-options/types';
 export type { DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, } from './domains/visualizations/core/chart-data/data-coloring/types';
-export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, CalendarHeatmapChartType, TableType, TableChartType, RangeChartType, TextStyle, } from './domains/visualizations/core/chart-options-processor/translations/types';
+export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, CalendarHeatmapChartType, TableType, TableChartType, RangeChartType, SankeyChartType, TextStyle, } from './domains/visualizations/core/chart-options-processor/translations/types';
 export type { IndicatorComponents } from './domains/visualizations/core/chart-options-processor/translations/design-options';
 export type { ScatterMarkerSize } from './domains/visualizations/core/chart-options-processor/translations/scatter-plot-options';
 export type { LegendPosition } from './domains/visualizations/core/chart-options-processor/translations/legend-section';
@@ -905,6 +905,36 @@ export interface TableStyleOptions {
          * 'content' - columns width will be based on content (default option)
          */
         width?: 'auto' | 'content';
+        /**
+         * Enables interactive resizing of column widths by dragging the column border.
+         * Default value is `true`. Set to `false` to disable.
+         */
+        resizable?: boolean;
+        /**
+         * Minimum column width in pixels when resizing.
+         * Default value is 120.
+         */
+        minWidth?: number;
+        /**
+         * Maximum column width in pixels when resizing.
+         * Default value is 350.
+         */
+        maxWidth?: number;
+        /**
+         * Current column pixel widths, in display order. Set by the dashboarding
+         * layer to make column widths controlled/persisted; not intended for
+         * direct use.
+         *
+         * @internal
+         */
+        widths?: number[];
+        /**
+         * Fired with the full set of column widths (pixels, in display order)
+         * whenever a column resize completes.
+         *
+         * @internal
+         */
+        onColumnsResize?: (widths: number[]) => void;
     };
     /**
      * Rows options
@@ -1345,12 +1375,66 @@ export interface CalendarHeatmapStyleOptions extends Pick<BaseStyleOptions, 'wid
  * View type determines how many months to display: 'month' (1), 'quarter' (3), 'half-year' (6), 'year' (12)
  */
 export type CalendarHeatmapViewType = 'month' | 'quarter' | 'half-year' | 'year';
+/**
+ * Configuration options that define functional style of the various elements of a SankeyChart.
+ *
+ * @beta
+ *
+ * @example
+ * ```tsx
+ * <SankeyChart
+ *   dataSet={dataSource}
+ *   dataOptions={{
+ *     category: [DM.Commerce.Gender, DM.Category.Category],
+ *     value: [DM.Measures.SumRevenue],
+ *   }}
+ *   styleOptions={{
+ *     orientation: 'vertical',
+ *     nodePadding: 12,
+ *   }}
+ * />
+ * ```
+ */
+export interface SankeyStyleOptions extends BaseStyleOptions {
+    /**
+     * Whether the diagram flows horizontally (left-to-right) or vertically (top-to-bottom).
+     * Highcharts renders vertical flow by inverting the chart.
+     *
+     * @default 'horizontal'
+     */
+    orientation?: 'horizontal' | 'vertical';
+    /**
+     * Curve factor of links between Sankey nodes. 0 makes the lines straight.
+     * @default 0.33
+     */
+    curveFactor?: number;
+    /**
+     * Opacity of the links between Sankey nodes.
+     * @default 0.5
+     */
+    linkOpacity?: number;
+    /**
+     * Width of Sankey nodes in pixels (or height in vertical mode).
+     * @default 20
+     */
+    nodeWidth?: number;
+    /**
+     * Vertical padding between Sankey nodes in pixels (horizontal padding in vertical mode).
+     * @default 10
+     */
+    nodePadding?: number;
+    /**
+     * Determines which side of the chart the nodes are aligned to.
+     * In vertical mode `'top'` aligns to the left and `'bottom'` to the right.
+     */
+    nodeAlignment?: 'top' | 'center' | 'bottom';
+}
 /**
  * Configuration options that define functional style of the various elements of chart.
  */
 export type ChartStyleOptions = RegularChartStyleOptions | TabularChartStyleOptions;
 /** Style options for regular chart types */
-export type RegularChartStyleOptions = LineStyleOptions | AreaStyleOptions | StackableStyleOptions | PieStyleOptions | FunnelStyleOptions | PolarStyleOptions | IndicatorStyleOptions | ScatterStyleOptions | TreemapStyleOptions | SunburstStyleOptions | BoxplotStyleOptions | AreamapStyleOptions | ScattermapStyleOptions | AreaRangeStyleOptions | CalendarHeatmapStyleOptions | StreamgraphStyleOptions;
+export type RegularChartStyleOptions = LineStyleOptions | AreaStyleOptions | StackableStyleOptions | PieStyleOptions | FunnelStyleOptions | PolarStyleOptions | IndicatorStyleOptions | ScatterStyleOptions | TreemapStyleOptions | SunburstStyleOptions | BoxplotStyleOptions | AreamapStyleOptions | ScattermapStyleOptions | AreaRangeStyleOptions | CalendarHeatmapStyleOptions | StreamgraphStyleOptions | SankeyStyleOptions;
 /** Mapping of each of the chart value series to colors. */
 export type ValueToColorMap = {
     [value: string]: string;
@@ -1362,7 +1446,7 @@ export type MultiColumnValueToColorMap = {
 /**
  * Chart type of one of the supported chart families
  */
-export type ChartType = CartesianChartType | CategoricalChartType | ScatterChartType | IndicatorChartType | AreamapChartType | BoxplotChartType | ScattermapChartType | CalendarHeatmapChartType | RangeChartType | TableChartType;
+export type ChartType = CartesianChartType | CategoricalChartType | ScatterChartType | IndicatorChartType | AreamapChartType | BoxplotChartType | ScattermapChartType | CalendarHeatmapChartType | RangeChartType | SankeyChartType | TableChartType;
 /** Chart type of the regular charts */
 export type RegularChartType = Exclude<ChartType, TableChartType>;
 /**
@@ -2287,7 +2371,6 @@ export interface WidgetByIdStyleOptions extends WidgetContainerStyleOptions {
 export type ChartWidgetStyleOptions = ChartStyleOptions & WidgetContainerStyleOptions;
 /**
  * Style settings defining the look and feel of PivotTableWidget
- *
  */
 export type PivotTableWidgetStyleOptions = PivotTableStyleOptions & WidgetContainerStyleOptions;
 /**