@sisense/sdk-ui 1.10.1 → 1.12.0

package/dist/types.d.ts

@@ -2,10 +2,10 @@
 import type { Attribute, MembersFilter } from '@sisense/sdk-data';
 import { DeepRequired } from 'ts-essentials';
 import { AreaSubtype, BoxplotSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype } from './chart-options-processor/subtype-to-design-options';
-import { IndicatorComponents } from './chart-options-processor/translations/design-options';
+import { IndicatorComponents, TableColorOptions } from './chart-options-processor/translations/design-options';
 import { FunnelDirection, FunnelSize, FunnelType } from './chart-options-processor/translations/funnel-plot-options';
 import { ScatterMarkerSize } from './chart-options-processor/translations/scatter-plot-options';
-import { CartesianChartType, ScatterChartType, CategoricalChartType, IndicatorChartType, TableType, AreamapChartType, BoxplotChartType, ScattermapChartType } from './chart-options-processor/translations/types';
+import { CartesianChartType, ScatterChartType, CategoricalChartType, IndicatorChartType, TableType, AreamapChartType, BoxplotChartType, ScattermapChartType, RangeChartType, TableChartType } from './chart-options-processor/translations/types';
 import { DataPointsEventHandler } from './props';
 import { LegendPosition } from './chart-options-processor/translations/legend-section';
 import { GeoDataElement, RawGeoDataElement } from './chart-data/types';
@@ -15,7 +15,7 @@ export type { AppConfig } from './app/client-application';
 export type { DateConfig } from './query/date-formats';
 export type { CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, StyledColumn, StyledMeasureColumn, } from './chart-data-options/types';
 export type { DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, } from './chart-data/data-coloring/types';
-export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, GeoDataElement, RawGeoDataElement, Coordinates, };
+export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, TableChartType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, GeoDataElement, RawGeoDataElement, Coordinates, RangeChartType, TableColorOptions, };
 export type { MonthOfYear, DayOfWeek, DateLevel } from './query/date-formats/apply-date-format';
 /**
  * @internal
@@ -213,6 +213,10 @@ export interface LineStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions
     /** Subtype of LineChart */
     subtype?: LineSubtype;
 }
+/** Configuration options that define functional style of the various elements of AreaRangeChart */
+export interface AreaRangeStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
+    lineWidth?: LineWidth;
+}
 /** Configuration options that define functional style of the various elements of AreaChart */
 export interface AreaStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
     /** Configuration that defines line width */
