@sisense/sdk-ui-vue 1.34.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/dist/ai.cjs +141 -29
  2. package/dist/ai.js +1071 -890
  3. package/dist/index.cjs +1 -1
  4. package/dist/index.js +1687 -1461
  5. package/dist/packages/sdk-ui-vue/src/ai/components/chatbot.d.ts +0 -5
  6. package/dist/packages/sdk-ui-vue/src/ai/components/get-nlg-insights.d.ts +10 -9
  7. package/dist/packages/sdk-ui-vue/src/ai/composables/use-get-nlg-insights.d.ts +0 -5
  8. package/dist/packages/sdk-ui-vue/src/ai/composables/use-get-nlq-result.d.ts +7 -5
  9. package/dist/packages/sdk-ui-vue/src/ai/composables/use-get-query-recommendations.d.ts +17 -6
  10. package/dist/packages/sdk-ui-vue/src/ai/providers/ai-context-provider/ai-context-provider.d.ts +0 -5
  11. package/dist/packages/sdk-ui-vue/src/ai/sdk-ui-core-exports.d.ts +1 -1
  12. package/dist/packages/sdk-ui-vue/src/components/charts/area-chart.d.ts +10 -6
  13. package/dist/packages/sdk-ui-vue/src/components/charts/area-range-chart.d.ts +10 -7
  14. package/dist/packages/sdk-ui-vue/src/components/charts/areamap-chart.d.ts +10 -6
  15. package/dist/packages/sdk-ui-vue/src/components/charts/bar-chart.d.ts +10 -6
  16. package/dist/packages/sdk-ui-vue/src/components/charts/boxplot-chart.d.ts +10 -6
  17. package/dist/packages/sdk-ui-vue/src/components/charts/chart.d.ts +18 -8
  18. package/dist/packages/sdk-ui-vue/src/components/charts/column-chart.d.ts +10 -6
  19. package/dist/packages/sdk-ui-vue/src/components/charts/funnel-chart.d.ts +10 -6
  20. package/dist/packages/sdk-ui-vue/src/components/charts/indicator-chart.d.ts +10 -6
  21. package/dist/packages/sdk-ui-vue/src/components/charts/line-chart.d.ts +10 -6
  22. package/dist/packages/sdk-ui-vue/src/components/charts/pie-chart.d.ts +10 -6
  23. package/dist/packages/sdk-ui-vue/src/components/charts/pivot-table.d.ts +10 -4
  24. package/dist/packages/sdk-ui-vue/src/components/charts/polar-chart.d.ts +10 -6
  25. package/dist/packages/sdk-ui-vue/src/components/charts/scatter-chart.d.ts +10 -6
  26. package/dist/packages/sdk-ui-vue/src/components/charts/scattermap-chart.d.ts +10 -6
  27. package/dist/packages/sdk-ui-vue/src/components/charts/sunburst-chart.d.ts +10 -6
  28. package/dist/packages/sdk-ui-vue/src/components/charts/table.d.ts +22 -4
  29. package/dist/packages/sdk-ui-vue/src/components/charts/treemap-chart.d.ts +10 -6
  30. package/dist/packages/sdk-ui-vue/src/components/context-menu.d.ts +8 -2
  31. package/dist/packages/sdk-ui-vue/src/components/dashboard/dashboard-by-id.d.ts +8 -2
  32. package/dist/packages/sdk-ui-vue/src/components/dashboard/dashboard.d.ts +16 -5
  33. package/dist/packages/sdk-ui-vue/src/components/drilldown-breadcrumbs.d.ts +32 -8
  34. package/dist/packages/sdk-ui-vue/src/components/drilldown-widget.d.ts +0 -25
  35. package/dist/packages/sdk-ui-vue/src/components/filters/criteria-filter-tile.d.ts +24 -6
  36. package/dist/packages/sdk-ui-vue/src/components/filters/date-range-filter-tile.d.ts +32 -8
  37. package/dist/packages/sdk-ui-vue/src/components/filters/filter-tile.d.ts +94 -0
  38. package/dist/packages/sdk-ui-vue/src/components/filters/index.d.ts +1 -0
  39. package/dist/packages/sdk-ui-vue/src/components/filters/member-filter-tile.d.ts +32 -8
  40. package/dist/packages/sdk-ui-vue/src/components/filters/relative-date-filter-tile.d.ts +24 -6
  41. package/dist/packages/sdk-ui-vue/src/components/widgets/chart-widget.d.ts +32 -8
  42. package/dist/packages/sdk-ui-vue/src/components/widgets/index.d.ts +1 -1
  43. package/dist/packages/sdk-ui-vue/src/components/widgets/table-widget.d.ts +25 -19
  44. package/dist/packages/sdk-ui-vue/src/components/widgets/widget-by-id.d.ts +28 -4
  45. package/dist/packages/sdk-ui-vue/src/components/widgets/widget.d.ts +298 -0
  46. package/dist/packages/sdk-ui-vue/src/composables/index.d.ts +1 -0
  47. package/dist/packages/sdk-ui-vue/src/composables/use-composed-dashboard.d.ts +40 -0
  48. package/dist/packages/sdk-ui-vue/src/providers/sisense-context-provider/sisense-context-provider.d.ts +8 -2
  49. package/dist/packages/sdk-ui-vue/src/sdk-ui-core-exports.d.ts +1 -1
  50. package/dist/packages/sdk-ui-vue/src/utilities/dashboard-helpers.d.ts +0 -11
  51. package/dist/{use-tracking-07070102.cjs → use-tracking-1ffcd697.cjs} +257 -253
  52. package/dist/{use-tracking-0536543b.js → use-tracking-38c33085.js} +23698 -23641
  53. package/package.json +2 -2
  54. package/dist/packages/sdk-ui-vue/src/components/widgets/dashboard-widget.d.ts +0 -233
