@sisense/sdk-ui 1.2.0 → 1.4.0

package/dist/api/types/dashboard-dto.d.ts

@@ -1,5 +1,5 @@
 import { WidgetDto, Datasource } from '../../dashboard-widget/types';
-import { FilterJaql } from '@sisense/sdk-data';
+import { FilterJaql, FilterRelationsModel } from '@sisense/sdk-data';
 import { AnyObject } from '../../utils/utility-types';
 export type Filter = {
     isCascading?: false;
@@ -19,4 +19,7 @@ export type DashboardDto = {
     datasource: Datasource;
     widgets?: WidgetDto[];
     filters?: Array<Filter | CascadingFilter>;
+    filterRelations?: {
+        filterRelations: FilterRelationsModel;
+    }[];
 } & AnyObject;

package/dist/app/client-application.d.ts

@@ -5,6 +5,7 @@ import { SisenseContextProviderProps } from '../props';
 import { DateConfig } from '../query/date-formats';
 import { AppSettings } from './settings/settings';
 import { PivotClient } from '@sisense/sdk-pivot-client';
+import { LoadingIndicatorConfig } from '../types';
 /**
  * Application configuration
  */
@@ -23,6 +24,10 @@ export type AppConfig = {
      * Date Configurations
      */
     dateConfig?: DateConfig;
+    /**
+     * Loading Indicator Configurations
+     */
+    loadingIndicatorConfig?: LoadingIndicatorConfig;
 };
 /**
  * Stands for a Sisense Client Application which connects to a Sisense Environment
@@ -60,4 +65,4 @@ export declare class ClientApplication {
     constructor(url: string, auth: Authenticator, defaultDataSource?: DataSource);
 }
 /** @internal */
-export declare const createClientApplication: ({ defaultDataSource, url, token, wat, ssoEnabled, appConfig, }: SisenseContextProviderProps) => Promise<ClientApplication>;
+export declare const createClientApplication: ({ defaultDataSource, url, token, wat, ssoEnabled, appConfig, enableSilentPreAuth, }: SisenseContextProviderProps) => Promise<ClientApplication>;

package/dist/{chart.d.ts → chart/chart.d.ts}

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { ChartProps } from './props';
+import { ChartProps } from '../props';
 /** Function to check if we should wait for sisense context for rendering the chart */
 export declare const shouldSkipSisenseContextWaiting: (props: ChartProps) => boolean;
 /**

package/dist/chart/helpers/use-synced-data.d.ts

@@ -0,0 +1,8 @@
+import { Attribute, Data, DataSource, Filter, FilterRelations, Measure } from '@sisense/sdk-data';
+import { Dispatch, SetStateAction } from 'react';
+import { ChartDataOptionsInternal } from '../../chart-data-options/types';
+import { ChartType } from '../../types';
+import { DataColumnNamesMapping } from '../../chart-data-options/validate-data-options';
+type DataSet = DataSource | Data | undefined;
+export declare const useSyncedData: (dataSet: DataSet, chartDataOptions: ChartDataOptionsInternal, chartType: ChartType, attributes: Attribute[], measures: Measure[], dataColumnNamesMapping: DataColumnNamesMapping, filters?: Filter[] | FilterRelations, highlights?: Filter[], refreshCounter?: number, setIsLoading?: Dispatch<SetStateAction<boolean>>) => Data | undefined;
+export {};

package/dist/chart/helpers/use-translated-data-options.d.ts

@@ -0,0 +1,7 @@
+import { ChartDataOptions, ChartType } from '../../types';
+export declare const useTranslatedDataOptions: (dataOptions: ChartDataOptions, chartType: ChartType) => {
+    chartDataOptions: import("../..").ChartDataOptionsInternal;
+    attributes: import("@sisense/sdk-data").Attribute[];
+    measures: import("@sisense/sdk-data").Measure[];
+    dataColumnNamesMapping: import('../../chart-data-options/validate-data-options').DataColumnNamesMapping;
+};

package/dist/chart/index.d.ts

@@ -0,0 +1 @@
+export * from './chart';

package/dist/chart-data/types.d.ts

@@ -87,6 +87,7 @@ export type ScatterChartData = {
 };
 export type ScattermapChartLocation = {
     name: string;
+    rawName: string[];
     value: number;
     colorValue?: number;
     details?: number | string[];
@@ -111,20 +112,20 @@ export type IndicatorChartData = {
 };
 /**
  * Raw GeoDataElement from data
- *
- * @internal
  */
 export type RawGeoDataElement = {
+    /** Name of geo-element (country or state) */
     geoName: string;
+    /** Original numeric measure value for this geo-element */
     originalValue: number;
+    /** Formatted measure value for this geo-element to display*/
     formattedOriginalValue: string;
 };
 /**
  * GeoDataElement with color property, calculated from `originalValue`
- *
- * @internal
  */
 export type GeoDataElement = RawGeoDataElement & {
+    /** Calculated color for this geo-element */
     color?: Color;
 };
 /**

package/dist/chart-data-options/translate-data-options.d.ts

@@ -1,7 +1,11 @@
 import { Attribute, Measure } from '@sisense/sdk-data';
 import { ChartType } from '../types';
-import { ChartDataOptions, ChartDataOptionsInternal, TableDataOptionsInternal, TableDataOptions } from './types';
+import { ChartDataOptions, ChartDataOptionsInternal, TableDataOptionsInternal, TableDataOptions, PivotTableDataOptions, PivotTableDataOptionsInternal } from './types';
 export declare function translateChartDataOptions(chartType: ChartType, dataOptions: ChartDataOptions): ChartDataOptionsInternal;
 export declare function getAttributes(dataOptions: ChartDataOptionsInternal, chartType: ChartType): Attribute[];
 export declare function getMeasures(dataOptions: ChartDataOptionsInternal, chartType: ChartType): Measure[];
 export declare function translateTableDataOptions(dataOptions: TableDataOptions): TableDataOptionsInternal;
+/**
+ * Translates pivot table data options to the internal structure.
+ */
+export declare function translatePivotTableDataOptions(dataOptions: PivotTableDataOptions): PivotTableDataOptionsInternal;

package/dist/chart-data-options/types.d.ts

@@ -1,6 +1,6 @@
 import type { DataColorOptions } from '../chart-data/data-coloring';
-import type { NumberFormatConfig, SeriesChartType, SortDirection, ValueToColorMap, MultiColumnValueToColorMap } from '../types';
-import { Column, MeasureColumn, CalculatedMeasureColumn } from '@sisense/sdk-data';
+import type { NumberFormatConfig, SeriesChartType, SortDirection, ValueToColorMap, MultiColumnValueToColorMap, LineWidth, Markers } from '../types';
+import { Column, MeasureColumn, CalculatedMeasureColumn, PivotGrandTotals, TotalsCalculation } from '@sisense/sdk-data';
 /**
  * Styles for a category/column when visualized in a chart
  *
@@ -36,6 +36,18 @@ export interface CategoryStyle {
     /** {@inheritDoc SortDirection} */
     sortType?: SortDirection;
     isColored?: boolean;
+    /**
+     * Boolean flag whether to render category/column value as HTML in the Table component.
+     */
+    isHtml?: boolean;
+    /**
+     * Boolean flag whether to include subtotals for this dimension in the pivot table.
+     */
+    includeSubTotals?: boolean;
+    /**
+     * Geographic location level for Scattermap chart.
+     */
+    geoLevel?: ScattermapLocationLevel;
 }
 /**
  * Wrapped {@link @sisense/sdk-data!Column | Column} with styles controlling how the column is visualized in a chart.
@@ -105,6 +117,36 @@ export type ValueStyle = {
     treatNullDataAsZeros?: boolean;
     /** Boolean flag whether to connect a graph line across null points or render a gap */
     connectNulls?: boolean;
