@sisense/sdk-ui 2.12.0 → 2.14.0

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

@@ -2,7 +2,6 @@ import { CSSProperties, ReactNode } from 'react';
 import type { Attribute, CalculatedMeasureColumn, Column, Measure, MeasureColumn, MembersFilter } from '@sisense/sdk-data';
 import { DeepRequired } from 'ts-essentials';
 import { Coordinates } from './charts/map-charts/scattermap/types';
-import { TabCornerRadius, TabInterval, TabSize } from './widgets/tabber-widget';
 import { Hierarchy, HierarchyId, StyledColumn, StyledMeasureColumn } from '.';
 import { HighchartsOptionsInternal } from './chart-options-processor/chart-options-service';
 import { AreaRangeSubtype, AreaSubtype, BoxplotSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype } from './chart-options-processor/subtype-to-design-options';
@@ -14,6 +13,7 @@ import { AreamapChartType, BoxplotChartType, CalendarHeatmapChartType, Cartesian
 import { GeoDataElement, RawGeoDataElement } from './chart/restructured-charts/areamap-chart/types';
 import { CalendarDayOfWeek } from './chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils';
 import { DataPointsEventHandler } from './props';
+import { GradientColor } from './utils/gradient';
 import { SoftUnion } from './utils/utility-types';
 export type { SortDirection, PivotRowsSort } from '@sisense/sdk-data';
 export type { AppConfig } from './app/client-application';
@@ -24,6 +24,7 @@ export type { DataColorCondition, ConditionalDataColorOptions, DataColorOptions,
 export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, CalendarHeatmapChartType, TableType, TableChartType, AreaSubtype, AreaRangeSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, GeoDataElement, RawGeoDataElement, Coordinates, RangeChartType, TableColorOptions, TextStyle, };
 export type { MonthOfYear, DayOfWeek, DateLevel } from './query/date-formats/apply-date-format';
 export type { IndicatorRenderOptions } from './charts/indicator/indicator-render-options';
+export type { TabberButtonsWidgetStyleOptions, TabberButtonsWidgetCustomOptions, } from './widgets/tabber/types';
 /**
  * @internal
  */
@@ -109,8 +110,7 @@ export type SeriesLabelsTextStyle = Omit<TextStyle, 'pointerEvents' | 'textOverf
      */
     color?: 'contrast' | string;
 };
