@sisense/sdk-ui 1.4.1 → 1.6.0

package/dist/query-execution/types.d.ts

@@ -117,29 +117,41 @@ export type QueryAction = DataLoadAction<QueryResultData>;
  * Parameters for {@link useExecuteQueryByWidgetId} hook.
  */
 export interface ExecuteQueryByWidgetIdParams {
-    /** {@inheritDoc ExecuteQueryByWidgetIdProps.widgetOid} */
+    /** Identifier of the widget */
     widgetOid: string;
-    /** {@inheritDoc ExecuteQueryByWidgetIdProps.dashboardOid} */
+    /** Identifier of the dashboard that contains the widget */
     dashboardOid: string;
-    /** {@inheritDoc ExecuteQueryByWidgetIdProps.filters} */
+    /**
+     * Filters that will slice query results.
+     *
+     * The provided filters will be merged with the existing widget filters based on `filtersMergeStrategy`
+     */
     filters?: Filter[];
-    /** {@inheritDoc ExecuteQueryByWidgetIdProps.highlights} */
+    /** Highlight filters that will highlight results that pass filter criteria */
     highlights?: Filter[];
-    /** {@inheritDoc ExecuteQueryProps.count} */
+    /** {@inheritDoc ExecuteQueryParams.count} */
     count?: number;
-    /** {@inheritDoc ExecuteQueryProps.offset} */
+    /** {@inheritDoc ExecuteQueryParams.offset} */
     offset?: number;
-    /** {@inheritDoc ExecuteQueryByWidgetIdProps.filtersMergeStrategy} */
+    /**
+     * 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.
+     * - `codeOnly` - applies only the provided filters and completely ignores the widget filters.
+     *
+     * If not specified, the default strategy is `codeFirst`.
+     */
     filtersMergeStrategy?: FiltersMergeStrategy;
-    /** {@inheritDoc ExecuteQueryByWidgetIdProps.includeDashboardFilters} */
-    includeDashboardFilters?: boolean;
-    /** {@inheritDoc ExecuteQueryByWidgetIdProps.onBeforeQuery} */
-    onBeforeQuery?: (jaql: any) => any | Promise<any>;
     /**
-     * Boolean flag to control if query is executed
+     * Boolean flag whether to include dashboard filters in the widget's `filters` and `highlights`
      *
-     * If not specified, the default value is `true`
+     * If not specified, the default value is `false`.
      */
+    includeDashboardFilters?: boolean;
+    /** {@inheritDoc ExecuteQueryParams.onBeforeQuery} */
+    onBeforeQuery?: (jaql: any) => any | Promise<any>;
+    /** {@inheritDoc ExecuteQueryParams.enabled} */
     enabled?: boolean;
 }
 export type QueryByWidgetIdState = QueryState & {
@@ -164,9 +176,17 @@ export interface ExecuteQueryParams {
     filters?: Filter[] | FilterRelations;
     /** Highlight filters that will highlight results that pass filter criteria */
     highlights?: Filter[];
-    /** {@inheritDoc ExecuteQueryProps.count} */
+    /**
+     * Number of rows to return in the query result
+     *
+     * If not specified, the default value is `20000`
+     */
     count?: number;
-    /** {@inheritDoc ExecuteQueryProps.offset} */
+    /**
+     * Offset of the first row to return
+     *
+     * If not specified, the default value is `0`
+     */
     offset?: number;
     /**
      * Boolean flag to control if query is executed
@@ -174,7 +194,17 @@ export interface ExecuteQueryParams {
      * If not specified, the default value is `true`
      */
     enabled?: boolean;
-    /** {@inheritDoc ExecuteQueryProps.onBeforeQuery} */
+    /**
+     * Sync or async callback that allows to modify the JAQL payload before it is sent to the server.
+     *
+     * **Note:** In React, 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>;
 }
 /** Configuration for {@link useExecuteCsvQuery} hook. */

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

@@ -70,6 +70,7 @@ import { CsvQueryState, ExecuteCsvQueryParams } from './types.js';
  ```
  * @param params - Parameters of the query
  * @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
+ * @group Queries
  */
 export declare const useExecuteCsvQuery: (params: ExecuteCsvQueryParams) => CsvQueryState;
 /**

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

@@ -34,6 +34,7 @@ import { ExecutePivotQueryParams, PivotQueryState } from './types';
  * See also hook {@link useExecuteQuery}, which execute a generic data query.
  * @param params - Parameters of the query
  * @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
+ * @group Queries
  * @alpha
  */
 export declare const useExecutePivotQuery: (params: ExecutePivotQueryParams) => PivotQueryState;

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

@@ -28,6 +28,7 @@ import { ExecuteQueryByWidgetIdParams, QueryByWidgetIdState } from './types';
  * See also hook {@link useExecuteQuery}, which execute a query specified in code.
  * @param params - Parameters to identify the target widget
  * @returns Query state that contains the status of the query execution, the result data, the constructed query parameters, or the error if any occurred
+ * @group Fusion Assets
  */
 export declare const useExecuteQueryByWidgetId: (params: ExecuteQueryByWidgetIdParams) => QueryByWidgetIdState;
 /**

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

@@ -29,6 +29,7 @@ import { ExecuteQueryParams, QueryState } from './types';
  * of using the hook to fetch data from Sisense for third-party charts.
  * @param params - Parameters of the query
  * @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
+ * @group Queries
  */
 export declare const useExecuteQuery: (params: ExecuteQueryParams) => QueryState;
 /**

package/dist/scatter-chart.d.ts

@@ -64,5 +64,6 @@ import { ScatterChartProps } from './props';
  * <img src="media://scatter-chart-example-1.png" width="800px" />
  * @param props - Scatter chart properties
  * @returns Scatter Chart component
+ * @group Charts
  */
 export declare const ScatterChart: import("react").FunctionComponent<ScatterChartProps>;

package/dist/scattermap-chart.d.ts

@@ -29,6 +29,7 @@ import { ScattermapChartProps } from './props';
  * <img src="media://scattermap-chart-example-1.png" width="600px" />
  * @param props - Scattermap chart properties
  * @returns Scattermap Chart component
+ * @group Charts
  * @beta
  */
 export declare const ScattermapChart: import("react").FunctionComponent<ScattermapChartProps>;

package/dist/sisense-context/sisense-context-provider.d.ts

@@ -32,5 +32,6 @@ import { SisenseContextProviderProps } from '../props';
  * ```
  * @param props - Sisense context provider props
  * @returns A Sisense Context Provider Component
+ * @group Contexts
  */
 export declare const SisenseContextProvider: FunctionComponent<PropsWithChildren<SisenseContextProviderProps>>;

package/dist/sisense-context/sisense-context.d.ts

@@ -3,7 +3,10 @@ import { ClientApplication } from '../app/client-application';
 export type SisenseContextPayload = {
     isInitialized: boolean;
     app?: ClientApplication;
-    enableTracking: boolean;
+    tracking: {
+        enabled: boolean;
+        packageName: string;
+    };
 };
 export declare const SisenseContext: import("react").Context<SisenseContextPayload>;
 export declare const useSisenseContext: () => SisenseContextPayload;

package/dist/sunburst-chart.d.ts

@@ -23,5 +23,6 @@ import { SunburstChartProps } from './props';
  * <img src="media://sunburst-chart-example-1.png" width="600px" />
  * @param props - Sunburst chart properties
  * @returns Sunburst Chart component
+ * @group Charts
  */
 export declare const SunburstChart: import("react").FunctionComponent<SunburstChartProps>;

package/dist/table/table.d.ts

@@ -46,6 +46,7 @@ import { TableProps } from '../props';
  * <img src="media://table-example-2.png" width="800px" />
  * @param props - Table properties
  * @returns Table component
+ * @group Data Grids
  */
 export declare const Table: React.FunctionComponent<TableProps>;
 export declare const DEFAULT_TABLE_ROWS_PER_PAGE: 25;

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

@@ -4,6 +4,12 @@ import { CompleteThemeSettings } from '../types';
 export declare const ThemeContext: import("react").Context<{
     themeSettings: CompleteThemeSettings;
 }>;
+/**
+ * Hook to get the current theme settings.
+ *
+ * @returns The current theme settings
+ * @internal
+ */
 export declare const useThemeContext: () => {
     themeSettings: CompleteThemeSettings;
 };
@@ -38,8 +44,9 @@ 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} and {@link IndicatorChart}
+ * @see {@link ThemeSettings} and IndicatorChart
  * @param props - Theme provider props
  * @returns A Theme Provider component
+ * @group Contexts
  */
 export declare const ThemeProvider: import("react").FunctionComponent<ThemeProviderProps>;

package/dist/treemap-chart.d.ts

@@ -29,5 +29,6 @@ import { TreemapChartProps } from './props';
  * <img src="media://treemap-chart-example-1.png" width="600px" />
  * @param props - Treemap chart properties
  * @returns Treemap Chart component
+ * @group Charts
  */
 export declare const TreemapChart: import("react").FunctionComponent<TreemapChartProps>;

package/dist/types.d.ts

@@ -14,7 +14,7 @@ export type { AppConfig } from './app/client-application';
 export type { DateConfig } from './query/date-formats';
 export type { CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, StyledColumn, StyledMeasureColumn, } from './chart-data-options/types';
 export type { DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, } from './chart-data/data-coloring/types';
-export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, GeoDataElement, RawGeoDataElement, };
+export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, GeoDataElement, RawGeoDataElement, Coordinates, };
 export type { MonthOfYear, DayOfWeek, DateLevel } from './query/date-formats/apply-date-format';
 /**
  * @internal
@@ -205,18 +205,18 @@ export interface BaseAxisStyleOptions {
     /** Configuration for second Y axis */
     y2Axis?: AxisLabel;
 }