@@ -9,7 +9,7 @@ export { ChartWidgetProps };
9
9
  * Here's how you can use the ChartWidget component in a Vue application:
10
10
  * ```vue
11
11
  * <template>
12
- <DrilldownWidget :drilldownDimensions="drilldownDimensions" :initialDimension="dimProductName">
12
+ <DrilldownWidget :drilldownPaths="drilldownPaths" :initialDimension="dimProductName">
13
13
  <template
14
14
  #chart="{ drilldownFilters, drilldownDimension, onDataPointsSelected, onContextMenu }"
15
15
  >
@@ -53,7 +53,7 @@ export { ChartWidgetProps };
53
53
  * });
54
54
  * </script>
55
55
  * ```
56
- * <img src="media://chart-widget-with-drilldown-example-1.png" width="800px" />
56
+ * <img src="media://vue-widget-example.png" width="800px" />
57
57
  * @param props - ChartWidget properties
58
58
  * @returns ChartWidget component representing a chart type as specified in `ChartWidgetProps.`{@link ChartWidgetProps.chartType | chartType}
59
59
  * @group Dashboards
@@ -71,7 +71,10 @@ export declare const ChartWidget: import("vue").DefineComponent<{
71
71
  *
72
72
  * @category Chart
73
73
  */
74
- chartType: PropType<import("@sisense/sdk-ui-preact").ChartType>;
74
+ chartType: {
75
+ type: PropType<import("@sisense/sdk-ui-preact").ChartType>;
76
+ required: true;
77
+ };
75
78
  /**
76
79
  * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.contextMenuItems}
77
80
  *
@@ -84,7 +87,10 @@ export declare const ChartWidget: import("vue").DefineComponent<{
84
87
  *
85
88
  * @category Chart
86
89
  */
87
- dataOptions: PropType<import("@sisense/sdk-ui-preact").ChartDataOptions>;
90
+ dataOptions: {
91
+ type: PropType<import("@sisense/sdk-ui-preact").ChartDataOptions>;
92
+ required: true;
93
+ };
88
94
  /**
89
95
  * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataSource}
90
96
  *
@@ -109,7 +115,7 @@ export declare const ChartWidget: import("vue").DefineComponent<{
109
115
  *
110
116
  * @category Data
111
117
  */
112
- filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
118
+ filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
113
119
  /**
114
120
  * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.highlightSelectionDisabled}
115
121
  *
@@ -178,6 +184,12 @@ export declare const ChartWidget: import("vue").DefineComponent<{
178
184
  * @internal
179
185
  */
180
186
  widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | undefined>;
187
+ /**
188
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataReady}
189
+ *
190
+ * @category Callbacks
191
+ */
192
+ onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
181
193
  }, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