-/** Options that define series labels - titles/names identifying data series in a chart. */
-export type SeriesLabels = {
+export type SeriesLabelsBase = {
     /** Boolean flag that defines if series labels should be shown on the chart */
     enabled: boolean;
     /**
@@ -118,36 +118,6 @@ export type SeriesLabels = {
      * Note that due to a more complex structure, backgrounds, borders and padding will be lost on a rotated data label
      * */
     rotation?: number;
-    /**
-     * Boolean flag that defines if value should be shown in series labels
-     * (if not specified, value will be shown by default)
-     */
-    showValue?: boolean;
-    /**
-     * Boolean flag that defines if percentage should be shown in series labels
-     * (only applicable for subtypes that support percentage, like "stacked100")
-     */
-    showPercentage?: boolean;
-    /**
-     * Text to be shown before the series labels
-     */
-    prefix?: string;
-    /**
-     * Text to be shown after the series labels
-     */
-    suffix?: string;
-    /**
-     * If `true`, series labels appear inside bars/columns instead of at the datapoints. Not applicable for some chart types e.g. line, area
-     */
-    alignInside?: boolean;
-    /**
-     * The horizontal alignment of the data label compared to the point
-     */
-    align?: 'left' | 'center' | 'right';
-    /**
-     * The vertical alignment of the data label
-     */
-    verticalAlign?: 'top' | 'middle' | 'bottom';
     /**
      * Styling for labels text
      */
@@ -155,11 +125,11 @@ export type SeriesLabels = {
     /**
      * Background color of the labels. `auto` uses the same color as the data point
      */
-    backgroundColor?: 'auto' | string;
+    backgroundColor?: 'auto' | string | GradientColor;
     /**
      * Color of the labels border
      */
-    borderColor?: string;
+    borderColor?: string | GradientColor;
     /**
      * Border radius in pixels applied to the labels border, if visible
      *
@@ -187,11 +157,49 @@ export type SeriesLabels = {
      */
     yOffset?: number;
     /**
-     * The animation delay time in milliseconds. Set to 0 to render the data labels immediately
+     * Text to be shown before the series labels
+     */
+    prefix?: string;
+    /**
+     * Text to be shown after the series labels
+     */
+    suffix?: string;
+};
+export type SeriesLabelsAligning = {
+    /**
+     * If `true`, series labels appear inside bars/columns instead of at the datapoints. Not applicable for some chart types e.g. line, area
+     */
+    alignInside?: boolean;
+    /**
+     * The horizontal alignment of the data label compared to the point
      *
-     * @internal
+     * For some chart types, this will only apply when `alignInside` is `true`.
      */
-    delay?: number;
+    align?: 'left' | 'center' | 'right';
+    /**
+     * The vertical alignment of the data label
+     *
+     * For some chart types, this will only apply when `alignInside` is `true`.
+     */
+    verticalAlign?: 'top' | 'middle' | 'bottom';
+};
+/** Options that define series labels - titles/names identifying data series in a chart. */
+export type SeriesLabels = SeriesLabelsBase & SeriesLabelsAligning & {
+    /**
+     * Boolean flag that defines if value should be shown in series labels
+     * (if not specified, default is determined by chart type)
+     */
+    showValue?: boolean;
+    /**
+     * Boolean flag that defines if percentage should be shown in series labels
+     * (only applicable for subtypes that support percentage, like "stacked100")
+     */
+    showPercentage?: boolean;
+    /**
+     * Boolean flag that defines if percentage should be shown with decimals
+     * (will work only if `showPercentage` is `true`)
+     */
+    showPercentDecimals?: boolean;
 };
 /**
  * Text styling options for total labels.
@@ -235,11 +243,11 @@ export type TotalLabels = {
     /**
      * Background color of the labels. `auto` uses the same color as the data point
      */
-    backgroundColor?: 'auto' | string;
+    backgroundColor?: 'auto' | string | GradientColor;
     /**
      * Color of the labels border
      */
-    borderColor?: string;
+    borderColor?: string | GradientColor;
     /**
      * Border radius in pixels applied to the labels border, if visible
      *
@@ -365,11 +373,11 @@ export type LegendOptions = {
     /** Padding inside the legend, in pixels */
     padding?: number;
     /** Background color of the legend */
-    backgroundColor?: string;
+    backgroundColor?: string | GradientColor;
     /** Width of the legend border in pixels */
     borderWidth?: number;
     /** Color of the legend border */
-    borderColor?: string;
+    borderColor?: string | GradientColor;
     /**
      * Border radius in pixels applied to the legend border, if visible.
      *
@@ -523,10 +531,6 @@ export interface BaseStyleOptions extends ReservedStyleOptions {
      * Configuration for legend - a key that provides information about the data series or colors used in chart
      * */
     legend?: LegendOptions;
-    /**
-     * Configuration for series labels - titles/names identifying data series in a chart
-     */
-    seriesLabels?: SeriesLabels;
     /** Data limit for series or categories that will be plotted */
     dataLimits?: DataLimits;
     /**
@@ -590,6 +594,10 @@ export interface LineStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions
      * - `right` - step occurs after the point
      */
     stepPosition?: 'left' | 'center' | 'right';
+    /**
+     * Configuration for series labels - titles/names identifying data series in a chart
+     */
+    seriesLabels?: SeriesLabels;
 }
 /** Configuration options that define functional style of the various elements of AreaRangeChart */
 export interface AreaRangeStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
@@ -604,6 +612,10 @@ export interface AreaRangeStyleOptions extends BaseStyleOptions, BaseAxisStyleOp
     line?: LineOptions;
     /** Subtype of AreaRangeChart */
     subtype?: AreaRangeSubtype;
+    /**
+     * Configuration for series labels - titles/names identifying data series in a chart
+     */
+    seriesLabels?: SeriesLabels;
 }
 /** Configuration options that define functional style of the various elements of AreaChart */
 export interface AreaStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
@@ -618,6 +630,10 @@ export interface AreaStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions
     line?: LineOptions;
     /** Subtype of AreaChart*/
     subtype?: AreaSubtype;
+    /**
+     * Configuration for series labels - titles/names identifying data series in a chart
+     */
+    seriesLabels?: SeriesLabels;
     /**
      * Configuration for total labels
      * Only supported for stacked chart subtypes
@@ -628,6 +644,10 @@ export interface AreaStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions
 export interface StackableStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
     /** Subtype of stackable chart */
     subtype?: StackableSubtype;
