@sisense/sdk-ui 1.20.0 → 1.21.0

package/dist/packages/sdk-ui/src/ai/use-get-nlg-query-result.d.ts

@@ -38,6 +38,9 @@ export interface UseGetNlgQueryResultState {
     refetch: () => void;
 }
 /**
+ *
+ * @param params - {@link UseGetNlgQueryResultParams}
+ * @param enabled - boolean flag to enable/disable this hook
  * @internal
  */
 export declare const useGetNlgQueryResultInternal: (params: GetNlgQueryResultProps | GetNlgQueryResultRequest, enabled?: boolean) => UseGetNlgQueryResultState;
@@ -63,7 +66,6 @@ export declare const useGetNlgQueryResultInternal: (params: GetNlgQueryResultPro
  *
  * return <p>{data}</p>;
  * ```
- * @param params - {@link UseGetNlgQueryResultParams}
  * @returns Response object containing a text summary
  * @group Generative AI
  * @beta

package/dist/packages/sdk-ui/src/ai/use-get-query-recommendations.d.ts

@@ -29,6 +29,10 @@ export interface UseGetQueryRecommendationsState {
     /** Callback to trigger a refetch of the data */
     refetch: () => void;
 }
+/**
+ * @param params - {@link UseGetQueryRecommendationsParams}
+ * @internal
+ */
 export declare const useGetQueryRecommendationsInternal: (params: UseGetQueryRecommendationsParams) => UseGetQueryRecommendationsState;
 /**
  * React hook that fetches recommended questions for a data model or perspective.
@@ -57,7 +61,6 @@ export declare const useGetQueryRecommendationsInternal: (params: UseGetQueryRec
  *   </ul>
  * );
  * ```
- * @param params - {@link UseGetQueryRecommendationsParams}
  * @returns An array of objects, each containing recommended question text and its corresponding JAQL
  * @group Generative AI
  * @beta

package/dist/packages/sdk-ui/src/boxplot-utils.d.ts

@@ -18,7 +18,7 @@ export declare const boxWhiskerProcessResultInternal: (boxWhiskerData: QueryResu
  * @param {QueryResultData} outliersData - The data for the outliers.
  * @param {BoxplotChartCustomDataOptions} [dataOptions] - Optional data options for customizing data processing.
  * @returns {QueryResultData} The combined data with outliers included in the box whisker plot.
- * @group Chart Utilities
+ * @group Charts
  */
 export declare function boxWhiskerProcessResult(boxWhiskerData: QueryResultData, outliersData: QueryResultData, dataOptions?: BoxplotChartCustomDataOptions): QueryResultData;
 export declare const executeBoxplotQuery: ({ app, chartDataOptions, dataSource, attributes, measures, filters, highlights, }: {

package/dist/packages/sdk-ui/src/chart-data/advanced-analytics-data.d.ts

@@ -1,50 +1,14 @@
 import { DataTable } from '../chart-data-processor/table-processor';
 import { CartesianChartData } from './types';
-import { CartesianChartDataOptionsInternal } from '../chart-data-options/types';
+import { CartesianChartDataOptionsInternal, StyledMeasureColumn } from '../chart-data-options/types';
 export declare const isForecastChart: (dataOptions: CartesianChartDataOptionsInternal) => boolean;
 export declare const isTrendChart: (dataOptions: CartesianChartDataOptionsInternal) => boolean;
 export declare const createForecastDataOptions: (dataOptions: CartesianChartDataOptionsInternal) => {
-    rangeValues: {
-        title: string;
-        name: string;
-        aggregation?: string | undefined;
-        sortType?: import("@sisense/sdk-data").SortDirection | undefined;
-        showOnRightAxis?: boolean | undefined;
-        numberFormatConfig?: import("..").NumberFormatConfig | undefined;
-        chartType?: import("..").SeriesChartType | undefined;
-        color?: import("./data-coloring").DataColorOptions | undefined;
-        enabled?: boolean | undefined;
-        treatNullDataAsZeros?: boolean | undefined;
-        connectNulls?: boolean | undefined;
-        totalsCalculation?: import("@sisense/sdk-data").TotalsCalculation | undefined;
-        dataBars?: boolean | undefined;
-        forecast?: import("@sisense/sdk-data").ForecastFormulaOptions | undefined;
-        trend?: import("@sisense/sdk-data").TrendFormulaOptions | undefined;
-        width?: number | undefined;
-        seriesStyleOptions?: import("../chart-data-options/types").SeriesStyleOptions | undefined;
-    }[][];
-    seriesValues: import("../chart-data-options/types").Value[];
-    y: {
-        title: string;
-        name: string;
-        aggregation?: string | undefined;
-        sortType?: import("@sisense/sdk-data").SortDirection | undefined;
-        showOnRightAxis?: boolean | undefined;
-        numberFormatConfig?: import("..").NumberFormatConfig | undefined;
-        chartType?: import("..").SeriesChartType | undefined;
-        color?: import("./data-coloring").DataColorOptions | undefined;
-        enabled?: boolean | undefined;
-        treatNullDataAsZeros?: boolean | undefined;
-        connectNulls?: boolean | undefined;
-        totalsCalculation?: import("@sisense/sdk-data").TotalsCalculation | undefined;
-        dataBars?: boolean | undefined;
-        forecast?: import("@sisense/sdk-data").ForecastFormulaOptions | undefined;
-        trend?: import("@sisense/sdk-data").TrendFormulaOptions | undefined;
-        width?: number | undefined;
-        seriesStyleOptions?: import("../chart-data-options/types").SeriesStyleOptions | undefined;
-    }[];
-    x: import("../chart-data-options/types").Category[];
-    breakBy: import("../chart-data-options/types").Category[];
+    rangeValues: StyledMeasureColumn[][];
+    seriesValues: StyledMeasureColumn[];
+    y: StyledMeasureColumn[];
+    x: import("../chart-data-options/types").StyledColumn[];
+    breakBy: import("../chart-data-options/types").StyledColumn[];
     seriesToColorMap?: import("..").ValueToColorMap | undefined;
 };
 export declare const advancedAnalyticsData: (dataOptions: CartesianChartDataOptionsInternal, dataTable: DataTable) => CartesianChartData;

package/dist/packages/sdk-ui/src/chart-data/areamap-data.d.ts

@@ -1,4 +1,4 @@
 import { AreamapChartDataOptionsInternal } from '../chart-data-options/types.js';
 import { DataTable } from '../chart-data-processor/table-processor.js';
 import { AreamapData } from './types.js';
-export declare const getAreamapData: (chartDataOptions: AreamapChartDataOptionsInternal, dataTable: DataTable) => AreamapData;
+export declare const getAreamapData: (dataOptions: AreamapChartDataOptionsInternal, dataTable: DataTable) => AreamapData;

package/dist/packages/sdk-ui/src/chart-data/boxplot-data.d.ts

@@ -8,5 +8,5 @@ import { BoxplotChartDataOptionsInternal } from '../chart-data-options/types.js'
  * @param dataTable - Chart data table
  * @returns Box plot chart data
  */
-export declare const boxplotData: (chartDataOptions: BoxplotChartDataOptionsInternal, dataTable: DataTable) => BoxplotChartData;
+export declare const boxplotData: (dataOptions: BoxplotChartDataOptionsInternal, dataTable: DataTable) => BoxplotChartData;
 export declare function isBoxplotChartData(chartData: ChartData): chartData is BoxplotChartData;

package/dist/packages/sdk-ui/src/chart-data/cartesian-data.d.ts

@@ -1,7 +1,7 @@
 import { type SortDirection } from '../types';
 import { Column, DataTable } from '../chart-data-processor/table-processor';
 import { CartesianChartData, CategoricalXValues } from './types';
-import { CartesianChartDataOptionsInternal, Value } from '../chart-data-options/types';
+import { CartesianChartDataOptionsInternal, StyledMeasureColumn } from '../chart-data-options/types';
 export declare const validateCartesianChartDataOptions: (chartDataOptions: CartesianChartDataOptionsInternal) => CartesianChartDataOptionsInternal;
 /**
  * Creates cartesian data for chart like line/area/bar and others given table of data and options
@@ -10,6 +10,6 @@ export declare const validateCartesianChartDataOptions: (chartDataOptions: Carte
  * @param dataTable - Data table
  * @returns Cartesian chart data
  */
-export declare const cartesianData: (chartDataOptions: CartesianChartDataOptionsInternal, dataTable: DataTable) => CartesianChartData;
+export declare const cartesianData: (dataOptions: CartesianChartDataOptionsInternal, dataTable: DataTable) => CartesianChartData;
 export declare const sortDirection: (sortType: SortDirection | undefined) => 1 | -1 | 0;
-export declare const getOrderedXValues: (dataTable: DataTable, sortedMeasures: Value[], xColumns: Column[], rownumColumnName?: string) => CategoricalXValues[];
+export declare const getOrderedXValues: (dataTable: DataTable, sortedMeasures: StyledMeasureColumn[], xColumns: Column[], rownumColumnName?: string) => CategoricalXValues[];

package/dist/packages/sdk-ui/src/chart-data/categorical-data.d.ts

@@ -2,4 +2,4 @@ import { CategoricalChartDataOptionsInternal } from '../chart-data-options/types
 import { DataTable } from '../chart-data-processor/table-processor';
 import { CategoricalChartData } from './types';
 export declare const validateCategoricalChartDataOptions: (chartDataOptions: CategoricalChartDataOptionsInternal) => CategoricalChartDataOptionsInternal;
-export declare const categoricalData: (chartDataOptions: CategoricalChartDataOptionsInternal, dataTable: DataTable) => CategoricalChartData;
+export declare const categoricalData: (dataOptions: CategoricalChartDataOptionsInternal, dataTable: DataTable) => CategoricalChartData;

package/dist/packages/sdk-ui/src/chart-data/filter-and-aggregate-chart-data.d.ts

@@ -1,4 +1,4 @@
-import { Category, Value } from '../chart-data-options/types';
+import { CalculatedMeasureColumn, Column, MeasureColumn } from '@sisense/sdk-data';
 import { DataColumnNamesMapping } from '../chart-data-options/validate-data-options';
 import { DataTable } from '../chart-data-processor/table-processor';
-export declare const filterAndAggregateChartData: (sourceTable: DataTable, attributes: Category[], measures: Value[], dataColumnNamesMapping?: DataColumnNamesMapping) => DataTable;
+export declare const filterAndAggregateChartData: (sourceTable: DataTable, attributes: Column[], measures: (MeasureColumn | CalculatedMeasureColumn)[], dataColumnNamesMapping?: DataColumnNamesMapping) => DataTable;

package/dist/packages/sdk-ui/src/chart-data/indicator-data.d.ts

@@ -1,4 +1,4 @@
 import { DataTable } from '../chart-data-processor/table-processor';
 import { IndicatorChartDataOptionsInternal } from '../chart-data-options/types';
 import { IndicatorChartData } from './types';
-export declare const indicatorData: (chartDataOptions: IndicatorChartDataOptionsInternal, dataTable: DataTable) => IndicatorChartData;
+export declare const indicatorData: (dataOptions: IndicatorChartDataOptionsInternal, dataTable: DataTable) => IndicatorChartData;

package/dist/packages/sdk-ui/src/chart-data/range-data.d.ts

@@ -4,8 +4,8 @@ import { RangeChartDataOptionsInternal } from '../chart-data-options/types';
 /**
  * Creates data for range charts given chart data table and data options
  *
- * @param chartDataOptions - Data options for range charts
+ * @param dataOptions - Data options for range charts
  * @param dataTable - Chart data table
  * @returns range chart data
  */
-export declare const rangeData: (chartDataOptions: RangeChartDataOptionsInternal, dataTable: DataTable) => RangeChartData;
+export declare const rangeData: (dataOptions: RangeChartDataOptionsInternal, dataTable: DataTable) => RangeChartData;

package/dist/packages/sdk-ui/src/chart-data/scatter-data.d.ts

@@ -12,7 +12,7 @@ export interface DataOptionsIndexes {
 }
 export declare const buildCategories: (data: ScatterDataTable, axisColumnName: AxisColumnName) => string[];
 export declare const createCategoriesMap: (xCategories?: ScatterCategories, yCategories?: ScatterCategories) => ScatterAxisCategoriesMap;
-export declare const groupData: (chartDataOptions: ScatterChartDataOptionsInternal, dataTable: DataTable) => ScatterDataTable;
+export declare const groupData: (dataOptions: ScatterChartDataOptionsInternal, dataTable: DataTable) => ScatterDataTable;
 /**
  * Creates data for scatter charts given chart data table and data options
  *
@@ -20,4 +20,4 @@ export declare const groupData: (chartDataOptions: ScatterChartDataOptionsIntern
  * @param dataTable - Chart data table
  * @returns Scatter chart data
  */
-export declare const scatterData: (chartDataOptions: ScatterChartDataOptionsInternal, dataTable: DataTable) => ScatterChartData;
+export declare const scatterData: (dataOptions: ScatterChartDataOptionsInternal, dataTable: DataTable) => ScatterChartData;

package/dist/packages/sdk-ui/src/chart-data/scattermap-data.d.ts

@@ -1,4 +1,4 @@
 import { ScattermapChartDataOptionsInternal } from '../chart-data-options/types.js';
 import { DataTable } from '../chart-data-processor/table-processor.js';
 import { ScattermapChartData } from './types.js';
-export declare const scattermapData: (chartDataOptions: ScattermapChartDataOptionsInternal, dataTable: DataTable) => ScattermapChartData;
+export declare const scattermapData: (dataOptions: ScattermapChartDataOptionsInternal, dataTable: DataTable) => ScattermapChartData;

package/dist/packages/sdk-ui/src/chart-data/table-data.d.ts

@@ -1,6 +1,6 @@
 import { Column as DataTableColumn, DataTable } from '../chart-data-processor/table-processor';
-import { Category, TableDataOptionsInternal, Value } from '../chart-data-options/types';
-export declare const unifySortToDirection: (category: Category | Value) => number;
+import { StyledColumn, StyledMeasureColumn, TableDataOptionsInternal } from '../chart-data-options/types';
+export declare const unifySortToDirection: ({ column, sortType, }: StyledColumn | StyledMeasureColumn) => number;
 export declare const syncDataTableWithDataOptionsSort: (chartDataOptions: TableDataOptionsInternal, dataTable: DataTable) => DataTable;
 export declare const updateInnerDataOptionsSort: (dataOptions: TableDataOptionsInternal, sortColumn: DataTableColumn) => TableDataOptionsInternal;
 export declare const tableData: (chartDataOptions: TableDataOptionsInternal, dataTable: DataTable) => DataTable;

package/dist/packages/sdk-ui/src/chart-data-options/translate-boxplot-data-options.d.ts

@@ -1,7 +1,7 @@
 import { CalculatedMeasureColumn, Column, MeasureColumn } from '@sisense/sdk-data';
 import { BoxplotChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptionsInternal, StyledColumn, BoxWhiskerType, StyledMeasureColumn } from './types';
 export declare const generateBoxplotValues: (targetValue: Column | StyledColumn, boxType: BoxWhiskerType, outliersEnabled: boolean) => {
-    values: (MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn)[];
+    values: (StyledMeasureColumn | MeasureColumn | CalculatedMeasureColumn)[];
     outliers: Column | StyledColumn | undefined;
 };
 export declare const translateBoxplotDataOptions: (boxplotDataOptions: BoxplotChartDataOptions | BoxplotChartCustomDataOptions) => BoxplotChartDataOptionsInternal;

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

@@ -360,13 +360,6 @@ export interface AreamapChartDataOptions {
     /** Measure column (or measure) encoded by the color of the countries (or states) on the map. */
     color?: [MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn];
 }
-/**
- * Checks if the given argument is a measure column.
- *
- * @param arg
- * @internal
- */
-export declare function isMeasureColumn(arg: AnyColumn): arg is MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
 /**
  * Configuration for how to query data and assign data to Table.
  */
@@ -552,63 +545,47 @@ export type ChartDataOptions = RegularChartDataOptions | TabularChartDataOptions
  */
 export type RegularChartDataOptions = CartesianChartDataOptions | CategoricalChartDataOptions | ScatterChartDataOptions | IndicatorChartDataOptions | BoxplotChartDataOptions | BoxplotChartCustomDataOptions | AreamapChartDataOptions | ScattermapChartDataOptions | RangeChartDataOptions;
 /** @internal */
-export interface Category extends CategoryStyle {
-    name: string;
-    type: string;
-    title?: string;
-}
-/** @internal */
-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, SeriesStyle {
-    name: string;
-    aggregation?: string;
-    title: string;
-}
-/** @internal */
 export interface CartesianChartDataOptionsInternal {
-    x: Category[];
-    y: Value[];
-    breakBy: Category[];
+    x: StyledColumn[];
+    y: StyledMeasureColumn[];
+    breakBy: StyledColumn[];
     seriesToColorMap?: ValueToColorMap;
 }
 /** @internal */
 export interface CategoricalChartDataOptionsInternal {
-    y: Value[];
-    breakBy: Category[];
+    y: StyledMeasureColumn[];
+    breakBy: StyledColumn[];
     seriesToColorMap?: ValueToColorMap | MultiColumnValueToColorMap;
 }
 /** @internal */
 export interface ScatterChartDataOptionsInternal {
-    x?: Value | Category;
-    y?: Value | Category;
-    breakByPoint?: Category;
-    breakByColor?: Category | Value;
-    size?: Value;
+    x?: StyledColumn | StyledMeasureColumn;
+    y?: StyledColumn | StyledMeasureColumn;
+    breakByPoint?: StyledColumn;
+    breakByColor?: StyledColumn | StyledMeasureColumn;
+    size?: StyledMeasureColumn;
     seriesToColorMap?: ValueToColorMap;
 }
 /** @internal */
 export interface ScattermapChartDataOptionsInternal {
-    locations: Category[];
-    size?: Value;
-    colorBy?: Value;
-    details?: Category | Value;
+    locations: StyledColumn[];
+    size?: StyledMeasureColumn;
+    colorBy?: StyledMeasureColumn;
+    details?: StyledColumn | StyledMeasureColumn;
     locationLevel: ScattermapLocationLevel;
 }
 /** @internal */
 export type RangeChartDataOptionsInternal = {
-    x: Category[];
-    rangeValues: Value[][];
-    seriesValues: Value[];
-    breakBy: Category[];
-    y: Value[];
+    x: StyledColumn[];
+    y: StyledMeasureColumn[];
+    breakBy: StyledColumn[];
     seriesToColorMap?: ValueToColorMap | MultiColumnValueToColorMap;
+    rangeValues: StyledMeasureColumn[][];
+    seriesValues: StyledMeasureColumn[];
 };
 /** @internal */
 export type TableDataOptionsInternal = {
-    columns: (Category | Value)[];
+    columns: (StyledColumn | StyledMeasureColumn)[];
 };
 /**
  * @internal
@@ -619,19 +596,19 @@ export interface PivotTableDataOptionsInternal {
      *
      * @category Data Options
      */
-    rows?: Category[];
+    rows?: StyledColumn[];
     /**
      * Dimensions for the columns of the pivot table
      *
      * @category Data Options
      */
-    columns?: Category[];
+    columns?: StyledColumn[];
     /**
      * Measures for the values of the pivot table
      *
      * @category Data Options
      */
-    values?: Value[];
+    values?: StyledMeasureColumn[];
     /**
      * Options for grand totals
      *
@@ -643,25 +620,25 @@ export interface PivotTableDataOptionsInternal {
 export type ChartDataOptionsInternal = CartesianChartDataOptionsInternal | CategoricalChartDataOptionsInternal | ScatterChartDataOptionsInternal | IndicatorChartDataOptionsInternal | BoxplotChartDataOptionsInternal | AreamapChartDataOptionsInternal | ScattermapChartDataOptionsInternal | RangeChartDataOptionsInternal;
 /** @internal */
 export type IndicatorChartDataOptionsInternal = {
-    min?: Value[];
-    max?: Value[];
-    value?: Value[];
-    secondary?: Value[];
+    value?: StyledMeasureColumn[];
+    secondary?: StyledMeasureColumn[];
+    min?: StyledMeasureColumn[];
+    max?: StyledMeasureColumn[];
 };
 /** @internal */
 export interface BoxplotChartDataOptionsInternal {
-    category?: Category;
-    boxMin: Value;
-    boxMedian: Value;
-    boxMax: Value;
-    whiskerMin: Value;
-    whiskerMax: Value;
-    outliersCount: Value;
-    outliers?: Category;
+    category?: StyledColumn;
+    boxMin: StyledMeasureColumn;
+    boxMedian: StyledMeasureColumn;
+    boxMax: StyledMeasureColumn;
+    whiskerMin: StyledMeasureColumn;
+    whiskerMax: StyledMeasureColumn;
+    outliersCount: StyledMeasureColumn;
+    outliers?: StyledColumn;
     valueTitle: string;
 }
 /** @internal */
 export type AreamapChartDataOptionsInternal = {
-    geo: Category;
-    color?: Value;
+    geo: StyledColumn;
+    color?: StyledMeasureColumn;
 };

package/dist/packages/sdk-ui/src/chart-data-options/utils.d.ts

@@ -1,6 +1,17 @@
 import { Attribute, CalculatedMeasureColumn, Column, Measure, MeasureColumn } from '@sisense/sdk-data';
-import { Category, Value, StyledColumn, StyledMeasureColumn, AnyColumn, CategoryStyle } from './types';
+import { StyledColumn, StyledMeasureColumn, AnyColumn, CategoryStyle, ValueStyle } from './types';
 type AnyObject = Record<string, any>;
+/**
+ * Combines the properties of two objects, where:
+ *  - properties from "sourceToInherit" will be inherited by the result object.
+ *  - properties from "sourceToAbsorb" will be copied into the result object.
+ * Properties from "sourceToAbsorb" will safely override properties with the same name from "sourceToInherit" without modifying the original object.
+ *
+ * @param sourceToInherit - The object whose properties will be inherited.
+ * @param sourceToAbsorb - The object whose properties will be copied as own properties.
+ * @returns - A new object that combines the properties of the two input objects.
+ */
+export declare const safeMerge: <T extends AnyObject, S extends AnyObject>(sourceToInherit: T, sourceToAbsorb: S) => T & S;
 /**
  * Combines two objects into a single one with saving prototype inheritance of "sourceWithInheritance" argument
  *
@@ -9,30 +20,31 @@ type AnyObject = Record<string, any>;
  * @returns - A new object that combines the properties of the two input objects.
  */
 export declare const safeCombine: <T extends AnyObject>(sourceWithInheritance: T, sourceToAbsorb: AnyObject) => T;
-export declare const splitColumn: (c: StyledColumn | Column) => {
-    column: Column;
-    style: CategoryStyle | undefined;
+export declare const splitColumn: <C extends AnyColumn>(targetColumn: C) => {
+    column: Column | MeasureColumn | CalculatedMeasureColumn;
+    style: CategoryStyle | ValueStyle;
+} | {
+    column: C;
+    style: CategoryStyle | ValueStyle;
 };
-export declare const translateColumnToCategory: (c: StyledColumn | Column) => Category;
-export declare const translateColumnToValue: (c: MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn) => Value;
-export declare const translateColumnToCategoryOrValue: (value: AnyColumn) => Value | Category;
-export declare const translateMeasureToValue: (measure: Measure) => Value;
-export declare const translateAttributeToCategory: (attribute: Attribute) => Category;
-export declare const translateValueToMeasure: (value: Value) => Measure;
-export declare const translateCategoryToAttribute: (category: Category) => Attribute;
-export declare const getDataOptionTitle: (option: Category | Value) => string;
-export declare const translateColumnToAttribure: (c: StyledColumn | Column) => Attribute;
+/**
+ * Checks if the given argument is a measure column.
+ *
+ * @param arg
+ * @internal
+ */
+export declare function isMeasureColumn(arg: AnyColumn): arg is MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
+export declare const getDataOptionTitle: ({ column }: StyledColumn | StyledMeasureColumn) => string;
+export declare const getDataOptionGranularity: ({ column, granularity }: StyledColumn) => string;
+export declare const translateColumnToAttribute: (c: Column | StyledColumn) => Attribute;
 export declare const translateColumnToMeasure: (c: MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn) => Measure;
-export declare const translateCategoryOrValueToColumn: <Source extends Value | Category, Target extends AnyColumn>(option: Source) => Target;
-export declare const translateCategoryToColumn: (option: Category) => Column | StyledColumn;
-export declare const translateValueToColumn: (option: Value) => MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
 /**
- * Checks if category is a StyledColumns.
+ * Checks if column is a StyledColumns.
  *
- * @param category - The category to check.
+ * @param category - The target column to check.
  * @internal
  */
-export declare function isStyledColumn(category: Column | StyledColumn): category is StyledColumn;
+export declare function isStyledColumn(targetColumn: AnyColumn): targetColumn is StyledColumn | StyledMeasureColumn;
 /**
  * Checks if an category is a StyledCategory.
  *
@@ -40,4 +52,7 @@ export declare function isStyledColumn(category: Column | StyledColumn): categor
  * @internal
  */
 export declare function isCategoryStyle(category: Column | CategoryStyle): category is CategoryStyle;
+export declare function normalizeColumn(targetColumn: Column | StyledColumn): StyledColumn;
+export declare function normalizeMeasureColumn(targetColumn: MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn): StyledMeasureColumn;
+export declare function normalizeAnyColumn(targetColumn: AnyColumn): StyledColumn | StyledMeasureColumn;
 export {};

package/dist/packages/sdk-ui/src/chart-data-options/validate-data-options/validate-data-options.d.ts

@@ -1,4 +1,4 @@
-import { ChartDataOptions, ChartDataOptionsInternal, Value } from '../types';
+import { ChartDataOptions, ChartDataOptionsInternal } from '../types';
 import { ChartType } from '../../types';
 import { Attribute, Data, Filter, Measure } from '@sisense/sdk-data';
 import { DataTable } from '../../chart-data-processor/table-processor';
@@ -9,7 +9,7 @@ export type DataColumnNamesMapping = Record<string, string>;
  * @param measures - An array of Value objects representing measures.
  * @returns - The mapping of unique names to original names.
  */
-export declare const generateUniqueDataColumnsNames: (measures: Value[]) => DataColumnNamesMapping;
+export declare const generateUniqueDataColumnsNames: (measures: Measure[]) => DataColumnNamesMapping;
 /**
  * Applies default chart data options based on input chart type.
  */

package/dist/packages/sdk-ui/src/chart-options-processor/data-points.d.ts

@@ -1,10 +1,11 @@
+import { Measure } from '@sisense/sdk-data';
 import { HighchartsPoint } from '../types';
 import { SisenseChartDataPoint } from '../sisense-chart/types';
-import { Category, ChartDataOptionsInternal, Value } from '..';
-export declare function getDataPointMetadata(dataOptionPath: string, dataOption: Category | Value): {
-    measure?: import("@sisense/sdk-data").Measure | undefined;
+import { ChartDataOptionsInternal, StyledColumn, StyledMeasureColumn } from '..';
+export declare function getDataPointMetadata(dataOptionPath: string, dataOption: StyledColumn | StyledMeasureColumn): {
+    measure?: Measure | undefined;
     attribute?: import("@sisense/sdk-data").Attribute | undefined;
     id: string;
-    dataOption: import("..").AnyColumn;
+    dataOption: StyledColumn | StyledMeasureColumn;
 };
 export declare function getDataPoint(point: HighchartsPoint, dataOptions: ChartDataOptionsInternal): SisenseChartDataPoint;

package/dist/packages/sdk-ui/src/chart-options-processor/plot-bands.d.ts

@@ -7,7 +7,7 @@ type CategoryIndexMapPlotBands = {
     indexMap: number[];
     plotBands: PlotBand[];
 };
-export declare const applyNumberFormatToPlotBands: (chartDataOptions: ChartDataOptionsInternal, categoryIndexMapPlotBands: CategoryIndexMapPlotBands) => CategoryIndexMapPlotBands;
+export declare const applyNumberFormatToPlotBands: (dataOptions: ChartDataOptionsInternal, categoryIndexMapPlotBands: CategoryIndexMapPlotBands) => CategoryIndexMapPlotBands;
 /**
  * This method returns three arrays to create chart options
  * categories - values to display on the bottom X1 axis

package/dist/packages/sdk-ui/src/chart-options-processor/translations/axis-section.d.ts

@@ -1,5 +1,5 @@
 import { Stacking, Style } from '../chart-options-service';
-import { ChartDataOptionsInternal, Category } from '../../chart-data-options/types';
+import { ChartDataOptionsInternal, StyledColumn } from '../../chart-data-options/types';
 import { ChartType } from '../../types';
 import { CategoricalXValues } from '../../chart-data/types';
 import { AxisClipped } from './translations-to-highcharts';
@@ -102,7 +102,7 @@ export type AxisPlotBand = {
 };
 export declare const getCategoricalCompareValue: (value: CategoricalXValues) => number;
 export declare const getDefaultDateFormat: (granularity?: string) => "HH:mm:ss" | "yyyy" | "yyyy Q" | "MM/yyyy" | "ww yyyy" | "M/d/yy" | "HH" | "M/d/yy HH" | "HH:mm" | undefined;
-export declare const getDateFormatter: (category: Category, dateFormatter?: ((date: Date, format: string) => string) | undefined) => (time: number) => string;
-export declare const getXAxisDatetimeSettings: (axis: Axis, category: Category, values: number[], dateFormatter?: ((date: Date, format: string) => string) | undefined) => AxisSettings[];
-export declare const getXAxisSettings: (axis: Axis, axis2: Axis | undefined, categories: string[], plotBands: PlotBand[], xAxisOrientation: AxisOrientation, chartDataOptions: ChartDataOptionsInternal, chartType: ChartType) => AxisSettings[];
-export declare const getYAxisSettings: (axis: Axis, axis2: Axis | undefined, axisMinMax: AxisMinMax, axis2MinMax: AxisMinMax | undefined, showTotal: boolean, chartDataOptions: ChartDataOptionsInternal, stacking: Stacking | undefined) => [AxisSettings[], AxisClipped[]];
+export declare const getDateFormatter: (category: StyledColumn, dateFormatter?: ((date: Date, format: string) => string) | undefined) => (time: number) => string;
+export declare const getXAxisDatetimeSettings: (axis: Axis, category: StyledColumn, values: number[], dateFormatter?: ((date: Date, format: string) => string) | undefined) => AxisSettings[];
+export declare const getXAxisSettings: (axis: Axis, axis2: Axis | undefined, categories: string[], plotBands: PlotBand[], xAxisOrientation: AxisOrientation, dataOptions: ChartDataOptionsInternal, chartType: ChartType) => AxisSettings[];
+export declare const getYAxisSettings: (axis: Axis, axis2: Axis | undefined, axisMinMax: AxisMinMax, axis2MinMax: AxisMinMax | undefined, showTotal: boolean, dataOptions: ChartDataOptionsInternal, stacking: Stacking | undefined) => [AxisSettings[], AxisClipped[]];

package/dist/packages/sdk-ui/src/chart-options-processor/translations/boxplot/boxplot-axis.d.ts

@@ -1,10 +1,10 @@
 import { BoxplotChartData } from '../../../chart-data/types';
 import { Axis, AxisSettings } from '../axis-section';
-import { Value, type Category } from '../../../chart-data-options/types';
+import { StyledColumn, StyledMeasureColumn } from '../../../chart-data-options/types';
 export declare const commonColor = "#d1d1d7";
 export declare const calculateYAxisMinMax: (chartData: BoxplotChartData) => {
     min: number;
     max: number;
 };
-export declare const getBoxplotXAxisSettings: (axis: Axis, categories: string[], axisDataOption?: Category) => AxisSettings[];
-export declare const getBoxplotYAxisSettings: (axis: Axis, chartData: BoxplotChartData, axisDataOption?: Value) => AxisSettings[];
+export declare const getBoxplotXAxisSettings: (axis: Axis, categories: string[], axisDataOption?: StyledColumn) => AxisSettings[];
+export declare const getBoxplotYAxisSettings: (axis: Axis, chartData: BoxplotChartData, axisDataOption?: StyledMeasureColumn) => AxisSettings[];

package/dist/packages/sdk-ui/src/chart-options-processor/translations/scatter-axis.d.ts

@@ -1,7 +1,7 @@
 import { ScatterCategories } from '../../chart-data/types';
-import { ScatterChartDataOptionsInternal, Category, Value } from './../../chart-data-options/types';
+import { ScatterChartDataOptionsInternal, StyledColumn, StyledMeasureColumn } from './../../chart-data-options/types';
 import { Axis, AxisSettings } from './axis-section';
 export declare const commonColor = "#d1d1d7";
-export declare function scatterFormatter(axisAttribute: Category | Value | undefined, value: string | number, categories: (string | number)[] | undefined): string;
+export declare function scatterFormatter(axisAttribute: StyledColumn | StyledMeasureColumn | undefined, value: string | number, categories: (string | number)[] | undefined): string;
 export declare const getScatterXAxisSettings: (xAxis: Axis, categories: ScatterCategories, scatterDataOptions: ScatterChartDataOptionsInternal) => AxisSettings[];
 export declare const getScatterYAxisSettings: (yAxis: Axis, categories: ScatterCategories, scatterDataOptions: ScatterChartDataOptionsInternal) => AxisSettings[];

package/dist/packages/sdk-ui/src/chart-options-processor/translations/tooltip-utils.d.ts

@@ -1,8 +1,8 @@
-import { Category, Value } from '../../chart-data-options/types.js';
-export declare const isXValueNumeric: (dataOptionX: Value | Category | undefined) => boolean | "";
-export declare const formatTooltipValue: (dataOption: Value | Category | undefined, value: number | undefined, displayValue: string) => string;
-export declare const formatTooltipXValue: (dataOption: Value | Category | undefined, value: number | string | undefined, displayValue: string) => string;
-export declare function isTooltipPercentValueSupported(options: Value | undefined): boolean;
+import { StyledMeasureColumn, StyledColumn } from '../../chart-data-options/types.js';
+export declare const isXValueNumeric: (dataOptionX: StyledMeasureColumn | StyledColumn | undefined) => boolean | "";
+export declare const formatTooltipValue: (dataOption: StyledMeasureColumn | StyledColumn | undefined, value: number | undefined, displayValue: string) => string;
+export declare const formatTooltipXValue: (dataOption: StyledMeasureColumn | StyledColumn | undefined, value: number | string | undefined, displayValue: string) => string;
+export declare function isTooltipPercentValueSupported(options: StyledMeasureColumn | undefined): boolean;
 export type TooltipSettings = {
     enabled?: boolean;
     animation?: boolean;

package/dist/packages/sdk-ui/src/charts/indicator/indicator-legacy-chart-data-options.d.ts

@@ -3,7 +3,7 @@ import { IndicatorChartDesignOptions } from '../../chart-options-processor/trans
 import { IndicatorChartData } from '../../chart-data/types';
 import { LegacyIndicatorChartTypes } from './types';
 export type IndicatorLegacyChartDataOptions = ReturnType<typeof createLegacyChartDataOptions>;
-export declare const createLegacyChartDataOptions: (chartData: IndicatorChartData, chartDesignOptions: IndicatorChartDesignOptions, chartDataOptions: IndicatorChartDataOptions) => {
+export declare const createLegacyChartDataOptions: (chartData: IndicatorChartData, chartDesignOptions: IndicatorChartDesignOptions, dataOptions: IndicatorChartDataOptions) => {
     type: LegacyIndicatorChartTypes;
     skin: 1 | 2 | "vertical" | "horizontal";
     title: {

package/dist/packages/sdk-ui/src/common/hooks/use-fetch.d.ts

@@ -16,7 +16,7 @@ export type RequestConfig = {
  * The result of the `useFetch` hook.
  * Return value of the `useQuery` hook from `@tanstack/react-query`.
  *
- * @link https://tanstack.com/query/v4/docs/framework/react/reference/useQuery
+ * @see https://tanstack.com/query/v4/docs/framework/react/reference/useQuery
  * @template TData - The type of the data returned by the fetch request
  * @template TError - The type of the error returned by the fetch request
  */
@@ -30,9 +30,6 @@ export type UseQueryResult<TData, TError> = TanstackUseQueryResult<TData, TError
     method: 'POST',
   });
  ```
- * @param path - The endpoint path to fetch data from. This should be a relative path like '/api/v1/endpoint'.
- * @param init - The request init object
- * @param options - The additional request options
  * @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
  * @group Fusion Embed
  */

package/dist/packages/sdk-ui/src/dashboard/components/HorizontalCollapse.d.ts

@@ -0,0 +1,5 @@
+import { ReactNode } from 'react';
+export declare const HorizontalCollapse: ({ collapsedOnInit, children, }: {
+    collapsedOnInit?: boolean | undefined;
+    children: ReactNode;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/dashboard/components/dashboard-header.d.ts

@@ -1,2 +1,3 @@
 import { DashboardHeaderProps } from '../../dashboard/types';
+export declare const DASHBOARD_HEADER_HEIGHT = 48;
 export declare const DashboardHeader: ({ title }: DashboardHeaderProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -22,6 +22,10 @@ import { DashboardByIdProps } from './types';
 
   export default CodeExample;
  * ```
+ *
+ * To learn more about this and related dashboard components,
+ * see [Embedded Dashboards](/guides/sdk/guides/dashboards/index.html).
+ *
  * @group Fusion Embed
  * @fusionEmbed
  * @beta