-/** Configuration options that define functional style of the various elements of {@link LineChart} */
+/** Configuration options that define functional style of the various elements of LineChart */
 export interface LineStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
     /** Configuration that defines line width */
     lineWidth?: LineWidth;
-    /** Subtype of {@link LineChart}*/
+    /** Subtype of LineChart */
     subtype?: LineSubtype;
 }
-/** Configuration options that define functional style of the various elements of {@link AreaChart} */
+/** Configuration options that define functional style of the various elements of AreaChart */
 export interface AreaStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
     /** Configuration that defines line width */
     lineWidth?: LineWidth;
-    /** Subtype of {@link AreaChart}*/
+    /** Subtype of AreaChart*/
     subtype?: AreaSubtype;
 }
 /** Configuration options that define functional style of the various elements of stackable charts, like Column or Bar */
@@ -236,25 +236,25 @@ export interface PieStyleOptions extends BaseStyleOptions {
     /** Subtype of Pie chart*/
     subtype?: PieSubtype;
 }
-/** Configuration options that define functional style of the various elements of {@link FunnelChart} */
+/** Configuration options that define functional style of the various elements of FunnelChart */
 export interface FunnelStyleOptions extends BaseStyleOptions {
     /** Visual size of the lowest slice (degree of funnel narrowing from highest to lowest slices)*/
     funnelSize?: FunnelSize;
-    /** Visual type of the lowest slice of {@link FunnelChart} */
+    /** Visual type of the lowest slice of FunnelChart */
     funnelType?: FunnelType;
-    /** Direction of {@link FunnelChart} narrowing */
+    /** Direction of FunnelChart narrowing */
     funnelDirection?: FunnelDirection;
-    /** Configuration that defines behavior of data labels on {@link FunnelChart} */
+    /** Configuration that defines behavior of data labels on FunnelChart */
     labels?: Labels;
-    /** Subtype of {@link FunnelChart}*/
+    /** Subtype of FunnelChart*/
     subtype?: never;
 }