+    /**
+     * Configuration for series labels - titles/names identifying data series in a chart
+     */
+    seriesLabels?: SeriesLabels;
     /**
      * Configuration for total labels
      * Only supported for stacked chart subtypes
@@ -659,33 +679,92 @@ export interface StackableStyleOptions extends BaseStyleOptions, BaseAxisStyleOp
         borderRadius?: number | string;
     };
 }
+/**
+ * Configuration for percentage labels
+ * Percentage labels are shown on top of series slices
+ */
+export type PiePercentageLabels = {
+    /**
+     * Boolean flag that defines if percentage label should be shown
+     */
+    enabled: boolean;
+    /**
+     * Boolean flag that defines if percentage label should be shown with decimals
+     */
+    showDecimals?: boolean;
+};
+export type PieSeriesLabels = SeriesLabelsBase & {
+    /**
+     * Boolean flag that defines if value should be shown in series labels
+     * (if not specified, default is determined by chart type)
+     */
+    showValue?: boolean;
+    /**
+     * Boolean flag that defines if the category should be shown
+     * @default `true`
+     */
+    showCategory?: boolean;
+    /**
+     * Configuration for percentage labels
+     * Percentage labels are shown on top of series slices
+     * Styling from series labels are not applied to percentage labels
+     */
+    percentageLabels?: PiePercentageLabels;
+    /**
+     * Styling for labels text
+     */
+    textStyle?: Omit<TextStyle, 'pointerEvents' | 'textOverflow'>;
+};
 /** Configuration options that define functional style of the various elements of Pie chart */
-export interface PieStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'> {
+export interface PieStyleOptions extends BaseStyleOptions {
     /**
      * Configuration that defines the ability of the Pie chart to collapse (convolve) and
      * hide part of the data under the single category "Others".
      */
     convolution?: Convolution;
-    /** Configuration that defines behavior of data labels on Pie chart */
+    /**
+     * Configuration that defines behavior of data labels on Pie chart
+     *
+     * @deprecated
+     * Use seriesLabels instead
+     */
     labels?: Labels;
     /** Subtype of Pie chart*/
     subtype?: PieSubtype;
+    /**
+     * Configuration for series labels - titles/names identifying data series in a chart
+     */
+    seriesLabels?: PieSeriesLabels;
+}
+export interface FunnelSeriesLabels extends SeriesLabels {
+    /** Boolean flag that defines if category names should be shown in series labels */
+    showCategory?: boolean;
 }
 /** Configuration options that define functional style of the various elements of FunnelChart */
-export interface FunnelStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'> {
+export interface FunnelStyleOptions extends BaseStyleOptions {
     /** Visual size of the lowest slice (degree of funnel narrowing from highest to lowest slices)*/
     funnelSize?: FunnelSize;
     /** Visual type of the lowest slice of FunnelChart */
     funnelType?: FunnelType;
     /** Direction of FunnelChart narrowing */
     funnelDirection?: FunnelDirection;
-    /** Configuration that defines behavior of data labels on FunnelChart */
+    /**
+     * Configuration that defines behavior of data labels on FunnelChart
+     *
+     * @deprecated Use seriesLabels instead
+     */
     labels?: Labels;
     /** Subtype of FunnelChart*/
     subtype?: never;
+    /** Configuration for series labels */
+    seriesLabels?: FunnelSeriesLabels;
 }
 /** Configuration options that define functional style of the various elements of PolarChart */
 export interface PolarStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
+    /**
+     * Configuration for series labels - titles/names identifying data series in a chart
+     */
+    seriesLabels?: SeriesLabels;
     /** Subtype of PolarChart*/
     subtype?: PolarSubtype;
 }
@@ -870,15 +949,21 @@ export interface GaugeIndicatorStyleOptions extends BaseIndicatorStyleOptions {
     /** Bar height for gauge indicator in ticker mode */
     tickerBarHeight?: number;
 }
+export type ScatterSeriesLabels = SeriesLabelsBase & SeriesLabelsAligning;
 /** Configuration options that define functional style of the various elements of ScatterChart */
-export interface ScatterStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'>, BaseAxisStyleOptions {
+export interface ScatterStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
     /** Subtype of ScatterChart*/
     subtype?: never;
     markerSize?: ScatterMarkerSize;