182
194
  [key: string]: any;
183
195
  }>) | 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<{
193
205
  *
194
206
  * @category Chart
195
207
  */
196
- chartType: PropType<import("@sisense/sdk-ui-preact").ChartType>;
208
+ chartType: {
209
+ type: PropType<import("@sisense/sdk-ui-preact").ChartType>;
210
+ required: true;
211
+ };
197
212
  /**
198
213
  * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.contextMenuItems}
199
214
  *
@@ -206,7 +221,10 @@ export declare const ChartWidget: import("vue").DefineComponent<{
206
221
  *
207
222
  * @category Chart
208
223
  */
209
- dataOptions: PropType<import("@sisense/sdk-ui-preact").ChartDataOptions>;
224
+ dataOptions: {
225
+ type: PropType<import("@sisense/sdk-ui-preact").ChartDataOptions>;
226
+ required: true;
227
+ };
210
228
  /**
211
229
  * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataSource}
212
230
  *
@@ -231,7 +249,7 @@ export declare const ChartWidget: import("vue").DefineComponent<{
231
249
  *
232
250
  * @category Data
233
251
  */
234
- filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
252
+ filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
235
253
  /**
236
254
  * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.highlightSelectionDisabled}
237
255
  *
@@ -300,4 +318,10 @@ export declare const ChartWidget: import("vue").DefineComponent<{
300
318
  * @internal
301
319
  */
302
320
  widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | undefined>;
321
+ /**
322
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataReady}
323
+ *
324
+ * @category Callbacks
325
+ */
326
+ onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
303
327
  }>>, {}, {}>;
@@ -1,4 +1,4 @@
1
1
  export { ChartWidget, type ChartWidgetProps } from './chart-widget';
2
- export { DashboardWidget, type DashboardWidgetProps } from './dashboard-widget';
3
2
  export { WidgetById, type WidgetByIdProps } from './widget-by-id';
4
3
  export { TableWidget, type TableWidgetProps } from './table-widget';
4
+ export { Widget, type WidgetProps, type WithCommonWidgetProps, type TextWidgetProps, type PluginWidgetProps, type PivotTableWidgetProps, } from './widget';
@@ -1,5 +1,5 @@
1
1
  /// <reference types="react" />
2
- import { type Prop } from 'vue';
2
+ import type { PropType } from 'vue';
3
3
  import { type TableWidgetProps } from '@sisense/sdk-ui-preact';
4
4
  export { TableWidgetProps };
5
5
  /**
@@ -27,25 +27,31 @@ export { TableWidgetProps };
27
27
  * @internal
28
28
  */
29
29
  export declare const TableWidget: import("vue").DefineComponent<{
30
- bottomSlot: Prop<import("react").ReactNode>;
31
- dataOptions: Prop<import("@sisense/sdk-ui-preact").TableDataOptions>;
32
- dataSource: Prop<import("@sisense/sdk-data").DataSource | undefined>;
33
- description: Prop<string | undefined>;
34
- filters: Prop<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
35
- styleOptions: Prop<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
36
- title: Prop<string | undefined>;
37
- topSlot: Prop<import("react").ReactNode>;
38
- widgetStyleOptions: Prop<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
30
+ bottomSlot: PropType<import("react").ReactNode>;
31
+ dataOptions: {
32
+ type: PropType<import("@sisense/sdk-ui-preact").TableDataOptions>;
33
+ required: true;
34
+ };
35
+ dataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
36
+ description: PropType<string | undefined>;
37
+ filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
38
+ styleOptions: PropType<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
39
+ title: PropType<string | undefined>;
40
+ topSlot: PropType<import("react").ReactNode>;
41
+ widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
39
42
  }, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
40
43
  [key: string]: any;
41
44
  }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