-/** Configuration options that define functional style of the various elements of {@link PolarChart} */
+/** Configuration options that define functional style of the various elements of PolarChart */
 export interface PolarStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
-    /** Subtype of {@link PolarChart}*/
+    /** Subtype of PolarChart*/
     subtype?: PolarSubtype;
 }
-/** Configuration options that define functional style of the various elements of {@link IndicatorChart} */
+/** Configuration options that define functional style of the various elements of IndicatorChart */
 export type IndicatorStyleOptions = (NumericSimpleIndicatorStyleOptions | NumericBarIndicatorStyleOptions | GaugeIndicatorStyleOptions) & {
     /**
      * Total width of the component, which is considered in the following order of priority:
@@ -274,7 +274,7 @@ export type IndicatorStyleOptions = (NumericSimpleIndicatorStyleOptions | Numeri
      */
     height?: number;
 };
-/** Configuration options that define functional style of the various elements of {@link Table} */
+/** Configuration options that define functional style of the various elements of the Table Component */
 export interface TableStyleOptions {
     /**
      * Boolean flag whether to fill header cells with background color
@@ -313,7 +313,7 @@ export interface TableStyleOptions {
      */
     height?: number;
 }
-/** Configuration options that define functional style of the various elements of {@link PivotTable} */
+/** Configuration options that define functional style of the various elements of the PivotTable component */
 export interface PivotTableStyleOptions {
     /**
      * Boolean flag whether to fill header cells with background color
@@ -366,31 +366,31 @@ export interface BaseIndicatorStyleOptions {
     /** Boolean flag to force render indicator in ticker mode regardless of display size */
     forceTickerView?: boolean;
 }