+    seriesLabels?: ScatterSeriesLabels;
 }
+export type TreemapSeriesLabels = (SeriesLabelsBase & SeriesLabelsAligning) | (SeriesLabelsBase & SeriesLabelsAligning)[];
 /** Configuration options that define functional style of the various elements of TreemapChart */
-export interface TreemapStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'> {
-    /** Labels options object */
+export interface TreemapStyleOptions extends BaseStyleOptions {
+    /**
+     * Labels options object
+     * @deprecated Please use `seriesLabels` instead
+     */
     labels?: {
         /** Array with single label options objects (order of items relative to dataOptions.category) */
         category?: {
@@ -886,6 +971,10 @@ export interface TreemapStyleOptions extends Omit<BaseStyleOptions, 'seriesLabel
             enabled?: boolean;
         }[];
     };
+    /**
+     * Configuration for series labels - titles/names identifying data series in a chart
+     */
+    seriesLabels?: TreemapSeriesLabels;
     /** Tooltip options object */
     tooltip?: {
         /** Define mode of data showing */
@@ -893,7 +982,7 @@ export interface TreemapStyleOptions extends Omit<BaseStyleOptions, 'seriesLabel
     };
 }
 /** Configuration options that define functional style of the various elements of the SunburstChart component */
-export interface SunburstStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'> {
+export interface SunburstStyleOptions extends BaseStyleOptions {
     /** Labels options object */
     labels?: {
         /** Array with single label options objects (order of items relative to dataOptions.category) */
@@ -912,6 +1001,10 @@ export interface SunburstStyleOptions extends Omit<BaseStyleOptions, 'seriesLabe
 export interface BoxplotStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
     /** Subtype of the BoxplotChart component*/
     subtype?: BoxplotSubtype;
+    /**
+     * Configuration for series labels - titles/names identifying data series in a chart
+     */
+    seriesLabels?: SeriesLabels;
 }
 /**
  * Type of map to display on the AreamapChart component
@@ -978,10 +1071,20 @@ export type CalendarHeatmapCellLabels = {
         color?: string | 'contrast';
     };
 };
+/**
+ * Calendar heatmap chart subtype
+ */
+export type CalendarHeatmapSubtype = 'calendar-heatmap/split' | 'calendar-heatmap/continuous';
 /**
  * Configuration options that define functional style of the various elements of calendar-heatmap chart
  */
 export interface CalendarHeatmapStyleOptions extends Pick<BaseStyleOptions, 'width' | 'height'> {
+    /**
+     * {@inheritDoc CalendarHeatmapSubtype}
+     *
+     * @default 'calendar-heatmap/split'
+     */
+    subtype?: CalendarHeatmapSubtype;
     /**
      * {@inheritDoc CalendarHeatmapViewType}
      */
@@ -2358,59 +2461,6 @@ export type TranslationConfig = {
      */
     customTranslations?: CustomTranslationObject[];
 };
-/**
- * Single Tabber Widget tab object without styling
- *
- * @internal
- */
-export type TabberTab = {
-    displayWidgetIds: string[];
-    title: string;
-};
-/**
- * Tabber widget DTO style property
- *
- * @internal
- */
-export type TabberDtoStyle = Partial<TabberStyleProps> & {
-    activeTab?: string;
-};
-/**
- * Configuration options that define style of the various elements of the Tabber component.
- *
- * @internal
- */
-export type TabberStyleOptions = {
-    descriptionColor: string;
-    selectedBkgColor: string;
-    selectedColor: string;
-    showDescription: boolean;
-    showSeparators: boolean;
-    showTitle: boolean;
-    tabCornerRadius: TabCornerRadius;
-    tabsAlignment: string;
-    tabsInterval: TabInterval;
-    tabsSize: TabSize;
-    unselectedBkgColor: string;
-    unselectedColor: string;
-    useSelectedBkg: boolean;
-    useUnselectedBkg: boolean;
-};
-/**
- * Configuration options that defined tabber look and feel, including tabs and active tab.
- *
- * @internal
- */
-export type TabberStyleProps = TabberStyleOptions & TabberConfig;
-/**
- * Tabber business logic configuration
- *
- * @internal
- */
-export type TabberConfig = {
-    tabs: TabberTab[];
-    activeTab: number;
-};
 /** @internal */
 export type CustomContextProviderProps<P> = SoftUnion<{
     context: P;