@sisense/sdk-ui 1.4.1 → 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>;