@sisense/sdk-ui 1.5.0 → 1.6.0

package/dist/indicator-chart.d.ts

@@ -56,5 +56,6 @@ import { IndicatorChartProps } from './props';
  * <img src="media://indicator-chart-example-1.png" width="400px" />
  * @param props - Indicator chart properties
  * @returns Indicator Chart component
+ * @group Charts
  */
 export declare const IndicatorChart: import("react").FunctionComponent<IndicatorChartProps>;

package/dist/line-chart.d.ts

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

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

@@ -7,9 +7,7 @@ export interface GetDashboardModelsOptions {
      */
     searchByTitle?: string;
     /**
-     * Boolean flag whether to include widgets in the dashboard model
-     *
-     * If not specified, the default value is `false`
+     * {@inheritDoc GetDashboardModelOptions.includeWidgets}
      */
     includeWidgets?: boolean;
 }

package/dist/models/dashboard/translate-dashboard.d.ts

@@ -1,3 +1,3 @@
 import { type DashboardDto } from '../../api/types/dashboard-dto';
 import { type DashboardModel } from './types';
-export declare function translateDashboard({ oid, title, datasource, widgets, }: DashboardDto): DashboardModel;
+export declare function translateDashboard({ oid, title, datasource, widgets, layout, }: DashboardDto): DashboardModel;

package/dist/models/dashboard/types.d.ts

@@ -1,8 +1,25 @@
 import { type DataSource } from '@sisense/sdk-data';
 import { WidgetModel } from '../widget/widget-model';
+/** @internal */
+export type Layout = {
+    columns: {
+        width: number;
+        cells: {
+            subcells: {
+                width: number;
+                elements: {
+                    height: number | string;
+                    widgetId: string;
+                }[];
+            }[];
+        }[];
+    }[];
+};
 export type DashboardModel = {
     oid: string;
     title: string;
     dataSource: DataSource;
     widgets?: WidgetModel[];
+    /** @internal */
+    layout?: Layout;
 };

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

@@ -96,6 +96,7 @@ export type DashboardModelSuccessState = {
  ```
  * @param params - Parameters of the dashboard to be retrieved
  * @returns Dashboard load state that contains the status of the execution, the result dashboard model, or the error if any
+ * @group Fusion Assets
  */
 export declare const useGetDashboardModel: (params: GetDashboardModelParams) => DashboardModelState;
 /**

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

@@ -81,6 +81,7 @@ 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
+ * @group Fusion Assets
  */
 export declare const useGetDashboardModels: (params?: GetDashboardModelsParams | undefined) => DashboardModelsState;
 /**

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

@@ -93,6 +93,7 @@ export type WidgetModelSuccessState = {
  ```
  * @param params - Parameters of the widget to be retrieved
  * @returns Widget load state that contains the status of the execution, the result widget model, or the error if one has occurred
+ * @group Fusion Assets
  */
 export declare const useGetWidgetModel: (params: GetWidgetModelParams) => WidgetModelState;
 /**

package/dist/models/widget/widget-model.d.ts

@@ -1,6 +1,6 @@
 import { Filter } from '@sisense/sdk-data';
 import { ChartDataOptions, TableDataOptions } from '../../chart-data-options/types';
-import { WidgetDto, WidgetType } from '../../dashboard-widget/types';
+import { Panel, WidgetDto, WidgetType } from '../../dashboard-widget/types';
 import { ChartProps, ChartWidgetProps, TableProps, TableWidgetProps } from '../../props';
 import { ExecuteQueryParams } from '../../query-execution';
 import { ChartType, DrilldownOptions, ChartStyleOptions, TableStyleOptions, CompleteThemeSettings } from '../../types';
@@ -10,6 +10,8 @@ import { ChartType, DrilldownOptions, ChartStyleOptions, TableStyleOptions, Comp
 export type WidgetDataOptions = ChartDataOptions | TableDataOptions;
 /**
  * Model of Sisense widget defined in the abstractions of Compose SDK.
+ *
+ * @group Fusion Assets
  */
 export declare class WidgetModel {
     /**
@@ -32,6 +34,12 @@ export declare class WidgetModel {
      * Widget type.
      */
     widgetType: WidgetType;
+    /** @internal */
+    pluginType: string;
+    /** @internal */
+    pluginPanels: Panel[];
+    /** @internal */
+    pluginStyles: any;
     /**
      * Widget data options.
      */
@@ -60,6 +68,7 @@ export declare class WidgetModel {
      * Creates a new widget model.
      *
      * @param widgetDto - The widget DTO to be converted to a widget model
+     * @param themeSettings - The theme settings to be used for the widget model
      * @internal
      */
     constructor(widgetDto: WidgetDto, themeSettings?: CompleteThemeSettings);

package/dist/pie-chart.d.ts

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

package/dist/pivot-table/pivot-table.d.ts

@@ -37,6 +37,7 @@ import { PivotTableProps } from '../props';
  * ```
  * @param props - Pivot Table properties
  * @returns Pivot Table component
+ * @group Data Grids
  * @alpha
  */
 export declare const PivotTable: React.FunctionComponent<PivotTableProps>;

package/dist/polar-chart.d.ts

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

package/dist/props.d.ts

@@ -759,13 +759,13 @@ export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource
      */
     highlights?: Filter[];
     /**
-     * {@inheritDoc ExecuteQueryByWidgetIdProps.filtersMergeStrategy}
+     * {@inheritDoc ExecuteQueryByWidgetIdParams.filtersMergeStrategy}
      *
      * @category Data
      */
     filtersMergeStrategy?: FiltersMergeStrategy;
     /**
-     * {@inheritDoc ExecuteQueryByWidgetIdProps.includeDashboardFilters}
+     * {@inheritDoc ExecuteQueryByWidgetIdParams.includeDashboardFilters}
      *
      * @category Data
      */

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

@@ -33,5 +33,6 @@ import { ExecuteQueryByWidgetIdProps } from '../props';
  * ```
  * @param props - ExecuteQueryByWidgetId properties
  * @returns ExecuteQueryByWidgetId component
+ * @group Fusion Assets
  */
 export declare const ExecuteQueryByWidgetId: FunctionComponent<ExecuteQueryByWidgetIdProps>;

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

@@ -35,5 +35,6 @@ import { ExecuteQueryProps } from '../props';
  * ```
  * @param props - ExecuteQuery properties
  * @returns ExecuteQuery component
+ * @group Queries
  */
 export declare const ExecuteQuery: FunctionComponent<ExecuteQueryProps>;

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/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;
 };
@@ -41,5 +47,6 @@ export declare const useThemeContext: () => {
  * @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

@@ -847,7 +847,7 @@ export type SeriesWithAlerts<T> = {
 };
 /**
  * Context menu position coordinates
- * Used in {@link ContextMenuProps} component
+ * Used in {@link ContextMenuProps}
  */
 export type MenuPosition = {
     /** Horizontal position */
@@ -857,7 +857,7 @@ export type MenuPosition = {
 };
 /**
  * Context menu section
- * Used in {@link ContextMenuProps} 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;