42
- bottomSlot: Prop<import("react").ReactNode>;
43
- dataOptions: Prop<import("@sisense/sdk-ui-preact").TableDataOptions>;
44
- dataSource: Prop<import("@sisense/sdk-data").DataSource | undefined>;
45
- description: Prop<string | undefined>;
46
- filters: Prop<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
47
- styleOptions: Prop<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
48
- title: Prop<string | undefined>;
49
- topSlot: Prop<import("react").ReactNode>;
50
- widgetStyleOptions: Prop<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
45
+ bottomSlot: PropType<import("react").ReactNode>;
46
+ dataOptions: {
47
+ type: PropType<import("@sisense/sdk-ui-preact").TableDataOptions>;
48
+ required: true;
49
+ };
50
+ dataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
51
+ description: PropType<string | undefined>;
52
+ filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
53
+ styleOptions: PropType<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
54
+ title: PropType<string | undefined>;
55
+ topSlot: PropType<import("react").ReactNode>;
56
+ widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
51
57
  }>>, {}, {}>;
@@ -41,7 +41,10 @@ export declare const WidgetById: import("vue").DefineComponent<{
41
41
  *
42
42
  * @category Widget
43
43
  */
44
- dashboardOid: PropType<string>;
44
+ dashboardOid: {
45
+ type: PropType<string>;
46
+ required: true;
47
+ };
45
48
  /**
46
49
  * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.description}
47
50
  *
@@ -125,9 +128,18 @@ export declare const WidgetById: import("vue").DefineComponent<{
125
128
  *
126
129
  * @category Widget
127
130
  */
128
- widgetOid: PropType<string>;
131
+ widgetOid: {
132
+ type: PropType<string>;
133
+ required: true;
134
+ };
129
135
  /** @internal */
130
136
  widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").WidgetByIdStyleOptions | undefined>;
137
+ /**
138
+ * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataReady}
139
+ *
140
+ * @category Callbacks
141
+ */
142
+ onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
131
143
  }, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
132
144
  [key: string]: any;
133
145
  }>) | 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<{
140
152
  *
141
153
  * @category Widget
142
154
  */
143
- dashboardOid: PropType<string>;
155
+ dashboardOid: {
156
+ type: PropType<string>;
157
+ required: true;
158
+ };
144
159
  /**
145
160
  * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.description}
146
161
  *
@@ -224,7 +239,16 @@ export declare const WidgetById: import("vue").DefineComponent<{
224
239
  *
225
240
  * @category Widget
226
241
  */
227
- widgetOid: PropType<string>;
242
+ widgetOid: {
243
+ type: PropType<string>;
244
+ required: true;
245
+ };
228
246
  /** @internal */
229
247
  widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").WidgetByIdStyleOptions | undefined>;
248
+ /**
249
+ * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataReady}
250
+ *
251
+ * @category Callbacks
252
+ */
253
+ onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
230
254
  }>>, {}, {}>;
