@sisense/sdk-ui 2.11.0 → 2.13.0

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

@@ -1,20 +1,20 @@
+import { CSSProperties, ReactNode } from 'react';
 import type { Attribute, CalculatedMeasureColumn, Column, Measure, MeasureColumn, MembersFilter } from '@sisense/sdk-data';
 import { DeepRequired } from 'ts-essentials';
-import { AreaSubtype, BoxplotSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, AreaRangeSubtype } from './chart-options-processor/subtype-to-design-options';
+import { Coordinates } from './charts/map-charts/scattermap/types';
+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';
 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, CalendarHeatmapChartType, RangeChartType, TableChartType, TextStyle } from './chart-options-processor/translations/types';
-import { DataPointsEventHandler } from './props';
 import { LegendPosition } from './chart-options-processor/translations/legend-section';
-import { Coordinates } from './charts/map-charts/scattermap/types';
-import { StyledColumn, StyledMeasureColumn, Hierarchy, HierarchyId } from '.';
-import { HighchartsOptionsInternal } from './chart-options-processor/chart-options-service';
-import { CSSProperties, ReactNode } from 'react';
+import { ScatterMarkerSize } from './chart-options-processor/translations/scatter-plot-options';
+import { AreamapChartType, BoxplotChartType, CalendarHeatmapChartType, CartesianChartType, CategoricalChartType, IndicatorChartType, RangeChartType, ScatterChartType, ScattermapChartType, TableChartType, TableType, TextStyle } from './chart-options-processor/translations/types';
 import { GeoDataElement, RawGeoDataElement } from './chart/restructured-charts/areamap-chart/types';
-import { TabCornerRadius, TabInterval, TabSize } from './widgets/tabber-widget';
-import { SoftUnion } from './utils/utility-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';
 export type { DateConfig } from './query/date-formats';
@@ -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
  */
@@ -120,7 +121,7 @@ export type SeriesLabels = {
     rotation?: number;
     /**
      * Boolean flag that defines if value should be shown in series labels
-     * (if not specified, value will be shown by default)
+     * (if not specified, default is determined by chart type)
      */
     showValue?: boolean;
     /**
@@ -128,6 +129,11 @@ export type SeriesLabels = {
      * (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 to be shown before the series labels
      */
@@ -155,11 +161,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
      *
@@ -194,13 +200,82 @@ export type SeriesLabels = {
     delay?: number;
 };
 /**
- * @internal
+ * Text styling options for total labels.
+ *
+ * Extends the base TextStyle with additional alignment options specific to total labels.
+ */
+export type TotalLabelsTextStyle = Omit<TextStyle, 'pointerEvents' | 'textOverflow'> & {
+    /**
+     * Horizontal alignment of the total label text
+     */
+    align?: 'left' | 'center' | 'right';
+};
+/**
+ * Configuration options for total labels in stacked charts.
+ *
+ * Total labels display the sum of all series values at each data point in stacked charts.
+ * This configuration allows you to customize the appearance and positioning of these labels.
  */
 export type TotalLabels = {
-    /** Boolean flag that defines if total labels should be shown on the chart */
+    /**
+     * Boolean flag that defines if total labels should be shown on the chart
+     * Total labels are only supported for stacked chart subtypes (Column, Bar, Area)
+     * */
     enabled: boolean;
-    /** Rotation of total labels (in degrees) */
+    /**
+     * Rotation of total labels (in degrees)
+     * */
     rotation?: number;
+    /**
+     * The horizontal alignment of the total label compared to the point
+     */
+    align?: 'left' | 'center' | 'right';
+    /**
+     * The vertical alignment of the total label compared to the point
+     */
+    verticalAlign?: 'top' | 'middle' | 'bottom';
+    /**
+     * The animation delay time in milliseconds. Set to 0 to render the data labels immediately
+     */
+    delay?: number;
+    /**
+     * Background color of the labels. `auto` uses the same color as the data point
+     */
+    backgroundColor?: 'auto' | string | GradientColor;
+    /**
+     * Color of the labels border
+     */
+    borderColor?: string | GradientColor;
+    /**
+     * Border radius in pixels applied to the labels border, if visible
+     *
+     * @default 0
+     */
+    borderRadius?: number;
+    /**
+     * Border width of the series labels, in pixels
+     */
+    borderWidth?: number;
+    /**
+     * Styling for labels text
+     */
+    textStyle?: TotalLabelsTextStyle;
+    /**
+     * Horizontal offset of the total label in pixels, relative to its horizontal alignment specified via `align`
+     */
+    xOffset?: number;
+    /**
+     * Vertical offset of the total label in pixels, relative to its vertical alignment specified via `verticalAlign`
+     */
+    yOffset?: number;
+    /**
+     * Text to be shown before the total label
+     */
+    prefix?: string;
+    /**
+     * Text to be shown after the total label
+     */
+    suffix?: string;
 };
 /**
  * Configuration for the legend title
@@ -296,11 +371,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.
      *
@@ -309,8 +384,6 @@ export type LegendOptions = {
     borderRadius?: number;
     /**
      * Whether to show shadow on the legend
-     *
-     * @internal
      */
     shadow?: boolean;
     /** If `true`, the order of legend items is reversed.
@@ -460,12 +533,6 @@ export interface BaseStyleOptions extends ReservedStyleOptions {
      * Configuration for series labels - titles/names identifying data series in a chart
      */
     seriesLabels?: SeriesLabels;
-    /**
-     * Configuration for total labels
-     *
-     * @internal
-     */
-    totalLabels?: TotalLabels;
     /** Data limit for series or categories that will be plotted */
     dataLimits?: DataLimits;
     /**
@@ -557,11 +624,21 @@ export interface AreaStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions
     line?: LineOptions;
     /** Subtype of AreaChart*/
     subtype?: AreaSubtype;
+    /**
+     * Configuration for total labels
+     * Only supported for stacked chart subtypes
+     */
+    totalLabels?: TotalLabels;
 }
 /** Configuration options that define functional style of the various elements of stackable charts, like Column or Bar */
 export interface StackableStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
     /** Subtype of stackable chart */
     subtype?: StackableSubtype;
