@sisense/sdk-ui-vue 1.33.0 → 2.0.0

package/dist/packages/sdk-ui-vue/src/components/filters/relative-date-filter-tile.d.ts

@@ -47,11 +47,17 @@ export declare const RelativeDateFilterTile: import("vue").DefineComponent<{
     /**
      * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.title}
      */
-    title: PropType<string>;
+    title: {
+        type: PropType<string>;
+        required: true;
+    };
     /**
      * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.filter}
      */
-    filter: PropType<import("@sisense/sdk-data").Filter>;
+    filter: {
+        type: PropType<import("@sisense/sdk-data").Filter>;
+        required: true;
+    };
     /**
      * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.arrangement}
      */
@@ -59,7 +65,10 @@ export declare const RelativeDateFilterTile: import("vue").DefineComponent<{
     /**
      * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.onUpdate}
      */
-    onUpdate: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
+    onUpdate: {
+        type: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
+        required: true;
+    };
     /**
      * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.limit}
      */
@@ -71,7 +80,7 @@ export declare const RelativeDateFilterTile: import("vue").DefineComponent<{
      * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.tileDesignOptions}
      * @internal
      */
-    tileDesignOptions: PropType<import("@sisense/sdk-ui/dist/packages/sdk-ui/src/filters/components/filter-tile-container.js").FilterTileDesignOptions | undefined>;
+    tileDesignOptions: PropType<import("@sisense/sdk-ui/dist/packages/sdk-ui/src/filters/components/filter-tile-container").FilterTileDesignOptions | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.onDelete}
      */
@@ -86,11 +95,17 @@ export declare const RelativeDateFilterTile: import("vue").DefineComponent<{
     /**
      * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.title}
      */
-    title: PropType<string>;
+    title: {
+        type: PropType<string>;
+        required: true;
+    };
     /**
      * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.filter}
      */
-    filter: PropType<import("@sisense/sdk-data").Filter>;
+    filter: {
+        type: PropType<import("@sisense/sdk-data").Filter>;
+        required: true;
+    };
     /**
      * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.arrangement}
      */
@@ -98,7 +113,10 @@ export declare const RelativeDateFilterTile: import("vue").DefineComponent<{
     /**
      * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.onUpdate}
      */
-    onUpdate: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
+    onUpdate: {
+        type: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
+        required: true;
+    };
     /**
      * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.limit}
      */
@@ -110,7 +128,7 @@ export declare const RelativeDateFilterTile: import("vue").DefineComponent<{
      * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.tileDesignOptions}
      * @internal
      */
-    tileDesignOptions: PropType<import("@sisense/sdk-ui/dist/packages/sdk-ui/src/filters/components/filter-tile-container.js").FilterTileDesignOptions | undefined>;
+    tileDesignOptions: PropType<import("@sisense/sdk-ui/dist/packages/sdk-ui/src/filters/components/filter-tile-container").FilterTileDesignOptions | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.onDelete}
      */

package/dist/packages/sdk-ui-vue/src/components/widgets/chart-widget.d.ts

@@ -9,7 +9,7 @@ export { ChartWidgetProps };
  * Here's how you can use the ChartWidget component in a Vue application:
  * ```vue
  * <template>
-    <DrilldownWidget :drilldownDimensions="drilldownDimensions" :initialDimension="dimProductName">
+    <DrilldownWidget :drilldownPaths="drilldownPaths" :initialDimension="dimProductName">
       <template
         #chart="{ drilldownFilters, drilldownDimension, onDataPointsSelected, onContextMenu }"
       >
@@ -53,7 +53,7 @@ export { ChartWidgetProps };
  * });
  * </script>
  * ```
- * <img src="media://chart-widget-with-drilldown-example-1.png" width="800px" />
+ * <img src="media://vue-widget-example.png" width="800px" />
  * @param props - ChartWidget properties
  * @returns ChartWidget component representing a chart type as specified in `ChartWidgetProps.`{@link ChartWidgetProps.chartType | chartType}
  * @group Dashboards
@@ -71,7 +71,10 @@ export declare const ChartWidget: import("vue").DefineComponent<{
      *
      * @category Chart
      */
-    chartType: PropType<import("@sisense/sdk-ui-preact").ChartType>;
+    chartType: {
+        type: PropType<import("@sisense/sdk-ui-preact").ChartType>;
+        required: true;
+    };
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.contextMenuItems}
      *
@@ -84,7 +87,10 @@ export declare const ChartWidget: import("vue").DefineComponent<{
      *
      * @category Chart
      */
-    dataOptions: PropType<import("@sisense/sdk-ui-preact").ChartDataOptions>;
+    dataOptions: {
+        type: PropType<import("@sisense/sdk-ui-preact").ChartDataOptions>;
+        required: true;
+    };
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataSource}
      *
@@ -109,7 +115,7 @@ export declare const ChartWidget: import("vue").DefineComponent<{
      *
      * @category Data
      */
-    filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
+    filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.highlightSelectionDisabled}
      *
@@ -178,6 +184,12 @@ export declare const ChartWidget: import("vue").DefineComponent<{
      * @internal
      */
     widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataReady}
+     *
+     * @category Callbacks
+     */
+    onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
 }, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
 }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
