@sisense/sdk-ui-vue 1.3.0 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (53) hide show
  1. package/dist/index.js +81798 -64908
  2. package/dist/src/components/charts/area-chart.d.ts +20 -7
  3. package/dist/src/components/charts/areamap-chart.d.ts +19 -7
  4. package/dist/src/components/charts/bar-chart.d.ts +21 -8
  5. package/dist/src/components/charts/boxplot-chart.d.ts +23 -9
  6. package/dist/src/components/charts/chart-widget.d.ts +38 -7
  7. package/dist/src/components/charts/chart.d.ts +12 -23
  8. package/dist/src/components/charts/column-chart.d.ts +21 -8
  9. package/dist/src/components/charts/dashboard-widget.d.ts +9 -9
  10. package/dist/src/components/charts/funnel-chart.d.ts +19 -5
  11. package/dist/src/components/charts/index.d.ts +1 -0
  12. package/dist/src/components/charts/indicator-chart.d.ts +18 -7
  13. package/dist/src/components/charts/line-chart.d.ts +18 -6
  14. package/dist/src/components/charts/pie-chart.d.ts +20 -8
  15. package/dist/src/components/charts/pivot-table.d.ts +41 -0
  16. package/dist/src/components/charts/polar-chart.d.ts +20 -8
  17. package/dist/src/components/charts/scatter-chart.d.ts +26 -8
  18. package/dist/src/components/charts/scattermap-chart.d.ts +20 -5
  19. package/dist/src/components/charts/sunburst-chart.d.ts +14 -6
  20. package/dist/src/components/charts/table-widget.d.ts +4 -2
  21. package/dist/src/components/charts/table.d.ts +4 -3
  22. package/dist/src/components/charts/treemap-chart.d.ts +19 -7
  23. package/dist/src/components/context-menu.d.ts +32 -0
  24. package/dist/src/components/drilldown-breadcrumbs.d.ts +41 -0
  25. package/dist/src/components/drilldown-widget.d.ts +44 -0
  26. package/dist/src/components/drilldown-widget.vue.d.ts +2 -44
  27. package/dist/src/components/filters/basic-member-filter-tile.d.ts +1 -0
  28. package/dist/src/components/filters/criteria-filter-tile.d.ts +19 -4
  29. package/dist/src/components/filters/date-range-filter-tile.d.ts +14 -5
  30. package/dist/src/components/filters/member-filter-tile.d.ts +16 -5
  31. package/dist/src/composables/index.d.ts +6 -0
  32. package/dist/src/composables/use-execute-query-by-widget-id.d.ts +42 -0
  33. package/dist/src/composables/use-execute-query.d.ts +44 -0
  34. package/dist/src/composables/use-get-dashboard-model.d.ts +41 -0
  35. package/dist/src/composables/use-get-dashboard-models.d.ts +38 -0
  36. package/dist/src/composables/use-get-shared-formula.d.ts +45 -0
  37. package/dist/src/composables/use-get-widget-model.d.ts +41 -0
  38. package/dist/src/composables/use-tracking.d.ts +39 -0
  39. package/dist/src/lib.d.ts +2 -8
  40. package/dist/src/providers/index.d.ts +1 -1
  41. package/dist/src/providers/sisense-context-provider.d.ts +50 -5
  42. package/dist/src/providers/theme-provider.d.ts +61 -6
  43. package/dist/src/sdk-ui-core-exports.d.ts +5 -0
  44. package/dist/src/utils.d.ts +3 -0
  45. package/package.json +1 -1
  46. package/dist/src/hooks/index.d.ts +0 -6
  47. package/dist/src/hooks/use-execute-query-by-widget-id.d.ts +0 -7
  48. package/dist/src/hooks/use-execute-query.d.ts +0 -11
  49. package/dist/src/hooks/use-get-dashboard-model.d.ts +0 -4
  50. package/dist/src/hooks/use-get-dashboard-models.d.ts +0 -4
  51. package/dist/src/hooks/use-get-shared-formula.d.ts +0 -4
  52. package/dist/src/hooks/use-get-widget-model.d.ts +0 -4
  53. /package/dist/src/{hooks → composables}/use-custom-drilldown.d.ts +0 -0