@@ -0,0 +1,298 @@
1
+ import type { PropType } from 'vue';
2
+ import type { ChartWidgetProps, PivotTableWidgetProps as PivotTableWidgetPropsPreact, PluginWidgetProps, SoftUnion, TextWidgetProps, WithCommonWidgetProps } from '@sisense/sdk-ui-preact';
3
+ export { WithCommonWidgetProps, TextWidgetProps, PluginWidgetProps };
4
+ export interface PivotTableWidgetProps extends PivotTableWidgetPropsPreact {
5
+ }
6
+ /**
7
+ * Props of the {@link @sisense/sdk-ui-vue!Widget | `Widget`} component.
8
+ */
9
+ export type WidgetProps = SoftUnion<WithCommonWidgetProps<ChartWidgetProps, 'chart'> | WithCommonWidgetProps<PivotTableWidgetProps, 'pivot'> | WithCommonWidgetProps<TextWidgetProps, 'text'> | WithCommonWidgetProps<PluginWidgetProps, 'plugin'>>;
10
+ /**
11
+ * Facade component that renders a widget within a dashboard based on the widget type.
12
+ *
13
+ * @example
14
+ * ```vue
15
+ <script setup lang="ts">
16
+ import { Widget, type WidgetProps } from '@sisense/sdk-ui-vue';
17
+ import { measureFactory } from '@sisense/sdk-data';
18
+
19
+ const widgetProps: WidgetProps = {
20
+ id: 'widget-id',
21
+ widgetType: 'chart',
22
+ dataSource: DM.DataSource,
23
+ chartType: 'column',
24
+ dataOptions: {
25
+ category: [dimProductName],
26
+ value: [
27
+ {
28
+ column: measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue'),
29
+ sortType: 'sortDesc',
30
+ },
31
+ ],
32
+ breakBy: [],
33
+ },
34
+ };
35
+ </script>
36
+
37
+ <template>
38
+ <Widget
39
+ :id="widgetProps.id"
40
+ :widgetType="widgetProps.widgetType"
41
+ :dataSource="widgetProps.dataSource"
42
+ :chartType="widgetProps.chartType"
43
+ :dataOptions="widgetProps.dataOptions"
44
+ />
45
+ </template>
46
+ * ```
47
+ * <img src="media://vue-widget-example.png" width="800px" />
48
+ * @group Dashboards
49
+ */
50
+ export declare const Widget: import("vue").DefineComponent<{
51
+ /**
52
+ * Unique identifier of the widget
53
+ *
54
+ * @category Widget
55
+ */
56
+ id: {
57
+ type: PropType<string>;
58
+ required: true;
59
+ };
60
+ /**
61
+ * Widget type
62
+ *
63
+ * @category Widget
64
+ */
65
+ widgetType: {
66
+ type: PropType<"chart" | "pivot" | "text" | "plugin">;
67
+ required: true;
68
+ };
69
+ /**
70
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.chartType}
71
+ *
72
+ * @category Chart
73
+ */
74
+ chartType: PropType<import("@sisense/sdk-ui-preact").ChartType | undefined>;
75
+ /**
76
+ * {@inheritDoc @sisense/sdk-ui!PluginWidgetProps.pluginType}
77
+ *
78
+ * @category Widget
79
+ */
80
+ pluginType: PropType<string | undefined>;
81
+ /**
82
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataSource}
83
+ *
84
+ * @category Data
85
+ */
86
+ dataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
87
+ /**
88
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataOptions}
89
+ *
90
+ * @category Chart
91
+ */
92
+ dataOptions: PropType<import("@sisense/sdk-ui-preact").PivotTableDataOptions | import("@sisense/sdk-ui-preact").GenericDataOptions | import("@sisense/sdk-ui-preact").ChartDataOptions | undefined>;
93
+ /**
94
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.filters}
95
+ *
96
+ * @category Data
97
+ */
98
+ filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
99
+ /**
100
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.highlights}
101
+ *
102
+ * @category Data
103
+ */
104
+ highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
105
+ /**
106
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.styleOptions}
107
+ *
108
+ * @category Widget
109
+ */
110
+ styleOptions: PropType<unknown>;
111
+ /**
112
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.drilldownOptions}
113
+ *
114
+ * @category Widget
115
+ */
116
+ drilldownOptions: PropType<import("@sisense/sdk-ui-preact").DrilldownOptions | undefined>;
117
+ /**
118
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.title}
119
+ *
120
+ * @category Widget
121
+ */
122
+ title: PropType<string | undefined>;
123
+ /**
124
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.description}
125
+ *
126
+ * @category Widget
127
+ */
128
+ description: PropType<string | undefined>;
129
+ /**
130
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.highlightSelectionDisabled}
131
+ *
132
+ * @category Widget
133
+ * @internal
134
+ */
135
+ highlightSelectionDisabled: PropType<boolean | undefined>;
136
+ /**
137
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onBeforeRender}
138
+ *
139
+ * @category Callbacks
140
+ */
141
+ onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
142
+ /**
143
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataReady}
144
+ *
145
+ * @category Callbacks
146
+ */
147
+ onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
148
+ /**
149
+ * Optional handler function to process menu options before opening the context menu.
150
+ *
151
+ * @category Callbacks
152
+ * @internal
153
+ */
154
+ onBeforeMenuOpen: PropType<import("@sisense/sdk-ui-preact").BeforeMenuOpenHandler | undefined>;
155
+ /**
156
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointClick}
157
+ *
158
+ * @category Callbacks
159
+ */
160
+ 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>;
161
+ /**
162
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointContextMenu}
163
+ *
164
+ * @category Callbacks
165
+ */
166
+ onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
167
+ /**
168
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointsSelected}
169
+ *
170
+ * @category Callbacks
171
+ */
172
+ onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
173
+ }, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
174
+ [key: string]: any;
175
+ }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
176
+ /**
177
+ * Unique identifier of the widget
178
+ *
179
+ * @category Widget
180
+ */
181
+ id: {
182
+ type: PropType<string>;
183
+ required: true;
184
+ };
185
+ /**
186
+ * Widget type
187
+ *
188
+ * @category Widget
189
+ */
190
+ widgetType: {
191
+ type: PropType<"chart" | "pivot" | "text" | "plugin">;
192
+ required: true;
193
+ };
194
+ /**
195
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.chartType}
196
+ *
197
+ * @category Chart
198
+ */
199
+ chartType: PropType<import("@sisense/sdk-ui-preact").ChartType | undefined>;
200
+ /**
201
+ * {@inheritDoc @sisense/sdk-ui!PluginWidgetProps.pluginType}
202
+ *
203
+ * @category Widget
204
+ */
205
+ pluginType: PropType<string | undefined>;
206
+ /**
207
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataSource}
208
+ *
209
+ * @category Data
210
+ */
211
+ dataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
212
+ /**
213
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataOptions}
214
+ *
215
+ * @category Chart
216
+ */
217
+ dataOptions: PropType<import("@sisense/sdk-ui-preact").PivotTableDataOptions | import("@sisense/sdk-ui-preact").GenericDataOptions | import("@sisense/sdk-ui-preact").ChartDataOptions | undefined>;
218
+ /**
219
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.filters}
220
+ *
221
+ * @category Data
222
+ */
223
+ filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
224
+ /**
225
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.highlights}
226
+ *
227
+ * @category Data
228
+ */
229
+ highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
230
+ /**
231
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.styleOptions}
232
+ *
233
+ * @category Widget
234
+ */
235
+ styleOptions: PropType<unknown>;
236
+ /**
237
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.drilldownOptions}
238
+ *
239
+ * @category Widget
240
+ */
241
+ drilldownOptions: PropType<import("@sisense/sdk-ui-preact").DrilldownOptions | undefined>;
242
+ /**
243
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.title}
244
+ *
245
+ * @category Widget
246
+ */
247
+ title: PropType<string | undefined>;
248
+ /**
249
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.description}
250
+ *
251
+ * @category Widget
252
+ */
253
+ description: PropType<string | undefined>;
254
+ /**
255
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.highlightSelectionDisabled}
256
+ *
257
+ * @category Widget
258
+ * @internal
259
+ */
260
+ highlightSelectionDisabled: PropType<boolean | undefined>;
261
+ /**
262
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onBeforeRender}
263
+ *
264
+ * @category Callbacks
265
+ */
266
+ onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
267
+ /**
268
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataReady}
269
+ *
270
+ * @category Callbacks
271
+ */
272
+ onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
273
+ /**
274
+ * Optional handler function to process menu options before opening the context menu.
275
+ *
276
+ * @category Callbacks
277
+ * @internal
278
+ */
279
+ onBeforeMenuOpen: PropType<import("@sisense/sdk-ui-preact").BeforeMenuOpenHandler | undefined>;
280
+ /**
281
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointClick}
282
+ *
283
+ * @category Callbacks
284
+ */
285
+ 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>;
286
+ /**
287
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointContextMenu}
288
+ *
289
+ * @category Callbacks
290
+ */
291
+ onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
292
+ /**
293
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointsSelected}
294
+ *
295
+ * @category Callbacks
296
+ */
297
+ onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
298
+ }>>, {}, {}>;
@@ -8,4 +8,5 @@ export { useGetWidgetModel } from './use-get-widget-model.js';
8
8
  export { useGetHierarchyModels } from './use-get-hierarchy-models.js';