@@ -193,7 +205,10 @@ export declare const ChartWidget: import("vue").DefineComponent<{
      *
      * @category Chart
      */
-    chartType: PropType<import("@sisense/sdk-ui-preact").ChartType>;
+    chartType: {
+        type: PropType<import("@sisense/sdk-ui-preact").ChartType>;
+        required: true;
+    };
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.contextMenuItems}
      *
@@ -206,7 +221,10 @@ export declare const ChartWidget: import("vue").DefineComponent<{
      *
      * @category Chart
      */
-    dataOptions: PropType<import("@sisense/sdk-ui-preact").ChartDataOptions>;
+    dataOptions: {
+        type: PropType<import("@sisense/sdk-ui-preact").ChartDataOptions>;
+        required: true;
+    };
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataSource}
      *
@@ -231,7 +249,7 @@ export declare const ChartWidget: import("vue").DefineComponent<{
      *
      * @category Data
      */
-    filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
+    filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.highlightSelectionDisabled}
      *
@@ -300,4 +318,10 @@ export declare const ChartWidget: import("vue").DefineComponent<{
      * @internal
      */
     widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataReady}
+     *
+     * @category Callbacks
+     */
+    onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
 }>>, {}, {}>;

package/dist/packages/sdk-ui-vue/src/components/widgets/index.d.ts

@@ -1,4 +1,4 @@
 export { ChartWidget, type ChartWidgetProps } from './chart-widget';
-export { DashboardWidget, type DashboardWidgetProps } from './dashboard-widget';
 export { WidgetById, type WidgetByIdProps } from './widget-by-id';
 export { TableWidget, type TableWidgetProps } from './table-widget';
+export { Widget, type WidgetProps, type WithCommonWidgetProps, type TextWidgetProps, type PluginWidgetProps, type PivotTableWidgetProps, } from './widget';

package/dist/packages/sdk-ui-vue/src/components/widgets/table-widget.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { type Prop } from 'vue';
+import type { PropType } from 'vue';
 import { type TableWidgetProps } from '@sisense/sdk-ui-preact';
 export { TableWidgetProps };
 /**
@@ -27,25 +27,31 @@ export { TableWidgetProps };
  * @internal
  */
 export declare const TableWidget: import("vue").DefineComponent<{
-    bottomSlot: Prop<import("react").ReactNode>;
-    dataOptions: Prop<import("@sisense/sdk-ui-preact").TableDataOptions>;
-    dataSource: Prop<import("@sisense/sdk-data").DataSource | undefined>;
-    description: Prop<string | undefined>;
-    filters: Prop<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
-    styleOptions: Prop<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
-    title: Prop<string | undefined>;
-    topSlot: Prop<import("react").ReactNode>;
-    widgetStyleOptions: Prop<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
+    bottomSlot: PropType<import("react").ReactNode>;
+    dataOptions: {
+        type: PropType<import("@sisense/sdk-ui-preact").TableDataOptions>;
+        required: true;
+    };
+    dataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
+    description: PropType<string | undefined>;
+    filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
+    title: PropType<string | undefined>;
+    topSlot: PropType<import("react").ReactNode>;
+    widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
 }, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
 }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    bottomSlot: Prop<import("react").ReactNode>;