@@ -1,24 +1,37 @@
1
1
  import type { PropType } from 'vue';
2
2
  /**
3
- * A Vue component that wraps the AreaChart Preact component for use in Vue applications.
4
- * It maintains compatibility with Vue's reactivity system while preserving the functionality of the AreaChart.
3
+ * A Vue component similar to a {@link LineChart},
4
+ * but with filled in areas under each line and an option to display them as stacked.
5
+ * More info on [Sisense Documentation page](https://docs.sisense.com/main/SisenseLinux/area-chart.htm).
5
6
  *
7
+ * <img src="media://area-chart-example-1.png" width="800"/>
6
8
  * @example
7
9
  * Here's how you can use the AreaChart component in a Vue application:
8
10
  * ```vue
9
11
  * <template>
10
- * <AreaChart :props="areaChartProps" />
12
+ * <AreaChart
13
+ :dataOptions="areaChartProps.dataOptions"
14
+ :dataSet="areaChartProps.dataSet"
15
+ :filters="areaChartProps.filters"
16
+ />
11
17
  * </template>
12
18
  *
13
19
  * <script setup lang="ts">
14
20
  * import { ref } from 'vue';
15
- * import AreaChart from '@sisense/sdk-ui-vue/AreaChart';
21
+ * import {AreaChart, type AreaChartProps} from '@sisense/sdk-ui-vue';
16
22
  *
17
- * const areaChartProps = ref({
18
- * // Configure your AreaChartProps here
23
+ * const areaChartProps = ref<AreaChartProps>({
24
+ * dataSet: DM.DataSource,
25
+ * dataOptions: {
26
+ * category: [dimProductName],
27
+ * value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
28
+ * breakBy: [],
29
+ * },
30
+ * filters: [],
19
31
  * });
20
- * </script>
21
32
  * ```
33
+ * @param {AreaChartProps} - Area chart properties
34
+ * @returns Area Chart component
22
35
  */
