@sisense/sdk-ui 2.10.0 → 2.12.0

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

@@ -1,30 +1,24 @@
+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 { 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';
 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 { CalendarDayOfWeek } from './chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils';
+import { DataPointsEventHandler } from './props';
 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';
-/**
- * @internal
- * Enum for size measurement units
- */
-export declare enum SizeMeasurement {
-    PERCENT = "%",
-    PIXEL = "px"
-}
+export type { CalendarDayOfWeek } from './chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils';
 export type { CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, CalendarHeatmapChartDataOptions, 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, CalendarHeatmapChartType, TableType, TableChartType, AreaSubtype, AreaRangeSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, GeoDataElement, RawGeoDataElement, Coordinates, RangeChartType, TableColorOptions, TextStyle, };
@@ -106,11 +100,23 @@ export type X2Title = {
     enabled: boolean;
     text?: string;
 };
+export type SeriesLabelsTextStyle = Omit<TextStyle, 'pointerEvents' | 'textOverflow' | 'color'> & {
+    /**
+     * Color of the labels text
+     * The default color setting is "contrast", which applies the maximum contrast between the background and the text
+     *
+     * @default 'contrast'
+     */
+    color?: 'contrast' | string;
+};
 /** Options that define series labels - titles/names identifying data series in a chart. */
 export type SeriesLabels = {
     /** Boolean flag that defines if series labels should be shown on the chart */
     enabled: boolean;
-    /** Rotation of series labels (in degrees) */
+    /**
+     * Rotation of series labels (in degrees)
+     * 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
@@ -122,15 +128,148 @@ export type SeriesLabels = {
      * (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
+     */
+    textStyle?: SeriesLabelsTextStyle;
+    /**
+     * Background color of the labels. `auto` uses the same color as the data point
+     */
+    backgroundColor?: 'auto' | string;
+    /**
+     * Color of the labels border
+     */
+    borderColor?: string;
+    /**
+     * 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;
+    /**
+     * Padding of the series labels, in pixels
+     */
+    padding?: number;
+    /**
+     * Horizontal offset of the labels in pixels, relative to its horizontal alignment specified via `align`
+     *
+     * @default 0
+     */
+    xOffset?: number;
+    /**
+     * Vertical offset of the labels in pixels, relative to its vertical alignment specified via `verticalAlign`
+     *
+     * @default 0
+     */
+    yOffset?: number;
+    /**
+     * The animation delay time in milliseconds. Set to 0 to render the data labels immediately
+     *
+     * @internal
+     */
+    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;
+    /**
+     * Color of the labels border
+     */
+    borderColor?: string;
+    /**
+     * 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
@@ -239,8 +378,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.
@@ -283,6 +420,8 @@ export type LegendOptions = {
 };
 /**
  * Alias for LegendOptions for backward compatibility
+ *
+ * @deprecated Please use {@link LegendOptions} instead
  */
 export type Legend = LegendOptions;
 /** Configuration that defines behavior of data labels on chart */
@@ -386,16 +525,8 @@ export interface BaseStyleOptions extends ReservedStyleOptions {
     legend?: LegendOptions;
     /**
      * Configuration for series labels - titles/names identifying data series in a chart
-     *
-     * @internal
      */
     seriesLabels?: SeriesLabels;
-    /**
-     * Configuration for total labels
-     *
-     * @internal
-     */
-    totalLabels?: TotalLabels;
     /** Data limit for series or categories that will be plotted */
     dataLimits?: DataLimits;
     /**
@@ -487,14 +618,49 @@ 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
+     */
+    series?: {
+        /**
+         * Padding between each column or bar, in x axis units.
+         *
+         * @default 0.01
+         */
+        padding?: number;
+        /**
+         * Padding between each value groups, in x axis units.
+         *
+         * @default 0.1
+         */
+        groupPadding?: number;
+        /**
+         * The corner radius of the border surrounding each column or bar.
+         * A number signifies pixels.
+         * A percentage string, like for example 50%, signifies a relative size.
+         *
+         * @default 0
+         */
+        borderRadius?: number | string;
+    };
 }
 /** Configuration options that define functional style of the various elements of Pie chart */
-export interface PieStyleOptions extends BaseStyleOptions {
+export interface PieStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'> {
     /**
      * Configuration that defines the ability of the Pie chart to collapse (convolve) and
      * hide part of the data under the single category "Others".
@@ -506,7 +672,7 @@ export interface PieStyleOptions extends BaseStyleOptions {
     subtype?: PieSubtype;
 }
 /** Configuration options that define functional style of the various elements of FunnelChart */
-export interface FunnelStyleOptions extends BaseStyleOptions {
+export interface FunnelStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'> {
     /** 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 */
@@ -705,13 +871,13 @@ export interface GaugeIndicatorStyleOptions extends BaseIndicatorStyleOptions {
     tickerBarHeight?: number;
 }
 /** Configuration options that define functional style of the various elements of ScatterChart */
-export interface ScatterStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
+export interface ScatterStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'>, BaseAxisStyleOptions {
     /** Subtype of ScatterChart*/
     subtype?: never;
     markerSize?: ScatterMarkerSize;
 }
 /** Configuration options that define functional style of the various elements of TreemapChart */
-export interface TreemapStyleOptions extends BaseStyleOptions {
+export interface TreemapStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'> {
     /** Labels options object */
     labels?: {
         /** Array with single label options objects (order of items relative to dataOptions.category) */
@@ -727,7 +893,7 @@ export interface TreemapStyleOptions extends BaseStyleOptions {
     };
 }
 /** Configuration options that define functional style of the various elements of the SunburstChart component */
-export interface SunburstStyleOptions extends BaseStyleOptions {
+export interface SunburstStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'> {
     /** Labels options object */
     labels?: {
         /** Array with single label options objects (order of items relative to dataOptions.category) */
@@ -780,15 +946,132 @@ export interface ScattermapStyleOptions extends Pick<BaseStyleOptions, 'width' |
     markers?: ScattermapMarkers;
 }
 /**
- * Configuration options that define functional style of the various elements of CalendarHeatmapChart
- *
- * @alpha
+ * Configuration for day numbers (1-31) labels in calendar-heatmap cells
+ */
+export type CalendarHeatmapCellLabels = {
+    /**
+     * Boolean flag that defines if calendar day numbers should be shown in cells
+     *
+     * @default true
+     */
+    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
+         *
+         * The "contrast" color applies the maximum contrast between the background and the text
+         */
+        color?: string | 'contrast';
+    };
+};
+/**
+ * Configuration options that define functional style of the various elements of calendar-heatmap chart
  */
 export interface CalendarHeatmapStyleOptions extends Pick<BaseStyleOptions, 'width' | 'height'> {
     /**
      * {@inheritDoc CalendarHeatmapViewType}
      */
     viewType?: CalendarHeatmapViewType;
+    /**
+     * Determines which day of the week to start the calendar with
+     * @default 'sunday'
+     */
+    startOfWeek?: CalendarDayOfWeek;
+    /**
+     * Configuration for day numbers (1-31) in calendar cells
+     */
+    cellLabels?: CalendarHeatmapCellLabels;
+    /**
+     * Configuration for weekday names in the header
+     */
+    dayLabels?: {
+        /**
+         * Boolean flag that defines if calendar weekday names should be shown
+         *
+         * @default true
+         */
+        enabled?: boolean;
+        /** Style configuration for calendar weekday names */
+        textStyle?: TextStyle;
+        /**
+         * Style configuration for calendar weekday names
+         *
+         * @deprecated Please use `textStyle` instead
+         */
+        style?: TextStyle;
+    };
+    /**
+     * Configuration for month names in multi-month view types
+     */
+    monthLabels?: {
+        /**
+         * Boolean flag that defines if month names should be shown
+         *
+         * @default true
+         */
+        enabled?: boolean;
+        /** Style configuration for month names */
+        textStyle?: TextStyle;
+        /**
+         * Style configuration for month names
+         * @deprecated Please use `textStyle` instead
+         */
+        style?: TextStyle;
+    };
+    /**
+     * Configuration for weekend days
+     */
+    weekends?: {
+        /**
+         * Boolean flag that enables/disables weekend highlighting
+         *
+         * @default false
+         */
+        enabled?: boolean;
+        /** Weekend days - defaults to ['saturday', 'sunday'] */
+        days?: CalendarDayOfWeek[];
+        /**
+         * Calendar cell color for weekend days
+         *
+         * @default '#e6e6e6'
+         */
+        cellColor?: string;
+        /**
+         * Whether to hide values in tooltip for weekend days
+         *
+         * @default false
+         */
+        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)
@@ -1714,8 +1997,6 @@ export type IndicatorDataPoint = {
 };
 /**
  * Data point in a CalendarHeatmap chart.
- *
- * @alpha
  */
 export type CalendarHeatmapDataPoint = {
     /**
@@ -1857,6 +2138,9 @@ export type HighchartsPoint = {
             level?: number;
             levelsCount?: number;
         };
+        date?: number;
+        dateString?: string;
+        value?: number;
         q1?: number;
         median?: number;
         q3?: number;

package/dist/packages/sdk-ui/src/utils/create-level-attribute.d.ts

@@ -0,0 +1,11 @@
+import { TFunction } from '@sisense/sdk-common';
+import { DimensionalLevelAttribute } from '@sisense/sdk-data';
+/**
+ * Creates a level attribute from a base level attribute and a granularity
+ *
+ * @param baseLevelAttribute - The base level attribute
+ * @param granularity - The granularity
+ * @param t - The translation function
+ * @returns The level attribute
+ */
+export declare function createLevelAttribute(baseLevelAttribute: DimensionalLevelAttribute, granularity: string, t?: TFunction): DimensionalLevelAttribute;

package/dist/packages/sdk-ui/src/widget-by-id/translate-dashboard-filters.d.ts

@@ -1,6 +1,6 @@
-import { DashboardDto, FilterDto, CascadingFilterDto } from '../api/types/dashboard-dto.js';
-import { FiltersIgnoringRules, WidgetDto } from './types.js';
 import { IncludeAllFilterJaql } from '@sisense/sdk-data';
+import { CascadingFilterDto, DashboardDto, FilterDto } from '../api/types/dashboard-dto.js';
+import { FiltersIgnoringRules, WidgetDto } from './types.js';
 /**
  * Extracts and merges dashboard and widget filters. This consolidates all
  * filters applicable for a widget.

package/dist/packages/sdk-ui/src/widget-by-id/translate-panel-color-format.d.ts

@@ -1,5 +1,5 @@
 import { DataColorOptions } from '../chart-data/data-coloring/index.js';
-import { ValueToColorMap, MultiColumnValueToColorMap, Color } from '../types.js';
+import { Color, MultiColumnValueToColorMap, ValueToColorMap } from '../types.js';
 import { PanelColorFormat, PanelItem, PanelMembersFormat } from './types.js';
 export declare const createValueColorOptions: (format?: PanelColorFormat, customPaletteColors?: Color[]) => DataColorOptions | undefined;
 export declare const createValueToColorMap: (membersFormat: PanelMembersFormat) => ValueToColorMap;

package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-data-options.d.ts

@@ -1,7 +1,7 @@
 import { JaqlDataSource } from '@sisense/sdk-data';
-import { StyledMeasureColumn, StyledColumn, Color } from '../types.js';
-import { Panel, PanelItem, FusionWidgetType, WidgetStyle, BoxplotWidgetStyle } from './types.js';
 import { WidgetDataOptions } from '../models/index.js';
+import { Color, StyledColumn, StyledMeasureColumn } from '../types.js';
+import { BoxplotWidgetStyle, FusionWidgetType, Panel, PanelItem, WidgetStyle } from './types.js';
 export declare function createDataColumn(item: PanelItem, customPaletteColors?: Color[]): StyledColumn | StyledMeasureColumn;
 /** @internal */
 export declare function createPanelItem(column: StyledColumn | StyledMeasureColumn): PanelItem;

package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-drilldown-options.d.ts

@@ -1,3 +1,3 @@
-import { Panel, PanelItem, FusionWidgetType } from './types.js';
 import { DrilldownOptions } from '../types.js';
+import { FusionWidgetType, Panel, PanelItem } from './types.js';
 export declare const extractDrilldownOptions: (widgetType: FusionWidgetType, panels: Panel[], drillHistory?: PanelItem[], enableDrillToAnywhere?: boolean) => DrilldownOptions;

package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-style-options.d.ts

@@ -1,8 +1,17 @@
-import { ChartStyleOptions, TableStyleOptions, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, GaugeIndicatorStyleOptions, PivotTableStyleOptions, SpaceSizes, RadiusSizes, ShadowsTypes, AlignmentTypes, WidgetStyleOptions, TextWidgetStyleOptions } from '../types';
-import { WidgetSubtype, FusionWidgetType, TableWidgetStyle, IndicatorWidgetStyle, PivotWidgetStyle, WidgetDesign, WidgetDto } from './types';
+import { AlignmentTypes, ChartStyleOptions, GaugeIndicatorStyleOptions, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, PivotTableStyleOptions, RadiusSizes, ShadowsTypes, SpaceSizes, TableStyleOptions, TextWidgetStyleOptions, WidgetStyleOptions } from '../types';
+import { FusionWidgetType, IndicatorWidgetStyle, PivotWidgetStyle, TableWidgetStyle, WidgetDesign, WidgetDto, WidgetSubtype } from './types';
+/**
+ * Helper function to extract table chart style options from WidgetDto
+ */
 export declare function extractTableChartStyleOptions(widgetStyle: TableWidgetStyle): TableStyleOptions;
 export declare const getIndicatorTypeSpecificOptions: (widgetSubtype: WidgetSubtype, widgetStyle: IndicatorWidgetStyle) => NumericSimpleIndicatorStyleOptions | NumericBarIndicatorStyleOptions | GaugeIndicatorStyleOptions;
+/**
+ * Helper function to extract pivot table chart style options from WidgetDto
+ */
 export declare function extractPivotTableStyleOptions(widgetStyle: PivotWidgetStyle): PivotTableStyleOptions;
+/**
+ * Helper function to extract style options from WidgetDto
+ */
 export declare function extractStyleOptions<WType extends FusionWidgetType>(widgetType: WType, widget: WidgetDto): ChartStyleOptions | TableStyleOptions | TextWidgetStyleOptions;
 export declare const getFlattenWidgetDesign: (widgetDesign: WidgetDesign) => {
     backgroundColor: string;