-    dataOptions: Prop<import("@sisense/sdk-ui-preact").TableDataOptions>;
-    dataSource: Prop<import("@sisense/sdk-data").DataSource | undefined>;
-    description: Prop<string | undefined>;
-    filters: Prop<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
-    styleOptions: Prop<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
-    title: Prop<string | undefined>;
-    topSlot: Prop<import("react").ReactNode>;
-    widgetStyleOptions: Prop<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
+    bottomSlot: PropType<import("react").ReactNode>;
+    dataOptions: {
+        type: PropType<import("@sisense/sdk-ui-preact").TableDataOptions>;
+        required: true;
+    };
+    dataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
+    description: PropType<string | undefined>;
+    filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
+    title: PropType<string | undefined>;
+    topSlot: PropType<import("react").ReactNode>;
+    widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
 }>>, {}, {}>;

package/dist/packages/sdk-ui-vue/src/components/widgets/widget-by-id.d.ts

@@ -41,7 +41,10 @@ export declare const WidgetById: import("vue").DefineComponent<{
      *
      * @category Widget
      */
-    dashboardOid: PropType<string>;
+    dashboardOid: {
+        type: PropType<string>;
+        required: true;
+    };
     /**
      * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.description}
      *
@@ -125,9 +128,18 @@ export declare const WidgetById: import("vue").DefineComponent<{
      *
      * @category Widget
      */
-    widgetOid: PropType<string>;
+    widgetOid: {
+        type: PropType<string>;
+        required: true;
+    };
     /** @internal */
     widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").WidgetByIdStyleOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataReady}
+     *
+     * @category Callbacks
+     */
+    onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
 }, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
 }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
@@ -140,7 +152,10 @@ export declare const WidgetById: import("vue").DefineComponent<{
      *
      * @category Widget
      */
-    dashboardOid: PropType<string>;
+    dashboardOid: {
+        type: PropType<string>;
+        required: true;
+    };
     /**
      * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.description}
      *
@@ -224,7 +239,16 @@ export declare const WidgetById: import("vue").DefineComponent<{
      *
      * @category Widget
      */
-    widgetOid: PropType<string>;
+    widgetOid: {
+        type: PropType<string>;
+        required: true;
+    };
     /** @internal */
     widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").WidgetByIdStyleOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataReady}
+     *
+     * @category Callbacks
+     */
+    onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
 }>>, {}, {}>;

package/dist/packages/sdk-ui-vue/src/components/widgets/widget.d.ts