+    /**
+     * Configuration for total labels
+     * Only supported for stacked chart subtypes
+     */
+    totalLabels?: TotalLabels;
     /**
      * Configuration for series styling
      */
@@ -588,17 +665,57 @@ 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 = Omit<SeriesLabels, 'showPercentage' | 'showPercentDecimals' | 'alignInside' | 'align' | 'verticalAlign'> & {
+    /**
+     * 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;
 }
 /** Configuration options that define functional style of the various elements of FunnelChart */
 export interface FunnelStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'> {
@@ -804,6 +921,7 @@ export interface ScatterStyleOptions extends Omit<BaseStyleOptions, 'seriesLabel
     /** Subtype of ScatterChart*/
     subtype?: never;
     markerSize?: ScatterMarkerSize;
+    seriesLabels?: Omit<SeriesLabels, 'showValue' | 'showPercentage' | 'showPercentDecimals'>;
 }
 /** Configuration options that define functional style of the various elements of TreemapChart */
 export interface TreemapStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'> {
@@ -885,6 +1003,19 @@ export type CalendarHeatmapCellLabels = {
      */
     enabled?: boolean;
     /** Style configuration for calendar day numbers in cells */
+    textStyle?: Omit<TextStyle, 'color'> & {
+        /**
+         * Color of the labels text
+         *
+         * The "contrast" color applies the maximum contrast between the background and the text
+         */
+        color?: string | 'contrast';
+    };
+    /**
+     * Style configuration for calendar day numbers in cells
+     *
+     * @deprecated Please use `textStyle` instead
+     */
     style?: Omit<TextStyle, 'color'> & {
         /**
          * Color of the labels text
@@ -922,6 +1053,12 @@ export interface CalendarHeatmapStyleOptions extends Pick<BaseStyleOptions, 'wid
          */
         enabled?: boolean;
         /** Style configuration for calendar weekday names */
+        textStyle?: TextStyle;
+        /**
+         * Style configuration for calendar weekday names
+         *
+         * @deprecated Please use `textStyle` instead
+         */
         style?: TextStyle;
     };
     /**
@@ -935,6 +1072,11 @@ export interface CalendarHeatmapStyleOptions extends Pick<BaseStyleOptions, 'wid
          */
         enabled?: boolean;
         /** Style configuration for month names */
+        textStyle?: TextStyle;
+        /**
+         * Style configuration for month names
+         * @deprecated Please use `textStyle` instead
+         */
         style?: TextStyle;
     };
     /**
@@ -962,6 +1104,21 @@ export interface CalendarHeatmapStyleOptions extends Pick<BaseStyleOptions, 'wid
          */
         hideValues?: boolean;
     };
+    /**
+     * Configuration for pagination controls in multi-month view types
+     */
+    pagination?: {
+        /**
+         * Boolean flag that defines if pagination controls should be shown
+         *
+         * @default true
+         */
+        enabled?: boolean;
+        /** Style configuration for pagination controls text */
+        textStyle?: TextStyle;
+        /** Start month to display when the chart is first rendered */
+        startMonth?: Date;
+    };
 }
 /**
  * View type determines how many months to display: 'month' (1), 'quarter' (3), 'half-year' (6), 'year' (12)
@@ -2248,59 +2405,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;