23
36
  export declare const AreaChart: import("vue").DefineComponent<{
24
37
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CartesianChartDataOptions>;
@@ -1,24 +1,36 @@
1
1
  import type { PropType } from 'vue';
2
2
  /**
3
- * A Vue component that wraps the AreamapChart Preact component for use in Vue applications.
4
- * It maintains compatibility with Vue's reactivity system while preserving the functionality of the AreamapChart.
3
+ * A Vue component for visualizing geographical data as polygons on a map.
4
+ * See [Areamap Chart](https://docs.sisense.com/main/SisenseLinux/area-map.htm) for more information.
5
5
  *
6
6
  * @example
7
7
  * Here's how you can use the AreamapChart component in a Vue application:
8
8
  * ```vue
9
9
  * <template>
10
- * <AreamapChart :props="areamapChartProps" />
10
+ <AreamapChart
11
+ :dataOptions="areamapChartProps.dataOptions"
12
+ :dataSet="areamapChartProps.dataSet"
13
+ :filters="areamapChartProps.filters"
14
+ />
11
15
  * </template>
12
16
  *
13
17
  * <script setup lang="ts">
14
18
  * import { ref } from 'vue';
15
- * import AreamapChart from '@sisense/sdk-ui-vue/AreamapChart';
19
+ * import {AreamapChart, type AreamapChartProps} from '@sisense/sdk-ui-vue';
16
20
  *
17
- * const areamapChartProps = ref({
18
- * // Configure your AreamapChartProps here
19
- * });
21
+ const areamapChartProps = ref<AreamapChartProps>({
22
+ dataSet: DM.DataSource,
23
+ dataOptions: {
24
+ geo: [DM.DimCountries.CountryName],
25
+ color: [{ column: measureTotalRevenue, title: 'Total Revenue' }],
26
+ },
27
+ filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
28
+ });
20
29
  * </script>
21
30
  * ```
31
+ * @param props - Areamap chart properties
32
+ * @returns Areamap Chart component
33
+ * @beta
22
34
  */
23
35
  export declare const AreamapChart: import("vue").DefineComponent<{
24
36
  dataOptions: PropType<import("@sisense/sdk-ui-preact").AreamapChartDataOptions>;
@@ -1,24 +1,37 @@
1
1
  import type { PropType } from 'vue';
2
2
  /**
3
- * A Vue component that wraps the BarChart Preact component for use in Vue applications.
4
- * It maintains compatibility with Vue's reactivity system while preserving the functionality of the BarChart.
5
- *
3
+ * A Vue component representing categorical data with horizontal rectangular bars,
4
+ * whose lengths are proportional to the values that they represent.
5
+ * See [Bar Chart](https://docs.sisense.com/main/SisenseLinux/bar-chart.htm) for more information.
6
6
  * @example
7
7
  * Here's how you can use the BarChart component in a Vue application:
8
8
  * ```vue
9
9
  * <template>
10
- * <BarChart :props="barChartProps" />
10
+ <BarChart
11
+ :dataOptions="barChartProps.dataOptions"
12
+ :dataSet="barChartProps.dataSet"
13
+ :filters="barChartProps.filters"
14
+ />
11
15
  * </template>
12
16
  *
13
17
  * <script setup lang="ts">
14
18
  * import { ref } from 'vue';
15
- * import BarChart from '@sisense/sdk-ui-vue/BarChart';
19
+ * import {BarChart} from '@sisense/sdk-ui-vue';
16
20
  *
17
- * const barChartProps = ref({
18
- * // Configure your BarChartProps here
19
- * });
21
+ const barChartProps = ref<BarChartProps>({
22
+ dataSet: DM.DataSource,
23
+ dataOptions: {
24
+ category: [dimProductName],
25
+ value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
26
+ breakBy: [],
27
+ },
28
+ filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
29
+ });
20
30
  * </script>
21
31
  * ```
32
+ * <img src="media://bar-chart-example-1.png" width="800"/>
33
+ * @param props - Bar chart properties
34
+ * @returns Bar Chart component
22
35
  */
23
36
  export declare const BarChart: import("vue").DefineComponent<{
24
37
  /**
@@ -1,24 +1,38 @@
1
1
  import type { PropType } from 'vue';
2
2
  /**
3
- * A Vue component that wraps the BoxplotChart Preact component for use in Vue applications.
4
- * It maintains compatibility with Vue's reactivity system while preserving the functionality of the BoxplotChart.
5
- *
3
+ * A Vue component representing data in a way that visually describes the distribution, variability,
4
+ * and center of a data set along an axis.
5
+ * See [Boxplot Chart](https://docs.sisense.com/main/SisenseLinux/box-and-whisker-plot.htm) for more information.
6
6
  * @example
7
7
  * Here's how you can use the BoxplotChart component in a Vue application:
8
8
  * ```vue
9
9
  * <template>
10
- * <BoxplotChart :props="boxplotChartProps" />
10
+ <BoxplotChart
11
+ :dataOptions="boxplotChartProps.dataOptions"
12
+ :dataSet="boxplotChartProps.dataSet"
13
+ :filters="boxplotChartProps.filters"
14
+ />
11
15
  * </template>
12
16
  *
13
17
  * <script setup lang="ts">
14
18
  * import { ref } from 'vue';
15
- * import BoxplotChart from '@sisense/sdk-ui-vue/BoxplotChart';
19
+ * import {BoxplotChart, type BoxplotChartProps} from '@sisense/sdk-ui-vue';
16
20
  *
17
- * const boxplotChartProps = ref({
18
- * // Configure your BoxplotChartProps here
19
- * });
20
- * </script>
21
+ const boxplotChartProps = ref<BoxplotChartProps>({
22
+ dataSet: DM.DataSource,
23
+ dataOptions: {
24
+ category: [dimProductName],
25
+ value: [DM.Fact_Sale_orders.OrderRevenue],
26
+ boxType: 'iqr',
27
+ outliersEnabled: true,
28
+ },
29
+ filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
30
+ });
21
31
  * ```
32
+ * <img src="media://boxplot-chart-example-1.png" width="600px" />
33
+ * @param props - Boxplot chart properties
34
+ * @returns Boxplot Chart component
35
+ * @beta
22
36
  */
23
37
  export declare const BoxplotChart: import("vue").DefineComponent<{
24
38
  dataOptions: PropType<import("@sisense/sdk-ui-preact").BoxplotChartDataOptions | import("@sisense/sdk-ui-preact").BoxplotChartCustomDataOptions>;
@@ -1,25 +1,56 @@
1
1
  /// <reference types="react" />
2
2
  import type { PropType } from 'vue';
3
3
  /**
4
- * A Vue component that wraps the ChartWidget Preact component for use in Vue applications.
5
- * It maintains compatibility with Vue's reactivity system while preserving the functionality of the ChartWidget.
6
- *
4
+ * The Chart Widget component extending the {@link Chart} component to support widget style options.
5
+ * It can be used along with the {@link DrilldownWidget} component to support advanced data drilldown.
7
6
  * @example
8
7
  * Here's how you can use the ChartWidget component in a Vue application:
9
8
  * ```vue
10
9
  * <template>
11
- * <ChartWidget :props="chartWidgetProps" />
10
+ <DrilldownWidget :drilldownDimensions="drilldownDimensions" :initialDimension="dimProductName">
11
+ <template
12
+ #chart="{ drilldownFilters, drilldownDimension, onDataPointsSelected, onContextMenu }"
13
+ >
14
+ <ChartWidget
15
+ chart-type="bar"
16
+ v-bind:filters="drilldownFilters"
17
+ :dataOptions="{
18
+ ...chartProps.dataOptions,
19
+ category: [drilldownDimension],
20
+ }"
21
+ :highlight-selection-disabled="true"
22
+ :dataSet="chartProps.dataSet"
23
+ :style="chartProps.styleOptions"
24
+ :on-data-points-selected="(dataPoints:any,event:any) => {
25
+ onDataPointsSelected(dataPoints);
26
+ onContextMenu({ left: event.clientX, top: event.clientY });
27
+ }"
28
+ :on-data-point-click="(dataPoint:any,event:any) => {
29
+ onDataPointsSelected([dataPoint]);
30
+ onContextMenu({ left: event.clientX, top: event.clientY });
31
+ }"
32
+ :on-data-point-context-menu="(dataPoint:any,event:any) => {
33
+ onDataPointsSelected([dataPoint]);
34
+ onContextMenu({ left: event.clientX, top: event.clientY });
35
+ }"
36
+ />
37
+ </template>
38
+ </DrilldownWidget>
12
39
  * </template>
13
40
  *
14
41
  * <script setup lang="ts">
15
42
  * import { ref } from 'vue';
16
- * import ChartWidget from '@sisense/sdk-ui-vue/ChartWidget';
43
+ * import {ChartWidget} from '@sisense/sdk-ui-vue';
17
44
  *
18
45
  * const chartWidgetProps = ref({
19
46
  * // Configure your ChartWidgetProps here
20
47
  * });
21
48
  * </script>
22
49
  * ```
50
+ * <img src="media://chart-widget-with-drilldown-example-1.png" width="800px" />
51
+ * @param props - ChartWidget properties
52
+ * @returns ChartWidget component representing a chart type as specified in `ChartWidgetProps.`{@link ChartWidgetProps.chartType | chartType}
53
+
23
54
  */
24
55
  export declare const ChartWidget: import("vue").DefineComponent<{
25
56
  bottomSlot: PropType<import("react").ReactNode>;
@@ -34,7 +65,7 @@ export declare const ChartWidget: import("vue").DefineComponent<{
34
65
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
35
66
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
36
67
  onContextMenuClose: PropType<(() => void) | undefined>;
37
- onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
68
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
38
69
  onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
39
70
  onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
40
71
  styleOptions: PropType<import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | undefined>;
@@ -56,7 +87,7 @@ export declare const ChartWidget: import("vue").DefineComponent<{
56
87
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
57
88
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
58
89
  onContextMenuClose: PropType<(() => void) | undefined>;
59
- onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
90
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
60
91
  onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
61
92
  onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
62
93
  styleOptions: PropType<import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | undefined>;
@@ -8,7 +8,7 @@ import { type PropType } from 'vue';
8
8
  * ```tsx
9
9
  * <script setup lang="ts">
10
10
  * import { Chart } from '@sisense/sdk-ui-vue';
11
- * import type { ChartProps } from '@sisense/sdk-ui';
11
+ * import type { ChartProps } from '@sisense/sdk-ui-vue';
12
12
  * import * as DM from '../assets/sample-retail-model';
13
13
  * import { measureFactory, filterFactory } from '@sisense/sdk-data';
14
14
  * import { ref } from 'vue';
@@ -24,33 +24,22 @@ import { type PropType } from 'vue';
24
24
  * value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
25
25
  * breakBy: [],
26
26
  * },
27
- * filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
28
- * styleOptions: {
29
- * width: 800,
30
- * height: 500,
31
- * xAxis: {
32
- * title: {
33
- * text: 'Product Name',
34
- * enabled: true,
35
- * },
36
- * },
37
- * yAxis: {
38
- * title: {
39
- * text: 'Total Revenue',
40
- * enabled: true,
41
- * },
42
- * },
43
- * },
27
+ * filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)]
44
28
  * });
45
29
  * </script>
46
30
  *
47
31
  * <template>
48
- * <Chart :props="chartProps" />
32
+ <Chart
33
+ :chartType="chartProps.chartType"
34
+ :dataSet="chartProps.dataSet"
35
+ :dataOptions="chartProps.dataOptions"
36
+ :filters="chartProps.filters"
37
+ />
49
38
  * </template>
50
39
  * ```
51
40
  *
52
- * <img src="media://vue-chart-data-source-example-1.png" width="800px" />
53
- *
41
+ * <img src="media://chart-local-data-example-1.png" width="800px" />
42
+ * @param props - Chart properties
54
43
  * @returns Chart component representing a chart type as specified in `ChartProps.`{@link ChartProps.chartType | chartType}
55
44
  */
56
45
  export declare const Chart: import("vue").DefineComponent<{
@@ -60,7 +49,7 @@ export declare const Chart: import("vue").DefineComponent<{
60
49
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
61
50
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
62
51
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
63
- onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
52
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
64
53
  onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
65
54
  onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
66
55
  styleOptions: PropType<import("@sisense/sdk-ui-preact").ChartStyleOptions | undefined>;
@@ -74,7 +63,7 @@ export declare const Chart: import("vue").DefineComponent<{
74
63
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
75
64
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
76
65
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
77
- onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
66
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
78
67
  onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
79
68
  onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
80
69
  styleOptions: PropType<import("@sisense/sdk-ui-preact").ChartStyleOptions | undefined>;
@@ -1,24 +1,37 @@
1
1
  import type { PropType } from 'vue';
2
2
  /**
3
- * A Vue component that wraps the ColumnChart Preact component for use in Vue applications.
4
- * It maintains compatibility with Vue's reactivity system while preserving the functionality of the ColumnChart.
3
+ * A Vue component representing categorical data with vertical rectangular bars
4
+ * whose heights are proportional to the values that they represent.
5
+ * See [Column Chart](https://docs.sisense.com/main/SisenseLinux/column-chart.htm) for more information.
5
6
  *
6
7
  * @example
7
8
  * Here's how you can use the ColumnChart component in a Vue application:
8
9
  * ```vue
9
10
  * <template>
10
- * <ColumnChart :props="ColumnChartProps" />
11
+ <ColumnChart
12
+ :dataOptions="columnChartProps.dataOptions"
13
+ :dataSet="columnChartProps.dataSet"
14
+ :filters="columnChartProps.filters"
15
+ />
11
16
  * </template>
12
17
  *
13
18
  * <script setup lang="ts">
14
19
  * import { ref } from 'vue';
15
- * import ColumnChart from '@sisense/sdk-ui-vue/ColumnChart';
20
+ * import {ColumnChart, type ColumnChartProps} from '@sisense/sdk-ui-vue';
16
21
  *
17
- * const columnChartProps = ref({
18
- * // Configure your ColumnChartProps here
19
- * });
20
- * </script>
22
+ const columnChartProps = ref<ColumnChartProps>({
23
+ dataSet: DM.DataSource,
24
+ dataOptions: {
25
+ category: [dimProductName],
26
+ value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
27
+ breakBy: [],
28
+ },
29
+ filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
30
+ });
21
31
  * ```
32
+ * <img src="media://column-chart-example-1.png" width="800"/>
33
+ * @param props - Column chart properties
34
+ * @returns Column Chart component
22
35
  */
23
36
  export declare const ColumnChart: import("vue").DefineComponent<{
24
37
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CartesianChartDataOptions>;
@@ -1,23 +1,23 @@
1
1
  /// <reference types="react" />
2
2
  import type { PropType } from 'vue';
3
3
  /**
4
- * A Vue component that wraps the DashboardWidget Preact component for use in Vue applications.
5
- * It maintains compatibility with Vue's reactivity system while preserving the functionality of the DashboardWidget.
4
+ * The Dashboard Widget component, which is a thin wrapper on the {@link ChartWidget} component,
5
+ * used to render a widget created in the Sisense instance.
6
6
  *
7
7
  * @example
8
8
  * Here's how you can use the DashboardWidget component in a Vue application:
9
9
  * ```vue
10
10
  * <template>
11
- * <DashboardWidget :props="dashboardWidgetProps" />
11
+ * <DashboardWidget
12
+ * widgetOid="64473e07dac1920034bce77f"
13
+ * dashboardOid="6441e728dac1920034bce737"
14
+ * />
12
15
  * </template>
13
16
  *
14
17
  * <script setup lang="ts">
15
18
  * import { ref } from 'vue';
16
- * import DashboardWidget from '@sisense/sdk-ui-vue/DashboardWidget';
19
+ * import {DashboardWidget} from '@sisense/sdk-ui-vue';
17
20
  *
18
- * const dashboardWidgetProps = ref({
19
- * // Configure your DashboardWidgetProps here
20
- * });
21
21
  * </script>
22
22
  * ```
23
23
  */
@@ -34,7 +34,7 @@ export declare const DashboardWidget: import("vue").DefineComponent<{
34
34
  includeDashboardFilters: PropType<boolean | undefined>;
35
35
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
36
36
  onContextMenuClose: PropType<(() => void) | undefined>;
37
- onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
37
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
38
38
  onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
39
39
  onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
40
40
  styleOptions: PropType<import("@sisense/sdk-ui-preact").DashboardWidgetStyleOptions | undefined>;
@@ -57,7 +57,7 @@ export declare const DashboardWidget: import("vue").DefineComponent<{
57
57
  includeDashboardFilters: PropType<boolean | undefined>;
58
58
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
59
59
  onContextMenuClose: PropType<(() => void) | undefined>;
60
- onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
60
+ onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
61
61
  onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
62
62
  onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
63
63
  styleOptions: PropType<import("@sisense/sdk-ui-preact").DashboardWidgetStyleOptions | undefined>;
@@ -7,18 +7,32 @@ import type { PropType } from 'vue';
7
7
  * Here's how you can use the FunnelChart component in a Vue application:
8
8
  * ```vue
9
9
  * <template>
10
- * <FunnelChart :props="funnelChartProps" />
10
+ <FunnelChart
11
+ :dataOptions="funnelChartProps.dataOptions"
12
+ :dataSet="funnelChartProps.dataSet"
13
+ :filters="funnelChartProps.filters"
14
+ />
11
15
  * </template>
12
16
  *
13
17
  * <script setup lang="ts">
14
18
  * import { ref } from 'vue';
15
- * import FunnelChart from '@sisense/sdk-ui-vue/FunnelChart';
19
+ * import {FunnelChart, type FunnelChartProps} from '@sisense/sdk-ui-vue';
16
20
  *
17
- * const funnelChartProps = ref({
18
- * // Configure your FunnelChartProps here
19
- * });
21
+ const funnelChartProps = ref<FunnelChartProps>({
22
+ dataSet: DM.DataSource,
23
+ dataOptions: {
24
+ category: [dimProductName],
25
+ value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
26
+ },
27
+ filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
28
+ });
20
29
  * </script>
21
30
  * ```
31
+ * <img src="media://funnel-chart-example-1.png" width="800"/>
32
+ *
33
+ * Note that the chart sorts the measure, `Unique Users`, in descending order by default.
34
+ * @param props - Funnel chart properties
35
+ * @returns Funnel Chart component
22
36
  */
23
37
  export declare const FunnelChart: import("vue").DefineComponent<{
24
38
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CategoricalChartDataOptions>;
@@ -6,6 +6,7 @@ export { LineChart } from './line-chart';
6
6
  export { PieChart } from './pie-chart';
7
7
  export { ScatterChart } from './scatter-chart';
8
8
  export { Table } from './table';
9
+ export { PivotTable } from './pivot-table';
9
10
  export { TreemapChart } from './treemap-chart';
10
11
  export { SunburstChart } from './sunburst-chart';
11
12
  export { PolarChart } from './polar-chart';
@@ -1,24 +1,35 @@
1
1
  import type { PropType } from 'vue';
2
2
  /**
3
- * A Vue component that wraps the IndicatorChart Preact component for use in Vue applications.
4
- * It maintains compatibility with Vue's reactivity system while preserving the functionality of the IndicatorChart.
3
+ * A Vue component that provides various options for displaying one or two numeric values as a number, gauge or ticker.
4
+ * See [Indicator](https://docs.sisense.com/main/SisenseLinux/indicator.htm) for more information.
5
5
  *
6
6
  * @example
7
7
  * Here's how you can use the IndicatorChart component in a Vue application:
8
8
  * ```vue
9
9
  * <template>
10
- * <IndicatorChart :props="indicatorChartProps" />
10
+ <IndicatorChart
11
+ :dataOptions="indicatorChartProps.dataOptions"
12
+ :dataSet="indicatorChartProps.dataSet"
13
+ :filters="indicatorChartProps.filters"
14
+ />
11
15
  * </template>
12
16
  *
13
17
  * <script setup lang="ts">
14
18
  * import { ref } from 'vue';
15
- * import IndicatorChart from '@sisense/sdk-ui-vue/IndicatorChart';
19
+ * import {IndicatorChart, type IndicatorChartProps} from '@sisense/sdk-ui-vue';
16
20
  *
17
- * const indicatorChartProps = ref({
18
- * // Configure your IndicatorChartProps here
19
- * });
21
+ const indicatorChartProps = ref<IndicatorChartProps>({
22
+ dataSet: DM.DataSource,
23
+ dataOptions: {
24
+ value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
25
+ },
26
+ filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
27
+ });
20
28
  * </script>
21
29
  * ```
30
+ * <img src="media://indicator-chart-example-1.png" width="400px" />
31
+ * @param props - Indicator chart properties
32
+ * @returns Indicator Chart component
22
33
  */
23
34
  export declare const IndicatorChart: import("vue").DefineComponent<{
24
35
  dataOptions: PropType<import("@sisense/sdk-ui-preact").IndicatorChartDataOptions>;
@@ -7,18 +7,30 @@ import type { PropType } from 'vue';
7
7
  * Here's how you can use the LineChart component in a Vue application:
8
8
  * ```vue
9
9
  * <template>
10
- * <LineChart :props="lineChartProps" />
10
+ <LineChart
11
+ :dataOptions="lineChartProps.dataOptions"
12
+ :dataSet="lineChartProps.dataSet"
13
+ :filters="lineChartProps.filters"
14
+ />
11
15
  * </template>
12
16
  *
13
17
  * <script setup lang="ts">
14
18
  * import { ref } from 'vue';
15
- * import LineChart from '@sisense/sdk-ui-vue/LineChart';
19
+ * import {LineChart, type LineChartProps} from '@sisense/sdk-ui-vue';
16
20
  *
17
- * const lineChartProps = ref({
18
- * // Configure your LineChartProps here
19
- * });
20
- * </script>
21
+ const lineChartProps = ref<LineChartProps>({
22
+ dataSet: DM.DataSource,
23
+ dataOptions: {
24
+ category: [dimProductName],
25
+ value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
26
+ breakBy: [],
27
+ },
28
+ filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
29
+ });
21
30
  * ```
31
+ * <img src="media://line-chart-example-1.png" width="800px" />
32
+ * @param props - Line chart properties
33
+ * @returns Line Chart component
22
34
  */
23
35
  export declare const LineChart: import("vue").DefineComponent<{
24
36
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CartesianChartDataOptions>;
@@ -1,24 +1,36 @@
1
1
  import type { PropType } from 'vue';
2
2
  /**
3
- * A Vue component that wraps the PieChart Preact component for use in Vue applications.
4
- * It maintains compatibility with Vue's reactivity system while preserving the functionality of the PieChart.
3
+ * A Vue component representing data in a circular graph with the data shown as slices of a whole,
4
+ * with each slice representing a proportion of the total.
5
+ * See [Pie Chart](https://docs.sisense.com/main/SisenseLinux/pie-chart.htm) for more information.
5
6
  *
6
7
  * @example
7
8
  * Here's how you can use the PieChart component in a Vue application:
8
9
  * ```vue
9
10
  * <template>
10
- * <PieChart :props="pieChartProps" />
11
+ <PieChart
12
+ :dataOptions="pieChartProps.dataOptions"
13
+ :dataSet="pieChartProps.dataSet"
14
+ :filters="pieChartProps.filters"
15
+ />
11
16
  * </template>
12
17
  *
13
18
  * <script setup lang="ts">
14
19
  * import { ref } from 'vue';
15
- * import PieChart from '@sisense/sdk-ui-vue/PieChart';
20
+ * import {PieChart,type PieChartProps} from '@sisense/sdk-ui-vue';
16
21
  *
17
- * const pieChartProps = ref({
18
- * // Configure your PieChartProps here
19
- * });
20
- * </script>
22
+ const pieChartProps = ref<PieChartProps>({
23
+ dataSet: DM.DataSource,
24
+ dataOptions: {
25
+ category: [dimProductName],
26
+ value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
27
+ },
28
+ filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
29
+ });
21
30
  * ```
31
+ * <img src="media://pie-chart-example-1.png" width="600px" />
32
+ * @param props - Pie chart properties
33
+ * @returns Pie Chart component
22
34
  */
23
35
  export declare const PieChart: import("vue").DefineComponent<{
24
36
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CategoricalChartDataOptions>;