@@ -279,16 +283,34 @@ export type IndicatorStyleOptions = (NumericSimpleIndicatorStyleOptions | Numeri
 export interface TableStyleOptions {
     /**
      * Boolean flag whether to fill header cells with background color
+     *
+     * @deprecated Use {@link TableStyleOptions#header | TableStyleOptions.header.color} instead.
      */
     headersColor?: boolean;
     /**
      * Boolean flag whether to apply background color to alternate rows.
+     *
+     * @deprecated Use {@link TableStyleOptions#rows | TableStyleOptions.rows.alternatingColor} instead.
      */
     alternatingRowsColor?: boolean;
     /**
      * Boolean flag whether to apply background color to alternate columns
+     *
+     * @deprecated Use {@link TableStyleOptions#columns | TableStyleOptions.columns.alternatingColor} instead.
      */
     alternatingColumnsColor?: boolean;
+    /**
+     * Vertical padding around whole table
+     * Default value is 20px
+     *
+     */
+    paddingVertical?: number;
+    /**
+     * Horizontal padding around whole table
+     * Default value is 20px
+     *
+     */
+    paddingHorizontal?: number;
     /**
      * Number of rows per page
      *
@@ -313,8 +335,43 @@ export interface TableStyleOptions {
      * 3. Default value of 500px (for component without header) or 525px (for component with header).
      */
     height?: number;
+    /**
+     * Header options
+     */
+    header?: {
+        /**
+         * Color of header
+         */
+        color?: TableColorOptions;
+    };
+    /**
+     * Columns options
+     */
+    columns?: {
+        /**
+         * Alternating color for columns
+         */
+        alternatingColor?: TableColorOptions;
+        /**
+         * Modes of columns width
+         * 'auto' - all columns will have the same width and fit the table width (no horizontal scroll)
+         * 'content' - columns width will be based on content (default option)
+         */
+        width?: 'auto' | 'content';
+    };
+    /**
+     * Rows options
+     */
+    rows?: {
+        /**
+         * Alternating color for rows
+         */
+        alternatingColor?: TableColorOptions;
+    };
 }
-/** Configuration options that define functional style of the various elements of the PivotTable component */
+/** Configuration options that define functional style of the various elements of the tabular charts. */
+export type TabularChartStyleOptions = TableStyleOptions;
+/** Configuration options that define functional style of the various elements of the PivotTable component. */
 export interface PivotTableStyleOptions {
     /**
      * Boolean flag whether to fill header cells with background color
@@ -368,6 +425,10 @@ export interface PivotTableStyleOptions {
      * Manual height of each row (default is 25px)
      */
     rowHeight?: number;
+    /**
+     * Color of highlighted cells. If not specified, default value is light yellow (`#ffff9c`).
+     */
+    highlightColor?: string;
 }
 /**
  * Common part of IndicatorStyleOptions for all types of indicator
@@ -475,7 +536,9 @@ export interface ScattermapStyleOptions extends Pick<BaseStyleOptions, 'width' |
 /**
  * Configuration options that define functional style of the various elements of chart.
  */
-export type ChartStyleOptions = LineStyleOptions | AreaStyleOptions | StackableStyleOptions | PieStyleOptions | FunnelStyleOptions | PolarStyleOptions | IndicatorStyleOptions | ScatterStyleOptions | TreemapStyleOptions | SunburstStyleOptions | BoxplotStyleOptions | AreamapStyleOptions | ScattermapStyleOptions;
+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;
 /** Mapping of each of the chart value series to colors. */
 export type ValueToColorMap = {
     [value: string]: string;
@@ -487,12 +550,14 @@ export type MultiColumnValueToColorMap = {
 /**
  * Chart type of one of the supported chart families
  */
-export type ChartType = CartesianChartType | CategoricalChartType | ScatterChartType | IndicatorChartType | AreamapChartType | BoxplotChartType | ScattermapChartType;
+export type ChartType = CartesianChartType | CategoricalChartType | ScatterChartType | IndicatorChartType | AreamapChartType | BoxplotChartType | ScattermapChartType | RangeChartType | TableChartType;
+/** Chart type of the regular charts */
+export type RegularChartType = Exclude<ChartType, TableChartType>;
 /**
  * Series chart type, which is used with {@link StyledMeasureColumn} to customize
  * series in a mixed chart.
  */
-export type SeriesChartType = 'auto' | 'line' | 'spline' | 'areaspline' | 'bar' | 'area' | 'column' | 'scatter';
+export type SeriesChartType = 'auto' | 'line' | 'spline' | 'areaspline' | 'bar' | 'area' | 'column' | 'scatter' | 'arearange';
 /** The number of decimal places */
 export type DecimalScale = number | 'auto';
 /**
@@ -591,8 +656,6 @@ export interface ThemeSettings {
     };
     /**
      * Theme settings specific to the AI Chatbot component
-     *
-     * @internal
      */
     aiChat?: {
         /** Background color of the chatbot */
@@ -701,10 +764,10 @@ export interface ThemeSettings {
             borderRadius?: string;
             /** Setting to be applied on hover */
             hover?: {
-                /** Background color of the chatbot suggestions on hover */
-                backgroundColor?: string;
                 /** Text color of the chatbot suggestions on hover */
                 textColor?: string;
+                /** Background color of the chatbot suggestions on hover */
+                backgroundColor?: string;
             };
             /** 2-color gradient to be applied on suggestions loading animation */
             loadingGradient?: [string, string];
@@ -713,12 +776,14 @@ export interface ThemeSettings {
         };
         /** Settings for the chatbot clickable messages */
         clickableMessages?: {
-            /** Background color of the chatbot clickable messages */
-            backgroundColor?: string;
             /** Text color of the chatbot clickable messages */
             textColor?: string;
+            /** Background color of the chatbot clickable messages */
+            backgroundColor?: string;
             /** Border of the chatbot clickable messages */
             border?: false | string;
+            /** 2-color gradient to be applied on the border */
+            borderGradient?: [string, string] | null;
             /** Setting to be applied on hover */
             hover?: {
                 /** Text color of the chatbot clickable messages on hover */
@@ -727,16 +792,37 @@ export interface ThemeSettings {
                 backgroundColor?: string;
             };
         };
+        /** Settings for the data topics screen */
+        dataTopics?: {
+            /** Background color of the data topics screen */
+            backgroundColor?: string;
+            /** Settings for the individual data topic items */
+            items?: {
+                /** Text color of the data topic items */
+                textColor?: string;
+                /** Background color of the data topic items */
+                backgroundColor?: string;
+            };
+        };
         /** Settings for the chatbot icons */
         icons?: {
             /** Color of the chatbot icons */
             color?: string;
-            /** Setting to be applied on hover */
-            hover?: {
-                /** Color of the chatbot icons on hover */
-                color?: string;
+            /** Settings for feedback icons */
+            feedbackIcons?: {
+                /** Background color of the feedback icons on hover */
+                hoverColor?: string;
             };
         };
+        /** Settings for the chatbot tooltips */
+        tooltips?: {
+            /** Background color of the tooltips */
+            backgroundColor?: string;
+            /** Text color of the tooltips */
+            textColor?: string;
+            /** Box shadow of the tooltips */
+            boxShadow?: string;
+        };
     };
 }
 /**