+    /**
+     * Calculation for the totals of this measure in the pivot table.
+     */
+    totalsCalculation?: TotalsCalculation;
+    /**
+     * Boolean flag whether to display data bars for this measure in the pivot table.
+     */
+    dataBars?: boolean;
+};
+/**
+ * Specific style options to be applied to specific series in Chart.
+ *
+ * @internal
+ */
+export type SeriesStyle = {
+    /**
+     * Specific style options to be applied to specific series in Chart.
+     * Supported only for cartesian and polar charts.
+     */
+    seriesStyleOptions?: SeriesStyleOptions;
+};
+/**
+ * Specific style options to be applied to specific series in Chart.
+ * Supported only for cartesian and polar charts.
+ */
+export type SeriesStyleOptions = {
+    /** @inheritdoc LineStyleOptions.lineWidth */
+    lineWidth?: LineWidth;
+    /** @inheritdoc LineStyleOptions.markers */
+    markers?: Markers;
 };
 /**
  * Wrapped {@link @sisense/sdk-data!MeasureColumn | Measure Column} with styles
@@ -144,7 +186,7 @@ export type ValueStyle = {
  *
  * See also {@link StyledColumn}.
  */
-export interface StyledMeasureColumn extends ValueStyle {
+export interface StyledMeasureColumn extends ValueStyle, SeriesStyle {
     /** Wrapped MeasureColumn or CalculatedMeasureColumn */
     column: MeasureColumn | CalculatedMeasureColumn;
 }
@@ -305,7 +347,37 @@ export interface TableDataOptions {
     columns: (Column | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn)[];
 }
 /**
- * Geographic location level for a Scattermap column.
+ * Configuration for how to query data and assign data to {@link PivotTable}.
+ *
+ */
+export interface PivotTableDataOptions {
+    /**
+     * Dimensions for the rows of the pivot table
+     *
+     * @category Data Options
+     */
+    rows?: (Column | StyledColumn)[];
+    /**
+     * Dimensions for the columns of the pivot table
+     *
+     * @category Data Options
+     */
+    columns?: (Column | StyledColumn)[];
+    /**
+     * Measures for the values of the pivot table
+     *
+     * @category Data Options
+     */
+    values?: (MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn)[];
+    /**
+     * Options for grand totals
+     *
+     * @category Data Options
+     */
+    grandTotals?: PivotGrandTotals;
+}
+/**
+ * Geographic location level for Scattermap chart.
  * This type can have one of the following values:
  * - 'auto': Automatically determines the appropriate location level.
  * - 'country': Represents the country level in the geographical hierarchy.
@@ -313,12 +385,6 @@ export interface TableDataOptions {
  * - 'city': Represents the city level in the geographical hierarchy.
  */
 export type ScattermapLocationLevel = 'auto' | 'country' | 'state' | 'city';
-/**
- * Scattermap column that allows to specify the geographic location level.
- */
-export interface ScattermapColumn extends StyledColumn {
-    level: ScattermapLocationLevel;
-}
 /**
  * Configuration for how to query aggregate data and assign data
  * to axes of a Scattermap chart.
@@ -329,7 +395,7 @@ export interface ScattermapChartDataOptions {
      * Support field(s) that contain geographic data (Country, City, State/Province, etc)
      * To visualize latitude and longitude data, you have to add one field containing latitude data, and another field containing longitude data, in this order.
      */
-    geo: (Column | StyledColumn | ScattermapColumn)[];
+    geo: (Column | StyledColumn)[];
     /**
      * Measure column (or measure) representing the size of the points on the map.
      */
@@ -420,7 +486,7 @@ export declare const isValue: (arg: Category | Value) => arg is Value;
 /** @internal */
 export declare const isCategory: (arg: Category | Value) => arg is Category;
 /** @internal */
-export interface Value extends ValueStyle {
+export interface Value extends ValueStyle, SeriesStyle {
     name: string;
     aggregation?: string;
     title: string;
@@ -459,6 +525,35 @@ export interface ScattermapChartDataOptionsInternal {
 export type TableDataOptionsInternal = {
     columns: (Category | Value)[];
 };
+/**
+ * @internal
+ */
+export interface PivotTableDataOptionsInternal {
+    /**
+     * Dimensions for the rows of the pivot table
+     *
+     * @category Data Options
+     */
+    rows?: Category[];
+    /**
+     * Dimensions for the columns of the pivot table
+     *
+     * @category Data Options
+     */
+    columns?: Category[];
+    /**
+     * Measures for the values of the pivot table
+     *
+     * @category Data Options
+     */
+    values?: Value[];
+    /**
+     * Options for grand totals
+     *
+     * @category Data Options
+     */
+    grandTotals?: PivotGrandTotals;
+}
 /** @internal */
 export type ChartDataOptionsInternal = CartesianChartDataOptionsInternal | CategoricalChartDataOptionsInternal | ScatterChartDataOptionsInternal | IndicatorChartDataOptionsInternal | BoxplotChartDataOptionsInternal | AreamapChartDataOptionsInternal | ScattermapChartDataOptionsInternal;
 /** @internal */

package/dist/chart-options-processor/apply-event-handlers.d.ts

@@ -1,29 +1,6 @@
-import { DataPoint, HighchartsPointerEvent, HighchartsSelectEvent, ScatterDataPoint } from '../types';
+import { HighchartsPointerEvent, HighchartsSelectEvent } from '../types';
 import { HighchartsOptionsInternal } from '../chart-options-processor/chart-options-service';
-/** Click handler for when multiple data points are selected. */
-export type DataPointsEventHandler = (
-/** Data points that were selected */
-points: DataPoint[], 
-/** Native MouseEvent */
-nativeEvent: MouseEvent) => void;
-/** Click handler for when a data point is clicked. One parameter, `DataPoint`, is passed to the function. */
-export type DataPointEventHandler = (
-/** Data point that was clicked */
-point: DataPoint, 
-/** Native PointerEvent */
-nativeEvent: PointerEvent) => void;
-/** Click handler for when a scatter data point is clicked */
-export type ScatterDataPointEventHandler = (
-/** Data point that was clicked */
-point: ScatterDataPoint, 
-/** Native PointerEvent */
-nativeEvent: PointerEvent) => void;
-/** Click handler for when multiple scatter data points are selected. */
-export type ScatterDataPointsEventHandler = (
-/** Data points that were selected */
-points: ScatterDataPoint[], 
-/** Native MouseEvent */
-nativeEvent: MouseEvent) => void;
+import { SisenseChartDataPointEventHandler, SisenseChartDataPointsEventHandler } from '../sisense-chart/types';
 export type HighchartsEventOptions = {
     chart: {
         zoomType?: string;
@@ -43,7 +20,7 @@ export type HighchartsEventOptions = {
     };
 };
 export declare const applyEventHandlersToChart: (chartOptions: HighchartsOptionsInternal, { onDataPointClick, onDataPointContextMenu, onDataPointsSelected, }?: {
-    onDataPointClick?: DataPointEventHandler | ScatterDataPointEventHandler | undefined;
-    onDataPointContextMenu?: DataPointEventHandler | ScatterDataPointEventHandler | undefined;
-    onDataPointsSelected?: DataPointsEventHandler | ScatterDataPointsEventHandler | undefined;
+    onDataPointClick?: SisenseChartDataPointEventHandler | undefined;
+    onDataPointContextMenu?: SisenseChartDataPointEventHandler | undefined;
+    onDataPointsSelected?: SisenseChartDataPointsEventHandler | undefined;
 }) => HighchartsOptionsInternal;

package/dist/chart-options-processor/boxplot-chart-options.d.ts

@@ -3,9 +3,9 @@ import { BoxplotChartData } from '../chart-data/types';
 import { BoxplotChartDataOptionsInternal } from '../chart-data-options/types';
 import { HighchartsOptionsInternal } from './chart-options-service';
 import { OptionsWithAlerts } from '../types';
-import { BoxplotChartDesignOptions } from './translations/design-options';
+import { ChartDesignOptions } from './translations/types';
 /**
  * Convert intermediate chart data, data options, and design options
  * into pure highcharts config data.
  */
-export declare const getBoxplotChartOptions: (chartData: BoxplotChartData, chartDesignOptions: BoxplotChartDesignOptions, dataOptions: BoxplotChartDataOptionsInternal, translate: TFunction) => OptionsWithAlerts<HighchartsOptionsInternal>;
+export declare const getBoxplotChartOptions: (chartData: BoxplotChartData, chartDesignOptions: ChartDesignOptions, dataOptions: BoxplotChartDataOptionsInternal, translate: TFunction) => OptionsWithAlerts<HighchartsOptionsInternal>;

package/dist/chart-options-processor/category-chart-options.d.ts

@@ -9,7 +9,7 @@ import { ChartDataOptionsInternal } from '../chart-data-options/types';
  *
  * @param chartData - the data for the chart in an intermediate format
  * @param chartType -
- * @param chartDesignOptions -
+ * @param globalDesignOptions -
  * @param dataOptions -
  * @param themeSettings -
  */

package/dist/chart-options-processor/chart-options-service.d.ts

@@ -63,9 +63,16 @@ type ChartPlotOptions = {
     shadow?: boolean;
     marker?: MarkerSettings;
     borderWidth?: number;
+    className?: string;
     events?: {
         legendItemClick?: SeriesLegendItemClickCallbackFunction;
     };
+    states?: {
+        inactive?: {
+            enabled?: boolean;
+            opacity?: number;
+        };
+    };
 };
 export type Stacking = 'normal' | 'percent';
 export type PlotOptions = {

package/dist/chart-options-processor/plot-bands.d.ts

@@ -1,7 +1,7 @@
 import { CartesianChartDataOptionsInternal, ChartDataOptionsInternal } from '../chart-data-options/types';
 import { ChartData } from '../chart-data/types';
 import { PlotBand } from './translations/axis-section';
-import { ChartDesignOptions } from './translations/types';
+import { DesignOptions } from './translations/types';
 type CategoryIndexMapPlotBands = {
     categories: string[];
     indexMap: number[];
@@ -19,5 +19,5 @@ export declare const applyNumberFormatToPlotBands: (chartDataOptions: ChartDataO
  * @param designOptions -
  * @param continuousDatetimeXAxis -
  */
-export declare const getCategoriesIndexMapAndPlotBands: (data: ChartData, dataOptions: CartesianChartDataOptionsInternal, designOptions: ChartDesignOptions, continuousDatetimeXAxis: boolean) => CategoryIndexMapPlotBands;
+export declare const getCategoriesIndexMapAndPlotBands: (data: ChartData, dataOptions: CartesianChartDataOptionsInternal, designOptions: DesignOptions, continuousDatetimeXAxis: boolean) => CategoryIndexMapPlotBands;
 export {};

package/dist/chart-options-processor/scatter-chart-options.d.ts

@@ -15,8 +15,8 @@ export declare const getScatterLegendSettings: (position: LegendPosition) => Leg
  *
  * @param chartData - the data for the chart in an intermediate format
  * @param chartType -
- * @param chartDesignOptions -
+ * @param globalDesignOptions -
  * @param dataOptions -
  * @param themeSettings -
  */
-export declare const getScatterChartOptions: (chartData: ScatterChartData, chartType: ChartType, chartDesignOptions: ChartDesignOptions, dataOptions: ChartDataOptionsInternal, themeSettings?: CompleteThemeSettings) => OptionsWithAlerts<HighchartsOptionsInternal>;
+export declare const getScatterChartOptions: (chartData: ScatterChartData, chartType: ChartType, designOptions: ChartDesignOptions, dataOptions: ChartDataOptionsInternal, themeSettings?: CompleteThemeSettings) => OptionsWithAlerts<HighchartsOptionsInternal>;

package/dist/chart-options-processor/style-to-design-options-translator/index.d.ts

@@ -0,0 +1 @@
+export { prepareChartDesignOptions } from './prepare-design-options';

package/dist/chart-options-processor/style-to-design-options-translator/prepare-design-options.d.ts

@@ -0,0 +1,4 @@
+import { ChartDataOptionsInternal } from '../../chart-data-options/types';
+import { ChartStyleOptions, ChartType } from '../../types';
+import { ChartDesignOptions } from '../translations/types';
+export declare function prepareChartDesignOptions(chartType: ChartType, dataOptionsInternal: ChartDataOptionsInternal, styleOptions?: ChartStyleOptions): ChartDesignOptions;

package/dist/chart-options-processor/style-to-design-options-translator/translate-style-to-design-options.d.ts

@@ -1,4 +1,4 @@
 import { ChartType, ChartStyleOptions } from '../../types';
-import { ChartDesignOptions } from '../translations/types';
+import { DesignOptions } from '../translations/types';
 import { ChartDataOptionsInternal } from '../../chart-data-options/types';
-export declare const translateStyleOptionsToDesignOptions: (chartType: ChartType, styleOptions: ChartStyleOptions, dataOptions: ChartDataOptionsInternal) => ChartDesignOptions;
+export declare const translateStyleOptionsToDesignOptions: (chartType: ChartType, styleOptions: ChartStyleOptions, dataOptions: ChartDataOptionsInternal) => DesignOptions;

package/dist/chart-options-processor/translations/base-design-options.d.ts

@@ -1,7 +1,7 @@
-import { ChartDesignOptions } from './types';
+import { DesignOptions } from './types';
 import { Merge } from '../../utils/utility-types';
 export declare const SERIES_CAPACITY = 50;
 export declare const SCATTER_CATEGORIES_CAPACITY = 500;
 export declare const CATEGORIES_CAPACITY = 100000;
-export declare const BaseDesignOptions: Merge<ChartDesignOptions>;
-export declare const BaseDesignOptionsMultipleAxis: ChartDesignOptions;
+export declare const BaseDesignOptions: Merge<DesignOptions>;
+export declare const BaseDesignOptionsMultipleAxis: DesignOptions;

package/dist/chart-options-processor/translations/boxplot/boxplot-plot-options.d.ts

@@ -1,3 +1,3 @@
 import { PlotOptions } from '../../chart-options-service.js';
-import { ValueLabel } from '../value-label-section.js';
-export declare const getBoxplotPlotOptions: (valueLabel: ValueLabel) => PlotOptions;
+import { ValueLabelOptions } from '../value-label-section.js';
+export declare const getBoxplotPlotOptions: (valueLabel: ValueLabelOptions) => PlotOptions;

package/dist/chart-options-processor/translations/design-options.d.ts

@@ -1,4 +1,4 @@
-import { ValueLabel } from './value-label-section';
+import { ValueLabelOptions } from './value-label-section';
 import { Axis } from './axis-section';
 import { Marker } from './marker-section';
 import { LegendPosition } from './legend-section';
@@ -13,7 +13,7 @@ type DataLimits = {
 };
 export type BaseDesignOptionsType = {
     legend: LegendPosition;
-    valueLabel: ValueLabel;
+    valueLabel: ValueLabelOptions;
     lineType: LineType;
     lineWidth: number;
     marker: Marker;
@@ -108,10 +108,12 @@ export type IndicatorComponents = {
  */
 export type IndicatorChartDesignOptions<IndicatorType extends IndicatorStyleType = IndicatorStyleType> = BaseDesignOptionsType & {
     indicatorComponents: IndicatorComponents;
+    forceTickerView: boolean;
 } & (IndicatorType extends 'gauge' ? GaugeSpecificDesignOptions : NumericSpecificDesignOptions);
 export type GaugeSpecificDesignOptions = {
     indicatorType: 'gauge';
     skin: 1 | 2;
+    tickerBarHeight?: number;
 };
 export type NumericSpecificDesignOptions<NumericSubtype extends NumericIndicatorSubType = NumericIndicatorSubType> = {
     indicatorType: 'numeric';

package/dist/chart-options-processor/translations/number-format-config.d.ts

@@ -1,16 +1,10 @@
-export type DecimalScale = number | 'auto';
-export type NumberFormatConfig = {
-    name: 'Numbers' | 'Currency' | 'Percent';
-    decimalScale: DecimalScale;
-    trillion: boolean;
-    billion: boolean;
-    million: boolean;
-    kilo: boolean;
-    thousandSeparator: boolean;
-    prefix: boolean;
-    symbol: string;
-};
-export declare const defaultConfig: NumberFormatConfig;
-export declare const applyFormatStaticMarkup: (config: NumberFormatConfig, value: number) => string;
-export declare const applyFormat: (config: NumberFormatConfig, value: number) => string;
-export declare const applyFormatPlainText: (config: NumberFormatConfig, value: number) => string;
+import { CompleteNumberFormatConfig, NumberFormatConfig } from '../../types';
+/**
+ * Returns a complete NumberFormatConfig object with default values for missing properties.
+ *
+ * @param partialConfig - A partial NumberFormatConfig object with props to rewrite default ones.
+ */
+export declare const getCompleteNumberFormatConfig: (partialConfig?: NumberFormatConfig) => CompleteNumberFormatConfig;
+export declare const applyFormatStaticMarkup: (config: CompleteNumberFormatConfig, value: number) => string;
+export declare const applyFormat: (config: CompleteNumberFormatConfig, value: number) => string;
+export declare const applyFormatPlainText: (config: CompleteNumberFormatConfig, value: number) => string;

package/dist/chart-options-processor/translations/translations-to-highcharts.d.ts

@@ -4,7 +4,7 @@ import { CategoricalSeriesValues, ChartData, CartesianChartData } from '../../ch
 import { StackableChartDesignOptions } from './design-options';
 import { AxisMinMax, AxisSettings } from './axis-section';
 import { Stacking } from '../chart-options-service';
-import { ChartDesignOptions } from './types';
+import { DesignOptions } from './types';
 export type LineType = 'straight' | 'smooth';
 export type StackType = 'classic' | 'stacked' | 'stack100';
 export type HighchartsType = ChartType | 'spline' | 'areaspline' | 'bubble';
@@ -48,10 +48,10 @@ export type AxisClipped = {
  * Translate public-facing chart type and chart design options to internal highcharts chart type
  *
  * @param chartType - public-facing chart type
- * @param chartDesignOptions - public-facing chart design options
+ * @param designOptions - public-facing chart design options
  * @returns internal highcharts chart type
  */
-export declare const determineHighchartsChartType: (chartType: ChartType, chartDesignOptions: ChartDesignOptions) => HighchartsType;
+export declare const determineHighchartsChartType: (chartType: ChartType, designOptions: DesignOptions) => HighchartsType;
 export declare const addStackingIfSpecified: (chartType: ChartType, designOptions: StackableChartDesignOptions) => {
     stacking?: Stacking | undefined;
     showTotal: boolean;
@@ -76,7 +76,7 @@ export declare const adjustMinWhenColumnBar: (chartType: ChartType, autoMinMax:
     min: number;
     max: number;
 };
-export declare const autoCalculateYAxisMinMax: (chartType: ChartType, chartData: CartesianChartData, chartDesignOptions: ChartDesignOptions, yAxisSide: number[], yTreatNullDataAsZeros: boolean[], side: number) => {
+export declare const autoCalculateYAxisMinMax: (chartType: ChartType, chartData: CartesianChartData, designOptions: DesignOptions, yAxisSide: number[], yTreatNullDataAsZeros: boolean[], side: number) => {
     min: number;
     max: number;
 };

package/dist/chart-options-processor/translations/types.d.ts

@@ -1,4 +1,3 @@
-import { ChartDataOptionsInternal } from '../../chart-data-options/types';
 import { ChartType } from '../../types';
 import { LineChartDesignOptions, AreaChartDesignOptions, BarChartDesignOptions, ColumnChartDesignOptions, PieChartDesignOptions, FunnelChartDesignOptions, IndicatorChartDesignOptions, PolarChartDesignOptions, ScatterChartDesignOptions, TreemapChartDesignOptions, BoxplotChartDesignOptions, AreamapChartDesignOptions, ScattermapChartDesignOptions } from './design-options';
 export declare const POLAR_CHART_TYPES: readonly ["polar"];
@@ -30,12 +29,25 @@ export declare const SCATTERMAP_CHART_TYPES: readonly ["scattermap"];
 /** Scattermap chart types  @expandType */
 export type ScattermapChartType = (typeof SCATTERMAP_CHART_TYPES)[number];
 export type ChartDataType = 'cartesian' | 'categorical' | 'scatter' | 'table' | 'indicator' | 'areamap';
-export type ChartDesignOptions = LineChartDesignOptions | AreaChartDesignOptions | BarChartDesignOptions | ColumnChartDesignOptions | PieChartDesignOptions | FunnelChartDesignOptions | PolarChartDesignOptions | IndicatorChartDesignOptions | ScatterChartDesignOptions | TreemapChartDesignOptions | BoxplotChartDesignOptions | AreamapChartDesignOptions | ScattermapChartDesignOptions;
-export type ChartConfig = {
-    chartType: ChartType;
-    dataOptions: ChartDataOptionsInternal;
-    designOptions: ChartDesignOptions;
+/**
+ * Design options for a specific chart type
+ */
+export type DesignOptions<SpecificChartType extends ChartType = ChartType> = SpecificChartType extends 'line' ? LineChartDesignOptions : SpecificChartType extends 'area' ? AreaChartDesignOptions : SpecificChartType extends 'bar' ? BarChartDesignOptions : SpecificChartType extends 'column' ? ColumnChartDesignOptions : SpecificChartType extends 'pie' ? PieChartDesignOptions : SpecificChartType extends 'funnel' ? FunnelChartDesignOptions : SpecificChartType extends 'polar' ? PolarChartDesignOptions : SpecificChartType extends 'indicator' ? IndicatorChartDesignOptions : SpecificChartType extends 'scatter' ? ScatterChartDesignOptions : SpecificChartType extends 'treemap' ? TreemapChartDesignOptions : SpecificChartType extends 'boxplot' ? BoxplotChartDesignOptions : SpecificChartType extends 'areamap' ? AreamapChartDesignOptions : SpecificChartType extends 'scattermap' ? ScattermapChartDesignOptions : never;
+/** A unique identifier for a series to be found in {@link ChartDataOptionsInternal} */
+type SeriesId = string;
+/**
+ * Design options for a chart.
+ * This includes global design options and specific design options per series.
+ */
+export type ChartDesignOptions<SpecificChartType extends ChartType = ChartType> = {
+    globalDesign: DesignOptions<SpecificChartType>;
+    designPerSeries: Record<SeriesId, SeriesDesignOptions>;
 };
+/**
+ * Design options, limited to the only series relevant options.
+ * @internal
+ */
+export type SeriesDesignOptions = Pick<DesignOptions, 'lineWidth' | 'marker'>;
 export declare const isCartesian: (chartType: ChartType) => chartType is "area" | "line" | "bar" | "column" | "polar";
 export declare const isCategorical: (chartType: ChartType) => chartType is "pie" | "funnel" | "treemap" | "sunburst";
 export declare const isScatter: (chartType: ChartType) => chartType is "scatter";

package/dist/chart-options-processor/translations/value-label-section.d.ts

@@ -1,10 +1,14 @@
 import type { DataLabelsOptions } from '@sisense/sisense-charts';
 import { Style } from '../chart-options-service';
-import { NumberFormatConfig } from './number-format-config';
 import { AxisOrientation } from './axis-section';
 import { InternalSeries } from './tooltip-utils';
 import { PolarType } from './design-options';
-export type ValueLabel = 'horizontal' | 'diagonal' | 'vertical' | null;
+import { NumberFormatConfig } from '../../types';
+export type ValueLabelOptions = {
+    enabled?: boolean;
+    rotation?: number;
+};
+export type RotationType = 'horizontal' | 'diagonal' | 'vertical';
 export type ValueLabelSettings = {
     enabled?: boolean;
     align?: string;
@@ -25,5 +29,6 @@ export type ValueLabelSettings = {
     formatter?: (this: InternalSeries, options?: DataLabelsOptions, valuePropName?: string) => string;
 };
 export declare const createValueLabelFormatter: (numberFormatConfig?: NumberFormatConfig) => (this: InternalSeries) => string;
-export declare const getValueLabelSettings: (xAxisOrientation: AxisOrientation, valueLabel: ValueLabel, inside?: boolean) => ValueLabelSettings;
-export declare const getPolarValueLabelSettings: (valueLabel: ValueLabel, polarType: PolarType) => ValueLabelSettings;
+export declare const getRotationType: (rotation: number) => RotationType;
+export declare const getValueLabelSettings: (xAxisOrientation: AxisOrientation, valueLabel: ValueLabelOptions, inside?: boolean) => ValueLabelSettings;
+export declare const getPolarValueLabelSettings: (valueLabel: ValueLabelOptions, polarType: PolarType) => ValueLabelSettings;

package/dist/charts/indicator/indicator-legacy-chart-options/indicator-legacy-chart-options.d.ts

@@ -9,8 +9,11 @@ export type ChartRenderingOptions = {
 };
 export type IndicatorTypeOptions = {
     type: Exclude<IndicatorStyleType, 'numeric'>;
+    forceTickerView: boolean;
+    tickerBarHeight?: number;
 } | {
     type: 'numeric';
     numericSubtype?: NumericIndicatorSubType;
+    forceTickerView: boolean;
 };
 export declare const createIndicatorLegacyChartOptions: (typeOptions: IndicatorTypeOptions, chartRenderingOptions: ChartRenderingOptions) => LegacyIndicatorChartOptions;

package/dist/charts/indicator/indicator-legacy-chart-options/prepare-ticker-options.d.ts

@@ -0,0 +1,2 @@
+import { LegacyIndicatorChartOptions } from '../../../charts/indicator/types';
+export declare function prepareTickerOptions(container: HTMLElement, options: LegacyIndicatorChartOptions): import('../../../charts/indicator/types').TickerOptions;

package/dist/charts/indicator/types.d.ts

@@ -50,6 +50,7 @@ type CommonOptions = {
     };
     textKeys: string[];
     backgroundColor: string;
+    forceTickerView?: boolean;
 };
 export type NumericSimpleOptions = CommonOptions & {
     borderColor: string;
@@ -114,6 +115,7 @@ export type GaugeOptions = CommonOptions & {
     })[];
     gaugeHeights: BaseMeasure[];
     measureKeys: string[];
+    tickerBarHeight?: number;
 };
 export type TickerOptions = CommonOptions & {
     fontSize: number;