@sisense/sdk-ui 0.12.1 → 0.14.0

package/dist/indicator-chart.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { IndicatorChartProps } from './props';
 /**
- * A React component that displays a single value.
+ * A React component that provides various options for displaying one or two numeric values as a number, gauge or ticker.
  * See [Indicator](https://docs.sisense.com/main/SisenseLinux/indicator.htm) for more information.
  *
  * @example

package/dist/models/dashboard/use-get-dashboard-model.d.ts

@@ -97,3 +97,8 @@ export type DashboardModelSuccessState = {
  * @returns Dashboard load state that contains the status of the execution, the result dashboard model, or the error if any
  */
 export declare const useGetDashboardModel: (params: GetDashboardModelParams) => DashboardModelState;
+/**
+ * {@link useGetDashboardModel} without tracking to be used inside other hooks or components in Compose SDK.
+ * @internal
+ */
+export declare function useGetDashboardModelInternal(params: GetDashboardModelParams): DashboardModelState;

package/dist/models/dashboard/use-get-dashboard-models.d.ts

@@ -81,4 +81,9 @@ export type DashboardModelsSuccessState = {
  * @param params - Parameters of the dashboards to be retrieved
  * @returns Load state that contains the status of the execution, the result dashboards, or the error if any
  */
-export declare const useGetDashboardModels: (params?: GetDashboardModelsParams) => DashboardModelsState;
+export declare const useGetDashboardModels: (params?: GetDashboardModelsParams | undefined) => DashboardModelsState;
+/**
+ * {@link useGetDashboardModels} without tracking to be used inside other hooks or components in Compose SDK.
+ * @internal
+ */
+export declare function useGetDashboardModelsInternal(params?: GetDashboardModelsParams): DashboardModelsState;

package/dist/no-results-overlay/images/index.d.ts

@@ -1,2 +1,2 @@
 import { ChartType, TableType } from '../../types';
-export declare function getNoResultOverlayImage(type: ChartType | TableType): string;
+export declare function getNoResultOverlayImage(type: ChartType | TableType): any;

package/dist/pie-chart.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { PieChartProps } from './props';
 /**
- * A React component representing data in circular graph with the data shown as slices of a whole,
+ * A React component representing data in a circular graph with the data shown as slices of a whole,
  * with each slice representing a proportion of the total.
  * See [Pie Chart](https://docs.sisense.com/main/SisenseLinux/pie-chart.htm) for more information.
  *

package/dist/props.d.ts

@@ -1,5 +1,5 @@
 import { Attribute, Filter, Measure, DataSource, Data, QueryResultData } from '@sisense/sdk-data';
-import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, StyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, TableStyleOptions, ThemeOid, WidgetStyleOptions, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection } from './types';
+import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, StyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, TableStyleOptions, ThemeOid, WidgetStyleOptions, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions } from './types';
 import { HighchartsOptions } from './chart-options-processor/chart-options-service';
 import { ComponentType, PropsWithChildren, ReactNode } from 'react';
 import { IndicatorDataOptions, ScatterChartDataOptions, TableDataOptions } from './chart-data-options/types';
@@ -9,7 +9,7 @@ import { ExecuteQueryParams } from './query-execution';
 import { FiltersMergeStrategy } from './dashboard-widget/types';
 export type { ScatterDataPointEventHandler, ScatterDataPointsEventHandler, DataPointEventHandler, DataPointsEventHandler, MenuItemSection, HighchartsOptions, };
 /**
- * Props for {@link SisenseContextProvider} component
+ * Configurations for Sisense Context
  */
 export interface SisenseContextProviderProps {
     /**
@@ -73,7 +73,7 @@ export interface ExecuteQueryProps {
     /**
      * Data source the query is run against - e.g. `Sample ECommerce`
      *
-     * If not specified, the query will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider} component.
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
      */
     dataSource?: DataSource;
     /** Dimensions of the query */
@@ -100,9 +100,21 @@ export interface ExecuteQueryProps {
     children?: (queryResult: QueryResultData) => ReactNode;
     /** Callback function that is evaluated when query results are ready */
     onDataChanged?: (data: QueryResultData) => void;
+    /**
+     * Sync or async callback that allows to modify the JAQL payload before it is sent to the server.
+     *
+     * **Note:** wrap this function in `useCallback` hook to avoid triggering query execution on each render.
+     * ```tsx
+     * const onBeforeQuery = useCallback((jaql) => {
+     *   // modify jaql here
+     *   return jaql;
+     * }, []);
+     * ```
+     */
+    onBeforeQuery?: (jaql: any) => any | Promise<any>;
 }
 /**
- * Props for {@link ThemeProvider} component.
+ * Configurations for Theme.
  *
  * Two options are supported:
  *
@@ -138,7 +150,7 @@ export type ThemeProviderProps = PropsWithChildren<{
 export type BeforeRenderHandler = (
 /** Highcharts options */
 highchartsOptions: HighchartsOptions) => HighchartsOptions;
-interface ChartEventProps {
+interface BaseChartEventProps {
     /**
      * Click handler callback for a data point
      *
@@ -161,13 +173,13 @@ interface ChartEventProps {
      * Before render handler callback that allows adjusting
      * detail chart options prior to render
      *
-     * This callback is not yet supported for {@link IndicatorChart}
+     * This callback is not yet supported for Indicator Chart
      *
      * @category Callbacks
      */
     onBeforeRender?: BeforeRenderHandler;
 }
-interface CartesianChartEventProps extends ChartEventProps {
+interface ChartEventProps extends BaseChartEventProps {
     /**
      * Click handler callback for a data point
      *
@@ -187,7 +199,7 @@ interface CartesianChartEventProps extends ChartEventProps {
      */
     onDataPointsSelected?: DataPointsEventHandler;
 }
-interface ScatterChartEventProps extends ChartEventProps {
+interface ScatterChartEventProps extends BaseChartEventProps {
     /**
      * Click handler callback for a data point
      *
@@ -214,22 +226,22 @@ interface ScatterChartEventProps extends ChartEventProps {
  */
 export interface BaseChartProps {
     /**
-     * Data set for this chart, which supports two options:
+     * Data set for this component, which supports two options:
      *
      * (1) Data source name (as a `string`) - e.g. `Sample ECommerce`. Under the hood,
-     * the chart will have an internal {@link ExecuteQuery} connect to the data source
+     * the chart will have an internal query connect to the data source
      * and load the data as specified in {@link dataOptions}, {@link filters}, and {@link highlights}.
      *
      * OR
      *
-     * (2) Explicit {@link @sisense/sdk-data!Data}, which is made up of
+     * (2) Explicit {@link @sisense/sdk-data!Data | Data}, which is made up of
      * an array of {@link @sisense/sdk-data!Column | columns}
      * and a two-dimensional array of data {@link @sisense/sdk-data!Cell | cells}.
      * This allows the chart component to be used
      * with user-provided data.
      *
      * If neither option is specified,
-     * the chart will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider} component.
+     * the chart will use the `defaultDataSource` specified in the parent Sisense Context.
      *
      *
      * @category Data
@@ -251,7 +263,7 @@ export interface BaseChartProps {
 /**
  * Props shared across {@link Chart} components.
  */
-export interface ChartProps extends BaseChartProps, ChartEventProps {
+export interface ChartProps extends BaseChartProps, BaseChartEventProps {
     /**
      * Default chart type of each series.
      *
@@ -281,7 +293,7 @@ export interface ChartProps extends BaseChartProps, ChartEventProps {
 /**
  * Props of the {@link AreaChart} component.
  */
-export interface AreaChartProps extends BaseChartProps, CartesianChartEventProps {
+export interface AreaChartProps extends BaseChartProps, ChartEventProps {
     /**
      * Configurations for how to interpret and present data passed to the chart.
      *
@@ -298,7 +310,7 @@ export interface AreaChartProps extends BaseChartProps, CartesianChartEventProps
 /**
  * Props of the {@link BarChart} component.
  */
-export interface BarChartProps extends BaseChartProps, CartesianChartEventProps {
+export interface BarChartProps extends BaseChartProps, ChartEventProps {
     /**
      * Configurations for how to interpret and present the data passed to the chart
      *
@@ -315,7 +327,7 @@ export interface BarChartProps extends BaseChartProps, CartesianChartEventProps
 /**
  * Props of the {@link ColumnChart} component.
  */
-export interface ColumnChartProps extends BaseChartProps, CartesianChartEventProps {
+export interface ColumnChartProps extends BaseChartProps, ChartEventProps {
     /**
      * Configurations for how to interpret and present the data passed to the chart
      *
@@ -332,7 +344,7 @@ export interface ColumnChartProps extends BaseChartProps, CartesianChartEventPro
 /**
  * Props of the {@link FunnelChart} component.
  */
-export interface FunnelChartProps extends BaseChartProps, CartesianChartEventProps {
+export interface FunnelChartProps extends BaseChartProps, ChartEventProps {
     /**
      * Configurations for how to interpret and present the data passed to the chart
      *
@@ -349,7 +361,7 @@ export interface FunnelChartProps extends BaseChartProps, CartesianChartEventPro
 /**
  * Props of the {@link LineChart} component.
  */
-export interface LineChartProps extends BaseChartProps, CartesianChartEventProps {
+export interface LineChartProps extends BaseChartProps, ChartEventProps {
     /**
      * Configurations for how to interpret and present data passed to the chart.
      *
@@ -366,7 +378,7 @@ export interface LineChartProps extends BaseChartProps, CartesianChartEventProps
 /**
  * Props of the {@link PieChart} component.
  */
-export interface PieChartProps extends BaseChartProps, CartesianChartEventProps {
+export interface PieChartProps extends BaseChartProps, ChartEventProps {
     /**
      * Configurations for how to interpret and present the data passed to the chart
      *
@@ -383,7 +395,7 @@ export interface PieChartProps extends BaseChartProps, CartesianChartEventProps
 /**
  * Props of the {@link PolarChart} component.
  */
-export interface PolarChartProps extends BaseChartProps, CartesianChartEventProps {
+export interface PolarChartProps extends BaseChartProps, ChartEventProps {
     /** Configurations for how to interpret and present the data passed to the chart */
     dataOptions: CartesianChartDataOptions;
     /** Configuration that define functional style of the various chart elements */
@@ -403,31 +415,16 @@ export interface IndicatorChartProps extends BaseChartProps {
  */
 export interface TableProps {
     /**
-     * Data set for this chart, which supports two options:
-     *
-     * (1) Data source name (as a `string`) - e.g. `Sample ECommerce`. Under the hood,
-     * the chart will have an internal {@link ExecuteQuery} connect to the data source
-     * and load the data as specified in {@link dataOptions} and {@link filters}.
-     *
-     * OR
-     *
-     * (2) Explicit {@link @sisense/sdk-data!Data}, which is made up of
-     * an array of {@link @sisense/sdk-data!Column | columns}
-     * and a two-dimensional array of data {@link @sisense/sdk-data!Cell | cells}.
-     * This allows the chart component to be used
-     * with user-provided data.
-     *
-     * If neither option is specified,
-     * the chart will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider} component.
+     * {@inheritDoc ChartProps.dataSet}
      *
      *
      * @category Data
      */
     dataSet?: DataSource | Data;
     /**
-     * Configurations for how to interpret and present the data passed to the chart
+     * Configurations for how to interpret and present the data passed to the component
      *
-     * @category Chart
+     * @category Representation
      */
     dataOptions: TableDataOptions;
     /**
@@ -437,9 +434,9 @@ export interface TableProps {
      */
     filters?: Filter[];
     /**
-     * Configurations that define functional style of the various chart elements
+     * Configurations that define functional style of the various table elements
      *
-     * @category Chart
+     * @category Representation
      */
     styleOptions?: TableStyleOptions;
     /**
@@ -471,7 +468,7 @@ export interface ScatterChartProps extends BaseChartProps, ScatterChartEventProp
  * Props for the {@link DashboardWidget} component
  *
  */
-export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource' | 'dataOptions' | 'chartType' | 'styleOptions'>, ChartEventProps {
+export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource' | 'dataOptions' | 'chartType' | 'styleOptions'>, BaseChartEventProps {
     /**
      * Identifier of the widget
      *
@@ -504,6 +501,12 @@ export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource
      * @category Data
      */
     filtersMergeStrategy?: FiltersMergeStrategy;
+    /**
+     * {@inheritDoc ExecuteQueryByWidgetIdProps.includeDashboardFilters}
+     *
+     * @category Data
+     */
+    includeDashboardFilters?: boolean;
     /**
      * Title of the widget
      *
@@ -562,11 +565,11 @@ export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource
  * Props for the {@link ChartWidget} component
  *
  */
-export interface ChartWidgetProps extends ChartEventProps {
+export interface ChartWidgetProps extends BaseChartEventProps {
     /**
      * Data source the query is run against - e.g. `Sample ECommerce`
      *
-     * If not specified, the query will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider} component.
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
      *
      * @category Data
      */
@@ -610,6 +613,7 @@ export interface ChartWidgetProps extends ChartEventProps {
     /**
      * List of categories to allow drilldowns on
      *
+     * @deprecated Use {@link DrilldownWidget} instead
      * @category Widget
      */
     drilldownOptions?: DrilldownOptions;
@@ -653,6 +657,16 @@ export interface ChartWidgetProps extends ChartEventProps {
      * @category Widget
      */
     description?: string;
+    /**
+     * Boolean flag whether selecting data points triggers highlight filter of the selected data
+     *
+     * Recommended to turn on when the Chart Widget component is enhanced with data drilldown by the Drilldown Widget component
+     *
+     * If not specified, the default value is `false`
+     *
+     * @category Widget
+     */
+    highlightSelectionDisabled?: boolean;
 }
 /**
  * Props for the {@link TableWidget} component
@@ -663,7 +677,7 @@ export interface TableWidgetProps {
     /**
      * Data source the query is run against - e.g. `Sample ECommerce`
      *
-     * If not specified, the query will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider} component.
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
      *
      * @category Data
      */
@@ -738,7 +752,7 @@ export interface ExecuteQueryByWidgetIdProps {
     /** {@inheritDoc ExecuteQueryProps.offset} */
     offset?: number;
     /**
-     * Strategy for merging the existing widget filters with the filters provided via the `filters` prop:
+     * Strategy for merging the existing widget filters (including highlights) with the filters provided via the `filters` and `highlights` props:
      *
      * - `widgetFirst` - prioritizes the widget filters over the provided filters in case of filter conflicts by certain attributes.
      * - `codeFirst` - prioritizes the provided filters over the widget filters in case of filter conflicts by certain attributes.
@@ -747,15 +761,33 @@ export interface ExecuteQueryByWidgetIdProps {
      * If not specified, the default strategy is `codeFirst`.
      */
     filtersMergeStrategy?: FiltersMergeStrategy;
+    /**
+     * Boolean flag whether to include dashboard filters in the widget's `filters` and `highlights`
+     *
+     * If not specified, the default value is `false`.
+     */
+    includeDashboardFilters?: boolean;
     /** Function as child component that is called to render the query results */
     children?: (queryResult: QueryResultData, queryParams: ExecuteQueryParams) => ReactNode;
     /** Callback function that is evaluated when query results are ready */
     onDataChanged?: (data: QueryResultData, queryParams: ExecuteQueryParams) => void;
+    /**
+     * Sync or async callback that allows to modify the JAQL payload before it is sent to the server.
+     *
+     * **Note:** wrap this function in `useCallback` hook to avoid triggering query execution on each render.
+     * ```tsx
+     * const onBeforeQuery = useCallback((jaql) => {
+     *   // modify jaql here
+     *   return jaql;
+     * }, []);
+     * ```
+     */
+    onBeforeQuery?: (jaql: any) => any | Promise<any>;
 }
 /**
  * Props of the {@link TreemapChart} component.
  */
-export interface TreemapChartProps extends BaseChartProps, CartesianChartEventProps {
+export interface TreemapChartProps extends BaseChartProps, ChartEventProps {
     /**
      * Configurations for how to interpret and present the data passed to the chart
      *
@@ -769,6 +801,23 @@ export interface TreemapChartProps extends BaseChartProps, CartesianChartEventPr
      */
     styleOptions?: TreemapStyleOptions;
 }
+/**
+ * Props of the {@link SunburstChart} component.
+ */
+export interface SunburstChartProps extends BaseChartProps, ChartEventProps {
+    /**
+     * Configurations for how to interpret and present the data passed to the chart
+     *
+     * @category Chart
+     */
+    dataOptions: CategoricalChartDataOptions;
+    /**
+     * Configuration that define functional style of the various chart elements
+     *
+     * @category Chart
+     */
+    styleOptions?: SunburstStyleOptions;
+}
 /**
  * Props for {@link ContextMenu} component.
  */

package/dist/query/execute-query.d.ts

@@ -1,8 +1,19 @@
-import { Attribute, DataSource, Filter, Measure, QueryResultData } from '@sisense/sdk-data';
+import { Attribute, QueryResultData } from '@sisense/sdk-data';
+import type { QueryDescription as InternalQueryDescription, QueryExecutionConfig } from '@sisense/sdk-query-client';
 import { ClientApplication } from '../app/client-application';
+/**
+ * All the properties that fully describe a query you want to send.
+ *
+ * We use "dimensions" it public interface because the term is closer to the query and charting
+ * as used in the industry (Sisense included).
+ * internally, "dimensions" are represented by attributes as the latter is closer to the data model.
+ */
+export type QueryDescription = Partial<Omit<InternalQueryDescription, 'attributes'>> & {
+    dimensions?: Attribute[];
+};
 /** @internal */
 export declare const QUERY_DEFAULT_LIMIT = 20000;
 /** @internal */
 export declare const QUERY_DEFAULT_OFFSET = 0;
 /** @internal */
-export declare const executeQuery: (dataSource: DataSource | undefined, dimensions: Attribute[] | undefined, measures: Measure[] | undefined, filters: Filter[] | undefined, highlights: Filter[] | undefined, app: ClientApplication, count?: number, offset?: number) => Promise<QueryResultData>;
+export declare const executeQuery: (queryDescription: QueryDescription, app: ClientApplication, executionConfig?: QueryExecutionConfig) => Promise<QueryResultData>;

package/dist/query-execution/use-execute-query-by-widget-id.d.ts

@@ -1,8 +1,8 @@
 import { type Filter } from '@sisense/sdk-data';
-import { ExecuteQueryParams } from './index.js';
-import { QueryState } from './query-state-reducer.js';
-import { FiltersMergeStrategy } from '../dashboard-widget/types.js';
-import { ClientApplication } from '../app/client-application.js';
+import { ExecuteQueryParams } from './';
+import { QueryState } from './query-state-reducer';
+import { FiltersMergeStrategy } from '../dashboard-widget/types';
+import { ClientApplication } from '../app/client-application';
 /**
  * Parameters for {@link useExecuteQueryByWidgetId} hook.
  */
@@ -21,6 +21,16 @@ export interface ExecuteQueryByWidgetIdParams {
     offset?: number;
     /** {@inheritDoc ExecuteQueryByWidgetIdProps.filtersMergeStrategy} */
     filtersMergeStrategy?: FiltersMergeStrategy;
+    /** {@inheritDoc ExecuteQueryByWidgetIdProps.includeDashboardFilters} */
+    includeDashboardFilters?: boolean;
+    /** {@inheritDoc ExecuteQueryByWidgetIdProps.onBeforeQuery} */
+    onBeforeQuery?: (jaql: any) => any | Promise<any>;
+    /**
+     * Boolean flag to control if query is executed
+     *
+     * If not specified, the default value is `true`
+     */
+    enabled?: boolean;
 }
 export type QueryByWidgetIdState = QueryState & {
     /** Query parameters constructed over the widget */
@@ -55,6 +65,11 @@ export type QueryByWidgetIdState = QueryState & {
  * @returns Query state that contains the status of the query execution, the result data, the constructed query parameters, or the error if any occurred
  */
 export declare const useExecuteQueryByWidgetId: (params: ExecuteQueryByWidgetIdParams) => QueryByWidgetIdState;
+/**
+ * {@link useExecuteQueryByWidgetId} without tracking to be used inside other hooks or components in Compose SDK.
+ * @internal
+ */
+export declare function useExecuteQueryByWidgetIdInternal(params: ExecuteQueryByWidgetIdParams): QueryByWidgetIdState;
 /**
  * Checks if the parameters have changed by deep comparison.
  *
@@ -63,7 +78,7 @@ export declare const useExecuteQueryByWidgetId: (params: ExecuteQueryByWidgetIdP
  */
 export declare function isParamsChanged(prevParams: ExecuteQueryByWidgetIdParams | undefined, newParams: ExecuteQueryByWidgetIdParams): boolean;
 /** @internal */
-export declare function executeQueryByWidgetId({ widgetOid, dashboardOid, filters, highlights, filtersMergeStrategy, count, offset, app, }: ExecuteQueryByWidgetIdParams & {
+export declare function executeQueryByWidgetId({ widgetOid, dashboardOid, filters, highlights, filtersMergeStrategy, count, offset, includeDashboardFilters, app, onBeforeQuery, }: ExecuteQueryByWidgetIdParams & {
     app: ClientApplication;
 }): Promise<{
     data: import("@sisense/sdk-data").QueryResultData;

package/dist/query-execution/use-execute-query.d.ts

@@ -3,11 +3,11 @@ import { QueryState } from './query-state-reducer';
 /**
  * Parameters for {@link useExecuteQuery} hook.
  */
-export type ExecuteQueryParams = {
+export interface ExecuteQueryParams {
     /**
      * Data source the query is run against - e.g. `Sample ECommerce`
      *
-     * If not specified, the query will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider} component.
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
      */
     dataSource?: DataSource;
     /** Dimensions of the query */
@@ -28,7 +28,9 @@ export type ExecuteQueryParams = {
      * If not specified, the default value is `true`
      */
     enabled?: boolean;
-};
+    /** {@inheritDoc ExecuteQueryProps.onBeforeQuery} */
+    onBeforeQuery?: (jaql: any) => any | Promise<any>;
+}
 /**
  * React hook that executes a data query.
  * This approach, which offers an alternative to {@link ExecuteQuery} component, is similar to React Query's `useQuery` hook.
@@ -61,3 +63,9 @@ export type ExecuteQueryParams = {
  * @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
  */
 export declare const useExecuteQuery: (params: ExecuteQueryParams) => QueryState;
+/**
+ * {@link useExecuteQuery} without tracking to be used inside other hooks or components in Compose SDK.
+ *
+ * @internal
+ */
+export declare function useExecuteQueryInternal(params: ExecuteQueryParams): QueryState;

package/dist/scatter-chart.d.ts

@@ -7,7 +7,7 @@ import { ScatterChartProps } from './props';
  * **Point**: A field that for each of its members a scatter point is drawn. The maximum amount of data points is 500.
  *
  * **Size**: An optional field represented by the size of the circles.
- * If omitted, all scatter points are equal in size. If used, the circle size is relative to their value.
+ * If omitted, all scatter points are equal in size. If used, the circle sizes are relative to their values.
  *
  * See [Scatter Chart](https://docs.sisense.com/main/SisenseLinux/scatter-chart.htm) for more information.
  *

package/dist/sunburst-chart.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="react" />
+import { SunburstChartProps } from './props';
+/**
+ * A React component displaying hierarchical data in the form of nested circle slices.
+ * This type of chart can be used in different scenarios, for example, to compare both categories and sub-categories.
+ * See [Sunburst Chart](https://docs.sisense.com/main/SisenseLinux/sunburst-widget.htm) for more information.
+ *
+ * @example
+ * An example of using the component to visualize the `Sample ECommerce` data source:
+ * ```tsx
+ * <SunburstChart
+ *   dataSet={DM.DataSource}
+ *   dataOptions={{
+ *     category: [
+ *        DM.Commerce.Сondition,
+ *        DM.Commerce.Date.Years
+ *      ],
+ *     value: [measures.sum(DM.Commerce.Quantity)],
+ *   }}
+ * />
+ * ```
+ *
+ * <img src="media://sunburst-chart-example-1.png" width="600px" />
+ * @param props - Sunburst chart properties
+ * @returns Sunburst Chart component
+ */
+export declare const SunburstChart: import("react").FunctionComponent<SunburstChartProps>;

package/dist/theme-provider/theme-provider.d.ts

@@ -38,7 +38,7 @@ export declare const useThemeContext: () => {
  * For comparison, indicator chart with default theme settings:
  *
  * <img src="media://indicator-chart-example-1.png" width="400px" />
- * @see {@link ThemeSettings}, {@link getDefaultThemeSettings}, {@link IndicatorChart}
+ * @see {@link ThemeSettings} and {@link IndicatorChart}
  * @param props - Theme provider props
  * @returns A Theme Provider component
  */

package/dist/treemap-chart.d.ts

@@ -2,8 +2,7 @@
 import { TreemapChartProps } from './props';
 /**
  * A React component displaying hierarchical data in the form of nested rectangles.
- * This type of chart can be used in different scenarios, for example,
- * instead of a column chart if you have to compare too many categories and sub-categories.
+ * This type of chart can be used instead of a column chart for comparing a large number of categories and sub-categories.
  * See [Treemap Chart](https://docs.sisense.com/main/SisenseLinux/treemap.htm) for more information.
  *
  * @example

package/dist/types.d.ts

@@ -356,12 +356,34 @@ export interface TreemapStyleOptions extends BaseStyleOptions {
         mode?: 'value' | 'contribution';
     };
 }
+/** Configuration options that define functional style of the various elements of {@link SunburstChart} */
+export interface SunburstStyleOptions extends BaseStyleOptions {
+    /** Labels options object */
+    labels?: {
+        /** Array with single label options objects (order of items relative to dataOptions.category) */
+        category?: {
+            /** Define visibility of label */
+            enabled?: boolean;
+        }[];
+    };
+    /** Tooltip options object */
+    tooltip?: {
+        /** Define mode of data showing */
+        mode?: 'value' | 'contribution';
+    };
+}
 /**
  * Configuration options that define functional style of the various elements of chart.
  */
-export type StyleOptions = LineStyleOptions | AreaStyleOptions | StackableStyleOptions | PieStyleOptions | FunnelStyleOptions | PolarStyleOptions | IndicatorStyleOptions | ScatterStyleOptions | TreemapStyleOptions;
+export type StyleOptions = LineStyleOptions | AreaStyleOptions | StackableStyleOptions | PieStyleOptions | FunnelStyleOptions | PolarStyleOptions | IndicatorStyleOptions | ScatterStyleOptions | TreemapStyleOptions | SunburstStyleOptions;
 /** Mapping of each of the chart value series to colors. */
-export type ValueToColorMap = Record<string, string>;
+export type ValueToColorMap = {
+    [value: string]: string;
+};
+/** Mapping of each of the chart columns with mapping of each value series to colors. */
+export type MultiColumnValueToColorMap = {
+    [columnName: string]: ValueToColorMap;
+};
 /**
  * Chart type of one of the supported chart families
  */

package/dist/widgets/chart-widget-deprecated.d.ts

@@ -0,0 +1,30 @@
+import { type FunctionComponent } from 'react';
+import { ChartWidgetProps } from '../props';
+/**
+ * The Chart Widget component extending the {@link Chart} component to support advanced BI
+ * capabilities such as drilldown.
+ *
+ * @example
+ * Example of using the `ChartWidget` component to
+ * plot a bar chart of the `Sample ECommerce` data source hosted in a Sisense instance.
+ * Drill-down capability is enabled.
+ * ```tsx
+ * <ChartWidget
+ *   dataSource={DM.DataSource}
+ *   chartType="bar"
+ *   dataOptions={{
+ *     category: [DM.Category.Category],
+ *     value: [measures.sum(DM.Commerce.Revenue)],
+ *     breakBy: [],
+ *   }}
+ *   drilldownOptions={{
+ *     drilldownDimensions: [DM.Commerce.AgeRange, DM.Commerce.Gender, DM.Commerce.Condition],
+ *   }}
+ * />
+ * ```
+ *
+ * <img src="media://chart-widget-with-drilldown-example-1.png" width="800px" />
+ * @param props - ChartWidget properties
+ * @returns ChartWidget component representing a chart type as specified in `ChartWidgetProps.`{@link ChartWidgetProps.chartType}
+ */
+export declare const ChartWidgetDeprecated: FunctionComponent<ChartWidgetProps>;