-/** Configuration options that define functional style of the various elements of Numeric Simple {@link IndicatorChart} */
+/** Configuration options that define functional style of the various elements of Numeric Simple IndicatorChart */
 export interface NumericSimpleIndicatorStyleOptions extends BaseIndicatorStyleOptions {
     subtype: 'indicator/numeric';
     numericSubtype: 'numericSimple';
     skin: 'vertical' | 'horizontal';
 }
-/** Configuration options that define functional style of the various elements of Numeric Bar {@link IndicatorChart} */
+/** Configuration options that define functional style of the various elements of Numeric Bar IndicatorChart */
 export interface NumericBarIndicatorStyleOptions extends BaseIndicatorStyleOptions {
     subtype: 'indicator/numeric';
     numericSubtype: 'numericBar';
 }
-/** Configuration options that define functional style of the various elements of Gauge {@link IndicatorChart} */
+/** Configuration options that define functional style of the various elements of Gauge IndicatorChart */
 export interface GaugeIndicatorStyleOptions extends BaseIndicatorStyleOptions {
     subtype: 'indicator/gauge';
     skin: 1 | 2;
     /** Bar height for gauge indicator in ticker mode */
     tickerBarHeight?: number;
 }
-/** Configuration options that define functional style of the various elements of {@link ScatterChart} */
+/** Configuration options that define functional style of the various elements of ScatterChart */
 export interface ScatterStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
-    /** Subtype of {@link ScatterChart}*/
+    /** Subtype of ScatterChart*/
     subtype?: never;
     markerSize?: ScatterMarkerSize;
 }