@@ -0,0 +1,298 @@
+import type { PropType } from 'vue';
+import type { ChartWidgetProps, PivotTableWidgetProps as PivotTableWidgetPropsPreact, PluginWidgetProps, SoftUnion, TextWidgetProps, WithCommonWidgetProps } from '@sisense/sdk-ui-preact';
+export { WithCommonWidgetProps, TextWidgetProps, PluginWidgetProps };
+export interface PivotTableWidgetProps extends PivotTableWidgetPropsPreact {
+}
+/**
+ * Props of the {@link @sisense/sdk-ui-vue!Widget | `Widget`} component.
+ */
+export type WidgetProps = SoftUnion<WithCommonWidgetProps<ChartWidgetProps, 'chart'> | WithCommonWidgetProps<PivotTableWidgetProps, 'pivot'> | WithCommonWidgetProps<TextWidgetProps, 'text'> | WithCommonWidgetProps<PluginWidgetProps, 'plugin'>>;
+/**
+ * Facade component that renders a widget within a dashboard based on the widget type.
+ *
+ * @example
+  * ```vue
+<script setup lang="ts">
+import { Widget, type WidgetProps } from '@sisense/sdk-ui-vue';
+import { measureFactory } from '@sisense/sdk-data';
+
+const widgetProps: WidgetProps = {
+  id: 'widget-id',
+  widgetType: 'chart',
+  dataSource: DM.DataSource,
+  chartType: 'column',
+  dataOptions: {
+    category: [dimProductName],
+    value: [
+      {
+        column: measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue'),
+        sortType: 'sortDesc',
+      },
+    ],
+    breakBy: [],
+  },
+};
+</script>
+
+<template>
+  <Widget
+    :id="widgetProps.id"
+    :widgetType="widgetProps.widgetType"
+    :dataSource="widgetProps.dataSource"
+    :chartType="widgetProps.chartType"
+    :dataOptions="widgetProps.dataOptions"
+  />
+</template>
+ * ```
+ * <img src="media://vue-widget-example.png" width="800px" />
+ * @group Dashboards
+ */
+export declare const Widget: import("vue").DefineComponent<{
+    /**
+     * Unique identifier of the widget
+     *
+     * @category Widget
+     */
+    id: {
+        type: PropType<string>;
+        required: true;
+    };
+    /**
+     * Widget type
+     *
+     * @category Widget
+     */
+    widgetType: {
+        type: PropType<"chart" | "pivot" | "text" | "plugin">;
+        required: true;
+    };
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.chartType}
+     *
+     * @category Chart
+     */
+    chartType: PropType<import("@sisense/sdk-ui-preact").ChartType | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PluginWidgetProps.pluginType}
+     *
+     * @category Widget
+     */
+    pluginType: PropType<string | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataSource}
+     *
+     * @category Data
+     */
+    dataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataOptions}
+     *
+     * @category Chart
+     */
+    dataOptions: PropType<import("@sisense/sdk-ui-preact").PivotTableDataOptions | import("@sisense/sdk-ui-preact").GenericDataOptions | import("@sisense/sdk-ui-preact").ChartDataOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.filters}
+     *
+     * @category Data
+     */
+    filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.highlights}
+     *
+     * @category Data
+     */
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.styleOptions}
+     *
+     * @category Widget
+     */
+    styleOptions: PropType<unknown>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.drilldownOptions}
+     *
+     * @category Widget
+     */
+    drilldownOptions: PropType<import("@sisense/sdk-ui-preact").DrilldownOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.title}
+     *
+     * @category Widget
+     */
+    title: PropType<string | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.description}
+     *
+     * @category Widget
+     */
+    description: PropType<string | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.highlightSelectionDisabled}
+     *
+     * @category Widget
+     * @internal
+     */
+    highlightSelectionDisabled: PropType<boolean | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onBeforeRender}
+     *
+     * @category Callbacks
+     */
+    onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataReady}
+     *
+     * @category Callbacks
+     */
+    onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
+    /**
+     * Optional handler function to process menu options before opening the context menu.
+     *
+     * @category Callbacks
+     * @internal
+     */
+    onBeforeMenuOpen: PropType<import("@sisense/sdk-ui-preact").BeforeMenuOpenHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointClick}
+     *
+     * @category Callbacks
+     */
+    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointContextMenu}
+     *
+     * @category Callbacks
+     */
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointsSelected}
+     *
+     * @category Callbacks
+     */
+    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
+}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Unique identifier of the widget
+     *
+     * @category Widget
+     */
+    id: {
+        type: PropType<string>;
+        required: true;
+    };
+    /**
+     * Widget type
+     *
+     * @category Widget
+     */
+    widgetType: {
+        type: PropType<"chart" | "pivot" | "text" | "plugin">;
+        required: true;
+    };
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.chartType}
+     *
+     * @category Chart
+     */
+    chartType: PropType<import("@sisense/sdk-ui-preact").ChartType | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PluginWidgetProps.pluginType}
+     *
+     * @category Widget
+     */
+    pluginType: PropType<string | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataSource}
+     *
+     * @category Data
+     */
+    dataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataOptions}
+     *
+     * @category Chart
+     */
+    dataOptions: PropType<import("@sisense/sdk-ui-preact").PivotTableDataOptions | import("@sisense/sdk-ui-preact").GenericDataOptions | import("@sisense/sdk-ui-preact").ChartDataOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.filters}
+     *
+     * @category Data
+     */
+    filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.highlights}
+     *
+     * @category Data
+     */
+    highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.styleOptions}
+     *
+     * @category Widget
+     */
+    styleOptions: PropType<unknown>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.drilldownOptions}
+     *
+     * @category Widget
+     */
+    drilldownOptions: PropType<import("@sisense/sdk-ui-preact").DrilldownOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.title}
+     *
+     * @category Widget
+     */
+    title: PropType<string | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.description}
+     *
+     * @category Widget
+     */
+    description: PropType<string | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.highlightSelectionDisabled}
+     *
+     * @category Widget
+     * @internal
+     */
+    highlightSelectionDisabled: PropType<boolean | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onBeforeRender}
+     *
+     * @category Callbacks
+     */
+    onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataReady}
+     *
+     * @category Callbacks
+     */
+    onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
+    /**
+     * Optional handler function to process menu options before opening the context menu.
+     *
+     * @category Callbacks
+     * @internal
+     */
+    onBeforeMenuOpen: PropType<import("@sisense/sdk-ui-preact").BeforeMenuOpenHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointClick}
+     *
+     * @category Callbacks
+     */
+    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointContextMenu}
+     *
+     * @category Callbacks
+     */
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointsSelected}
+     *
+     * @category Callbacks
+     */
+    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
+}>>, {}, {}>;