9
9
  export { useFetch } from './use-fetch.js';
10
10
  export { usePlugins } from './use-plugins.js';
11
+ export { useComposedDashboard, type ComposableDashboardProps } from './use-composed-dashboard.js';
11
12
  export type { UseFetchOptions } from './use-fetch.js';
@@ -0,0 +1,40 @@
1
+ import { type Ref } from 'vue';
2
+ import { type ComposableDashboardProps as ComposableDashboardPropsPreact, type UseComposedDashboardOptions, type WidgetsPanelLayout } from '@sisense/sdk-ui-preact';
3
+ import type { DashboardProps } from '../components/dashboard';
4
+ import type { MaybeRef } from '../types';
5
+ import type { Filter, FilterRelations } from '@sisense/sdk-data';
6
+ export interface ComposableDashboardProps extends ComposableDashboardPropsPreact {
7
+ }
8
+ /**
9
+ * A Vue composable function `useComposedDashboard` that takes in separate dashboard elements and
10
+ * composes them into a coordinated dashboard with cross filtering, and change detection.
11
+ *
12
+ * @example
13
+ * How to use `useComposedDashboard` within a Vue component:
14
+ * ```vue
15
+ <script setup lang="ts">
16
+ import { Widget, FilterTile, useComposedDashboard, type DashboardProps } from '@sisense/sdk-ui-vue';
17
+
18
+ const initialDashboardProps: DashboardProps = { ... };
19
+ const { dashboard } = useComposedDashboard(initialDashboardProps);
20
+ </script>
21
+ <template>
22
+ <div>
23
+ <FilterTile v-for="(filter, index) in dashboard.filters" :key="index" :filter="filter" />
24
+ <Widget v-for="(widgetProps, index) in dashboard.widgets" :key="index" v-bind="widgetProps" />
25
+ </div>
26
+ </template>
27
+ * ```
28
+ *
29
+ * The composable returns an object with the following properties:
30
+ * - `dashboard`: The composable dashboard object containing the current state of the dashboard.
31
+ * - `setFilters`: API to set filters on the dashboard.
32
+ * - `setWidgetsLayout`: API to set the layout of the widgets on the dashboard.
33
+ *
34
+ * @group Dashboards
35
+ */
36
+ export declare const useComposedDashboard: <D extends ComposableDashboardProps | DashboardProps>(initialDashboard: MaybeRef<D>, options?: UseComposedDashboardOptions) => {
37
+ dashboard: Ref<D>;
38
+ setFilters: (filters: Filter[] | FilterRelations) => void;
39
+ setWidgetsLayout: (newLayout: WidgetsPanelLayout) => void;
40
+ };
@@ -69,7 +69,10 @@ export declare const SisenseContextProvider: import("vue").DefineComponent<{
69
69
  *
70
70
  * @category Sisense App
71
71
  */
72
- url: PropType<string>;
72
+ url: {
73
+ type: PropType<string>;
74
+ required: true;
75
+ };
73
76
  /**
74
77
  * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoEnabled}
75
78
  *
@@ -113,7 +116,10 @@ export declare const SisenseContextProvider: import("vue").DefineComponent<{
113
116
  *
114
117
  * @category Sisense App
115
118
  */
116
- url: PropType<string>;
119
+ url: {
120
+ type: PropType<string>;
121
+ required: true;
122
+ };
117
123
  /**
118
124
  * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoEnabled}
119
125
  *
@@ -1,2 +1,2 @@
1
1
  export { boxWhiskerProcessResult } from '@sisense/sdk-ui-preact';
2
- export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, CommonWidgetProps, WidgetProps, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, GetHierarchyModelsParams, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, DashboardWidgetStyleOptions, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, IndicatorBeforeRenderHandler, IndicatorRenderOptions, DashboardLayoutOptions, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, Member, FilterVariant, CriteriaFilterType, } from '@sisense/sdk-ui-preact';
2
+ export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, GetHierarchyModelsParams, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, IndicatorBeforeRenderHandler, IndicatorRenderOptions, DashboardLayoutOptions, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, Member, FilterVariant, TranslationConfig, } from '@sisense/sdk-ui-preact';
@@ -62,17 +62,6 @@ export declare const addFilters: (dashboard: DashboardProps, newFilters: Filter[
62
62
  * @returns A new dashboard instance with the specified filter replaced.
63
63
  */
64
64
  export declare const replaceFilter: (dashboard: DashboardProps, filterToReplace: Filter, newFilter: Filter) => DashboardProps;
65
- /**
66
- * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.modifyFilter}
67
- *
68
- * @deprecated Use {@link replaceFilter} instead
69
- *
70
- * @param dashboard - The original dashboard (`DashboardProps`) containing the filter to modify.
71
- * @param filterToModify - The existing filter to be modified.
72
- * @param newFilter - The new filter to replace the existing one.
73
- * @returns A new dashboard instance with the specified filter modified.
74
- */
75
- export declare const modifyFilter: (dashboard: DashboardProps, filterToModify: Filter, newFilter: Filter) => DashboardProps;
76
65
  /**
77
66
  * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.removeFilter}
78
67
  *