-/** Configuration options that define functional style of the various elements of {@link TreemapChart} */
+/** Configuration options that define functional style of the various elements of TreemapChart */
 export interface TreemapStyleOptions extends BaseStyleOptions {
     /** Labels options object */
     labels?: {
@@ -406,7 +406,7 @@ export interface TreemapStyleOptions extends BaseStyleOptions {
         mode?: 'value' | 'contribution';
     };
 }
-/** Configuration options that define functional style of the various elements of {@link SunburstChart} */
+/** Configuration options that define functional style of the various elements of the SunburstChart component */
 export interface SunburstStyleOptions extends BaseStyleOptions {
     /** Labels options object */
     labels?: {
@@ -422,20 +422,20 @@ export interface SunburstStyleOptions extends BaseStyleOptions {
         mode?: 'value' | 'contribution';
     };
 }
-/** Configuration options that define functional style of the various elements of {@link BoxplotChart} */
+/** Configuration options that define functional style of the various elements of the BoxplotChart component */
 export interface BoxplotStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
-    /** Subtype of {@link BoxplotChart}*/
+    /** Subtype of the BoxplotChart component*/
     subtype?: BoxplotSubtype;
 }
 /**
- * Type of map to display on {@link AreamapChart}
+ * Type of map to display on the AreamapChart component
  */
 export type AreamapType = 'world' | 'usa';
 /**
- * Configuration options that define functional style of the various elements of {@link AreamapChart}
+ * Configuration options that define functional style of the various elements of the AreamapChart component
  */
 export interface AreamapStyleOptions extends Pick<BaseStyleOptions, 'width' | 'height'> {
-    /** Type of map to display on {@link AreamapChart} */
+    /** Type of map to display on the AreamapChart component */
     mapType?: AreamapType;
 }
 /**
@@ -454,7 +454,7 @@ export type ScattermapMarkers = {
         maxSize?: number;
     };
 };
-/** Configuration options that define functional style of the various elements of {@link ScattermapChart} */
+/** Configuration options that define functional style of the various elements of ScattermapChart */
 export interface ScattermapStyleOptions extends Pick<BaseStyleOptions, 'width' | 'height'> {
     subtype?: never;
     markers?: ScattermapMarkers;
@@ -627,7 +627,7 @@ export interface WidgetStyleOptions {
         renderToolbar?: (onRefresh: () => void) => JSX.Element;
     };
 }
-/** Style settings defining the look and feel of {@link DashboardWidget} */
+/** Style settings defining the look and feel of DashboardWidget */
 export interface DashboardWidgetStyleOptions extends WidgetStyleOptions {
     /**
      * Total width of the component, which is considered in the following order of priority:
@@ -647,7 +647,7 @@ export interface DashboardWidgetStyleOptions extends WidgetStyleOptions {
      */
     height?: number;
 }
-/** Style settings defining the look and feel of {@link ChartWidget} */
+/** Style settings defining the look and feel of ChartWidget */
 export type ChartWidgetStyleOptions = ChartStyleOptions & WidgetStyleOptions;
 /**
  * Style settings defining the look and feel of TableWidget}
@@ -847,7 +847,7 @@ export type SeriesWithAlerts<T> = {
 };
 /**
  * Context menu position coordinates
- * Used in {@link ContextMenu} component
+ * Used in {@link ContextMenuProps}
  */
 export type MenuPosition = {
     /** Horizontal position */
@@ -857,7 +857,7 @@ export type MenuPosition = {
 };
 /**
  * Context menu section
- * Used in {@link ContextMenu} component
+ * Used in {@link ContextMenuProps}
  */
 export type MenuItemSection = {
     /** Optional section title */

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

@@ -22,5 +22,6 @@ import { ChartWidgetProps } from '../props';
  * <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 | chartType}
+ * @group Chart Utilities
  */
 export declare const ChartWidget: FunctionComponent<ChartWidgetProps>;

package/dist/widgets/common/context-menu.d.ts

@@ -1,3 +1,8 @@
 /// <reference types="react" />
 import { ContextMenuProps } from '../../props';
+/**
+ * Context menu of a Drilldown Widget
+ *
+ * @group Drilldown
+ */
 export declare const ContextMenu: ({ position, closeContextMenu, itemSections, children, }: ContextMenuProps) => JSX.Element;

package/dist/widgets/common/drilldown-breadcrumbs/drilldown-breadcrumbs.d.ts

@@ -1,4 +1,9 @@
 import React from 'react';
 import { DrilldownBreadcrumbsProps } from '../../../props';
 export declare const BREADCRUMBS_BORDER_COLOR = "#F2F2F2";
+/**
+ * Drilldown breadcrumbs component
+ *
+ * @group Drilldown
+ */
 export declare const DrilldownBreadcrumbs: React.FC<DrilldownBreadcrumbsProps>;

package/dist/widgets/drilldown-widget.d.ts

@@ -45,5 +45,6 @@ import { DrilldownWidgetProps } from '../props';
  * ```
  * @param props - DrilldownWidget properties
  * @returns DrilldownWidget wrapper component
+ * @group Drilldown
  */
 export declare const DrilldownWidget: ({ drilldownDimensions, initialDimension, config, children, }: DrilldownWidgetProps) => JSX.Element;

package/dist/widgets/table-widget.d.ts

@@ -1,7 +1,7 @@
 import { type FunctionComponent } from 'react';
 import { TableWidgetProps } from '../props';
 /**
- * The TableWidget component extending the {@link Table} component to support widget style options.
+ * The TableWidget component extending the Table component to support widget style options.
  *
  * @example
  * Example of using the `Widget` component to