package/dist/packages/sdk-ui-vue/src/composables/index.d.ts

@@ -1,5 +1,6 @@
 export { useExecuteQuery } from './use-execute-query.js';
 export { useExecuteQueryByWidgetId } from './use-execute-query-by-widget-id.js';
+export { useExecuteCsvQuery } from './use-execute-csv-query.js';
 export { useGetDashboardModel } from './use-get-dashboard-model.js';
 export { useGetDashboardModels } from './use-get-dashboard-models.js';
 export { useGetSharedFormula } from './use-get-shared-formula.js';
@@ -7,4 +8,5 @@ export { useGetWidgetModel } from './use-get-widget-model.js';
 export { useGetHierarchyModels } from './use-get-hierarchy-models.js';
 export { useFetch } from './use-fetch.js';
 export { usePlugins } from './use-plugins.js';
+export { useComposedDashboard, type ComposableDashboardProps } from './use-composed-dashboard.js';
 export type { UseFetchOptions } from './use-fetch.js';

package/dist/packages/sdk-ui-vue/src/composables/use-composed-dashboard.d.ts

@@ -0,0 +1,40 @@
+import { type Ref } from 'vue';
+import { type ComposableDashboardProps as ComposableDashboardPropsPreact, type UseComposedDashboardOptions, type WidgetsPanelLayout } from '@sisense/sdk-ui-preact';
+import type { DashboardProps } from '../components/dashboard';
+import type { MaybeRef } from '../types';
+import type { Filter, FilterRelations } from '@sisense/sdk-data';
+export interface ComposableDashboardProps extends ComposableDashboardPropsPreact {
+}
+/**
+ * A Vue composable function `useComposedDashboard` that takes in separate dashboard elements and
+ * composes them into a coordinated dashboard with cross filtering, and change detection.
+ *
+ * @example
+ * How to use `useComposedDashboard` within a Vue component:
+ * ```vue
+<script setup lang="ts">
+import { Widget, FilterTile, useComposedDashboard, type DashboardProps } from '@sisense/sdk-ui-vue';
+
+const initialDashboardProps: DashboardProps = { ... };
+const { dashboard } = useComposedDashboard(initialDashboardProps);
+</script>
+<template>
+  <div>
+    <FilterTile v-for="(filter, index) in dashboard.filters" :key="index" :filter="filter" />
+    <Widget v-for="(widgetProps, index) in dashboard.widgets" :key="index" v-bind="widgetProps" />
+  </div>
+</template>
+ * ```
+ *
+ * The composable returns an object with the following properties:
+ * - `dashboard`: The composable dashboard object containing the current state of the dashboard.
+ * - `setFilters`: API to set filters on the dashboard.
+ * - `setWidgetsLayout`: API to set the layout of the widgets on the dashboard.
+ *
+ * @group Dashboards
+ */
+export declare const useComposedDashboard: <D extends ComposableDashboardProps | DashboardProps>(initialDashboard: MaybeRef<D>, options?: UseComposedDashboardOptions) => {
+    dashboard: Ref<D>;
+    setFilters: (filters: Filter[] | FilterRelations) => void;
+    setWidgetsLayout: (newLayout: WidgetsPanelLayout) => void;
+};