@sisense/sdk-ui-vue 1.4.1 → 1.6.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 (41) hide show
  1. package/dist/index.js +87643 -82709
  2. package/dist/src/components/charts/area-chart.d.ts +8 -3
  3. package/dist/src/components/charts/areamap-chart.d.ts +10 -3
  4. package/dist/src/components/charts/bar-chart.d.ts +10 -5
  5. package/dist/src/components/charts/boxplot-chart.d.ts +10 -5
  6. package/dist/src/components/charts/chart.d.ts +29 -13
  7. package/dist/src/components/charts/column-chart.d.ts +9 -3
  8. package/dist/src/components/charts/funnel-chart.d.ts +10 -4
  9. package/dist/src/components/charts/index.d.ts +0 -3
  10. package/dist/src/components/charts/indicator-chart.d.ts +15 -10
  11. package/dist/src/components/charts/line-chart.d.ts +18 -13
  12. package/dist/src/components/charts/pie-chart.d.ts +16 -11
  13. package/dist/src/components/charts/pivot-table.d.ts +26 -13
  14. package/dist/src/components/charts/polar-chart.d.ts +17 -12
  15. package/dist/src/components/charts/scatter-chart.d.ts +16 -11
  16. package/dist/src/components/charts/scattermap-chart.d.ts +16 -11
  17. package/dist/src/components/charts/sunburst-chart.d.ts +19 -10
  18. package/dist/src/components/charts/table.d.ts +23 -8
  19. package/dist/src/components/charts/treemap-chart.d.ts +17 -12
  20. package/dist/src/components/context-menu.d.ts +1 -0
  21. package/dist/src/components/drilldown-breadcrumbs.d.ts +1 -0
  22. package/dist/src/components/drilldown-widget.d.ts +90 -0
  23. package/dist/src/components/filters/criteria-filter-tile.d.ts +2 -1
  24. package/dist/src/components/filters/date-range-filter-tile.d.ts +24 -15
  25. package/dist/src/components/filters/member-filter-tile.d.ts +23 -14
  26. package/dist/src/components/{charts → widgets}/chart-widget.d.ts +8 -4
  27. package/dist/src/components/{charts → widgets}/dashboard-widget.d.ts +5 -0
  28. package/dist/src/components/widgets/index.d.ts +3 -0
  29. package/dist/src/components/{charts → widgets}/table-widget.d.ts +4 -3
  30. package/dist/src/composables/use-execute-query-by-widget-id.d.ts +2 -0
  31. package/dist/src/composables/use-execute-query.d.ts +1 -0
  32. package/dist/src/composables/use-get-dashboard-model.d.ts +1 -0
  33. package/dist/src/composables/use-get-dashboard-models.d.ts +1 -0
  34. package/dist/src/composables/use-get-shared-formula.d.ts +1 -0
  35. package/dist/src/composables/use-get-widget-model.d.ts +1 -0
  36. package/dist/src/lib.d.ts +2 -0
  37. package/dist/src/providers/index.d.ts +1 -1
  38. package/dist/src/providers/sisense-context-provider.d.ts +28 -15
  39. package/dist/src/providers/theme-provider.d.ts +2 -0
  40. package/dist/src/sdk-ui-core-exports.d.ts +1 -1
  41. package/package.json +2 -1
package/dist/src/components/charts/area-chart.d.ts CHANGED
@@ -4,7 +4,6 @@ import type { PropType } from 'vue';
4
4
  * but with filled in areas under each line and an option to display them as stacked.
5
5
  * More info on [Sisense Documentation page](https://docs.sisense.com/main/SisenseLinux/area-chart.htm).
6
6
  *
7
- * <img src="media://area-chart-example-1.png" width="800"/>
8
7
  * @example
9
8
  * Here's how you can use the AreaChart component in a Vue application:
10
9
  * ```vue
@@ -18,8 +17,12 @@ import type { PropType } from 'vue';
18
17
  *
19
18
  * <script setup lang="ts">
20
19
  * import { ref } from 'vue';
20
+ * import { measureFactory, filterFactory } from '@sisense/sdk-data';
21
+ * import * as DM from '../assets/sample-retail-model';
21
22
  * import {AreaChart, type AreaChartProps} from '@sisense/sdk-ui-vue';
22
23
  *
24
+ * const dimProductName = DM.DimProducts.ProductName;
25
+ * const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
23
26
  * const areaChartProps = ref<AreaChartProps>({
24
27
  * dataSet: DM.DataSource,
25
28
  * dataOptions: {
@@ -30,12 +33,14 @@ import type { PropType } from 'vue';
30
33
  * filters: [],
31
34
  * });
32
35
  * ```
36
+ * <img src="media://vue-area-chart-example.png" width="800"/>
33
37
  * @param {AreaChartProps} - Area chart properties
34
38
  * @returns Area Chart component
39
+ * @group Charts
35
40
  */
36
41
  export declare const AreaChart: import("vue").DefineComponent<{
37
42
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CartesianChartDataOptions>;
38
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
43
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
39
44
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
40
45
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
41
46
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
@@ -47,7 +52,7 @@ export declare const AreaChart: import("vue").DefineComponent<{
47
52
  [key: string]: any;
48
53
  }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
49
54
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CartesianChartDataOptions>;
50
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
55
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
51
56
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
52
57
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
53
58
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
package/dist/src/components/charts/areamap-chart.d.ts CHANGED
@@ -16,8 +16,13 @@ import type { PropType } from 'vue';
16
16
  *
17
17
  * <script setup lang="ts">
18
18
  * import { ref } from 'vue';
19
+ * import { measureFactory, filterFactory } from '@sisense/sdk-data';
20
+ * import * as DM from '../assets/sample-retail-model';
19
21
  * import {AreamapChart, type AreamapChartProps} from '@sisense/sdk-ui-vue';
20
- *
22
+
23
+ * const dimProductName = DM.DimProducts.ProductName;
24
+ * const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
25
+
21
26
  const areamapChartProps = ref<AreamapChartProps>({
22
27
  dataSet: DM.DataSource,
23
28
  dataOptions: {
@@ -28,13 +33,15 @@ import type { PropType } from 'vue';
28
33
  });
29
34
  * </script>
30
35
  * ```
36
+ * <img src="media://vue-areamap-chart-example.png" width="600px" />
31
37
  * @param props - Areamap chart properties
32
38
  * @returns Areamap Chart component
39
+ * @group Charts
33
40
  * @beta
34
41
  */
35
42
  export declare const AreamapChart: import("vue").DefineComponent<{
36
43
  dataOptions: PropType<import("@sisense/sdk-ui-preact").AreamapChartDataOptions>;
37
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
44
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
38
45
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
39
46
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
40
47
  styleOptions: PropType<import("@sisense/sdk-ui-preact").AreamapStyleOptions | undefined>;
@@ -43,7 +50,7 @@ export declare const AreamapChart: import("vue").DefineComponent<{
43
50
  [key: string]: any;
44
51
  }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
45
52
  dataOptions: PropType<import("@sisense/sdk-ui-preact").AreamapChartDataOptions>;
46
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
53
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
47
54
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
48
55
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
49
56
  styleOptions: PropType<import("@sisense/sdk-ui-preact").AreamapStyleOptions | undefined>;
package/dist/src/components/charts/bar-chart.d.ts CHANGED
@@ -16,8 +16,12 @@ import type { PropType } from 'vue';
16
16
  *
17
17
  * <script setup lang="ts">
18
18
  * import { ref } from 'vue';
19
- * import {BarChart} from '@sisense/sdk-ui-vue';
20
- *
19
+ * import { measureFactory, filterFactory } from '@sisense/sdk-data';
20
+ * import * as DM from '../assets/sample-retail-model';
21
+ * import {BarChart,type BarChartProps} from '@sisense/sdk-ui-vue';
22
+
23
+ * const dimProductName = DM.DimProducts.ProductName;
24
+ * const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
21
25
  const barChartProps = ref<BarChartProps>({
22
26
  dataSet: DM.DataSource,
23
27
  dataOptions: {
@@ -29,9 +33,10 @@ import type { PropType } from 'vue';
29
33
  });
30
34
  * </script>
31
35
  * ```
32
- * <img src="media://bar-chart-example-1.png" width="800"/>
36
+ * <img src="media://vue-bar-chart-example.png" width="800"/>
33
37
  * @param props - Bar chart properties
34
38
  * @returns Bar Chart component
39
+ * @group Charts
35
40
  */
36
41
  export declare const BarChart: import("vue").DefineComponent<{
37
42
  /**
@@ -39,7 +44,7 @@ export declare const BarChart: import("vue").DefineComponent<{
39
44
  * including both BaseChartProps and ChartEventProps.
40
45
  */
41
46
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CartesianChartDataOptions>;
42
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
47
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
43
48
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
44
49
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
45
50
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
@@ -55,7 +60,7 @@ export declare const BarChart: import("vue").DefineComponent<{
55
60
  * including both BaseChartProps and ChartEventProps.
56
61
  */
57
62
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CartesianChartDataOptions>;
58
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
63
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
59
64
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
60
65
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
61
66
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
package/dist/src/components/charts/boxplot-chart.d.ts CHANGED
@@ -16,9 +16,13 @@ import type { PropType } from 'vue';
16
16
  *
17
17
  * <script setup lang="ts">
18
18
  * import { ref } from 'vue';
19
+ * import { measureFactory, filterFactory } from '@sisense/sdk-data';
20
+ * import * as DM from '../assets/sample-retail-model';
19
21
  * import {BoxplotChart, type BoxplotChartProps} from '@sisense/sdk-ui-vue';
20
- *
21
- const boxplotChartProps = ref<BoxplotChartProps>({
22
+
23
+ * const dimProductName = DM.DimProducts.ProductName;
24
+ * const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
25
+ * const boxplotChartProps = ref<BoxplotChartProps>({
22
26
  dataSet: DM.DataSource,
23
27
  dataOptions: {
24
28
  category: [dimProductName],
@@ -29,14 +33,15 @@ import type { PropType } from 'vue';
29
33
  filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
30
34
  });
31
35
  * ```
32
- * <img src="media://boxplot-chart-example-1.png" width="600px" />
36
+ * <img src="media://vue-boxplot-chart-example.png" width="600px" />
33
37
  * @param props - Boxplot chart properties
34
38
  * @returns Boxplot Chart component
39
+ * @group Charts
35
40
  * @beta
36
41
  */
37
42
  export declare const BoxplotChart: import("vue").DefineComponent<{
38
43
  dataOptions: PropType<import("@sisense/sdk-ui-preact").BoxplotChartDataOptions | import("@sisense/sdk-ui-preact").BoxplotChartCustomDataOptions>;
39
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
44
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
40
45
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
41
46
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
42
47
  styleOptions: PropType<import("@sisense/sdk-ui-preact").BoxplotStyleOptions | undefined>;
@@ -48,7 +53,7 @@ export declare const BoxplotChart: import("vue").DefineComponent<{
48
53
  [key: string]: any;
49
54
  }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
50
55
  dataOptions: PropType<import("@sisense/sdk-ui-preact").BoxplotChartDataOptions | import("@sisense/sdk-ui-preact").BoxplotChartCustomDataOptions>;
51
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
56
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
52
57
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
53
58
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
54
59
  styleOptions: PropType<import("@sisense/sdk-ui-preact").BoxplotStyleOptions | undefined>;
package/dist/src/components/charts/chart.d.ts CHANGED
@@ -16,16 +16,30 @@ import { type PropType } from 'vue';
16
16
  * const dimProductName = DM.DimProducts.ProductName;
17
17
  * const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
18
18
  *
19
- * const chartProps = ref<ChartProps>({
20
- * chartType: 'bar',
21
- * dataSet: DM.DataSource,
22
- * dataOptions: {
23
- * category: [dimProductName],
24
- * value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
25
- * breakBy: [],
26
- * },
27
- * filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)]
28
- * });
19
+ const chartProps = ref<ChartProps>({
20
+ chartType: 'bar',
21
+ dataSet: DM.DataSource,
22
+ dataOptions: {
23
+ category: [dimProductName],
24
+ value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
25
+ breakBy: [],
26
+ },
27
+ filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
28
+ styleOptions: {
29
+ xAxis: {
30
+ title: {
31
+ text: 'Product Name',
32
+ enabled: true,
33
+ },
34
+ },
35
+ yAxis: {
36
+ title: {
37
+ text: 'Total Revenue',
38
+ enabled: true,
39
+ },
40
+ },
41
+ },
42
+ });
29
43
  * </script>
30
44
  *
31
45
  * <template>
@@ -34,18 +48,20 @@ import { type PropType } from 'vue';
34
48
  :dataSet="chartProps.dataSet"
35
49
  :dataOptions="chartProps.dataOptions"
36
50
  :filters="chartProps.filters"
51
+ :styleOptions="chartProps.styleOptions"
37
52
  />
38
53
  * </template>
39
54
  * ```
40
55
  *
41
- * <img src="media://chart-local-data-example-1.png" width="800px" />
56
+ * <img src="media://vue-chart-example.png" width="800px" />
42
57
  * @param props - Chart properties
43
58
  * @returns Chart component representing a chart type as specified in `ChartProps.`{@link ChartProps.chartType | chartType}
59
+ * @group Charts
44
60
  */
45
61
  export declare const Chart: import("vue").DefineComponent<{
46
62
  chartType: PropType<import("@sisense/sdk-ui-preact").ChartType>;
47
63
  dataOptions: PropType<import("@sisense/sdk-ui-preact").ChartDataOptions>;
48
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
64
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
49
65
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
50
66
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
51
67
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
@@ -59,7 +75,7 @@ export declare const Chart: import("vue").DefineComponent<{
59
75
  }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
60
76
  chartType: PropType<import("@sisense/sdk-ui-preact").ChartType>;
61
77
  dataOptions: PropType<import("@sisense/sdk-ui-preact").ChartDataOptions>;
62
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
78
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
63
79
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
64
80
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
65
81
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
package/dist/src/components/charts/column-chart.d.ts CHANGED
@@ -17,8 +17,13 @@ import type { PropType } from 'vue';
17
17
  *
18
18
  * <script setup lang="ts">
19
19
  * import { ref } from 'vue';
20
+ * import { measureFactory, filterFactory } from '@sisense/sdk-data';
21
+ * import * as DM from '../assets/sample-retail-model';
20
22
  * import {ColumnChart, type ColumnChartProps} from '@sisense/sdk-ui-vue';
21
23
  *
24
+ * const dimProductName = DM.DimProducts.ProductName;
25
+ * const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
26
+
22
27
  const columnChartProps = ref<ColumnChartProps>({
23
28
  dataSet: DM.DataSource,
24
29
  dataOptions: {
@@ -29,13 +34,14 @@ const columnChartProps = ref<ColumnChartProps>({
29
34
  filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
30
35
  });
31
36
  * ```
32
- * <img src="media://column-chart-example-1.png" width="800"/>
37
+ * <img src="media://vue-column-chart-example.png" width="800"/>
33
38
  * @param props - Column chart properties
34
39
  * @returns Column Chart component
40
+ * @group Charts
35
41
  */
36
42
  export declare const ColumnChart: import("vue").DefineComponent<{
37
43
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CartesianChartDataOptions>;
38
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
44
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
39
45
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
40
46
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
41
47
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
@@ -47,7 +53,7 @@ export declare const ColumnChart: import("vue").DefineComponent<{
47
53
  [key: string]: any;
48
54
  }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
49
55
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CartesianChartDataOptions>;
50
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
56
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
51
57
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
52
58
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
53
59
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
package/dist/src/components/charts/funnel-chart.d.ts CHANGED
@@ -17,8 +17,13 @@ import type { PropType } from 'vue';
17
17
  * <script setup lang="ts">
18
18
  * import { ref } from 'vue';
19
19
  * import {FunnelChart, type FunnelChartProps} from '@sisense/sdk-ui-vue';
20
+ * import { measureFactory, filterFactory } from '@sisense/sdk-data';
21
+ * import * as DM from '../assets/sample-retail-model';
20
22
  *
21
- const funnelChartProps = ref<FunnelChartProps>({
23
+ * const dimProductName = DM.DimProducts.ProductName;
24
+ * const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
25
+ *
26
+ * const funnelChartProps = ref<FunnelChartProps>({
22
27
  dataSet: DM.DataSource,
23
28
  dataOptions: {
24
29
  category: [dimProductName],
@@ -28,15 +33,16 @@ const funnelChartProps = ref<FunnelChartProps>({
28
33
  });
29
34
  * </script>
30
35
  * ```
31
- * <img src="media://funnel-chart-example-1.png" width="800"/>
36
+ * <img src="media://vue-funnel-chart-example.png" width="800"/>
32
37
  *
33
38
  * Note that the chart sorts the measure, `Unique Users`, in descending order by default.
34
39
  * @param props - Funnel chart properties
35
40
  * @returns Funnel Chart component
41
+ * @group Charts
36
42
  */
37
43
  export declare const FunnelChart: import("vue").DefineComponent<{
38
44
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CategoricalChartDataOptions>;
39
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
45
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
40
46
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
41
47
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
42
48
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
@@ -48,7 +54,7 @@ export declare const FunnelChart: import("vue").DefineComponent<{
48
54
  [key: string]: any;
49
55
  }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
50
56
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CategoricalChartDataOptions>;
51
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
57
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
52
58
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
53
59
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
54
60
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
package/dist/src/components/charts/index.d.ts CHANGED
@@ -11,10 +11,7 @@ export { TreemapChart } from './treemap-chart';
11
11
  export { SunburstChart } from './sunburst-chart';
12
12
  export { PolarChart } from './polar-chart';
13
13
  export { IndicatorChart } from './indicator-chart';
14
- export { ChartWidget } from './chart-widget';
15
14
  export { Chart } from './chart';
16
- export { DashboardWidget } from './dashboard-widget';
17
- export { TableWidget } from './table-widget';
18
15
  export { BoxplotChart } from './boxplot-chart';
19
16
  export { AreamapChart } from './areamap-chart';
20
17
  export { ScattermapChart } from './scattermap-chart';
package/dist/src/components/charts/indicator-chart.d.ts CHANGED
@@ -16,24 +16,29 @@ import type { PropType } from 'vue';
16
16
  *
17
17
  * <script setup lang="ts">
18
18
  * import { ref } from 'vue';
19
+ * import { measureFactory, filterFactory } from '@sisense/sdk-data';
20
+ * import * as DM from '../assets/sample-retail-model';
19
21
  * import {IndicatorChart, type IndicatorChartProps} from '@sisense/sdk-ui-vue';
20
- *
21
- const indicatorChartProps = ref<IndicatorChartProps>({
22
- dataSet: DM.DataSource,
22
+
23
+ * const dimProductName = DM.DimProducts.ProductName;
24
+ * const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
25
+ const indicatorChartProps = ref<IndicatorChartProps>({
26
+ dataSet: DM.DataSource,
23
27
  dataOptions: {
24
- value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
25
- },
26
- filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
27
- });
28
+ value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
29
+ },
30
+ filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
31
+ });
28
32
  * </script>
29
33
  * ```
30
- * <img src="media://indicator-chart-example-1.png" width="400px" />
34
+ * <img src="media://vue-indicator-chart-example.png" width="400px" />
31
35
  * @param props - Indicator chart properties
32
36
  * @returns Indicator Chart component
37
+ * @group Charts
33
38
  */
34
39
  export declare const IndicatorChart: import("vue").DefineComponent<{
35
40
  dataOptions: PropType<import("@sisense/sdk-ui-preact").IndicatorChartDataOptions>;
36
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
41
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
37
42
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
38
43
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
39
44
  styleOptions: PropType<import("@sisense/sdk-ui-preact").IndicatorStyleOptions | undefined>;
@@ -41,7 +46,7 @@ export declare const IndicatorChart: import("vue").DefineComponent<{
41
46
  [key: string]: any;
42
47
  }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
43
48
  dataOptions: PropType<import("@sisense/sdk-ui-preact").IndicatorChartDataOptions>;
44
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
49
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
45
50
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
46
51
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
47
52
  styleOptions: PropType<import("@sisense/sdk-ui-preact").IndicatorStyleOptions | undefined>;
package/dist/src/components/charts/line-chart.d.ts CHANGED
@@ -16,25 +16,30 @@ import type { PropType } from 'vue';
16
16
  *
17
17
  * <script setup lang="ts">
18
18
  * import { ref } from 'vue';
19
+ * import { measureFactory, filterFactory } from '@sisense/sdk-data';
20
+ * import * as DM from '../assets/sample-retail-model';
19
21
  * import {LineChart, type LineChartProps} from '@sisense/sdk-ui-vue';
20
- *
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
- });
22
+
23
+ * const dimProductName = DM.DimProducts.ProductName;
24
+ * const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
25
+ * const lineChartProps = ref<LineChartProps>({
26
+ dataSet: DM.DataSource,
27
+ dataOptions: {
28
+ category: [dimProductName],
29
+ value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
30
+ breakBy: [],
31
+ },
32
+ filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
33
+ });
30
34
  * ```
31
- * <img src="media://line-chart-example-1.png" width="800px" />
35
+ * <img src="media://vue-line-chart-example.png" width="800px" />
32
36
  * @param props - Line chart properties
33
37
  * @returns Line Chart component
38
+ * @group Charts
34
39
  */
35
40
  export declare const LineChart: import("vue").DefineComponent<{
36
41
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CartesianChartDataOptions>;
37
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
42
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
38
43
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
39
44
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
40
45
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
@@ -46,7 +51,7 @@ export declare const LineChart: import("vue").DefineComponent<{
46
51
  [key: string]: any;
47
52
  }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
48
53
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CartesianChartDataOptions>;
49
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
54
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
50
55
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
51
56
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
52
57
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
package/dist/src/components/charts/pie-chart.d.ts CHANGED
@@ -17,24 +17,29 @@ import type { PropType } from 'vue';
17
17
  *
18
18
  * <script setup lang="ts">
19
19
  * import { ref } from 'vue';
20
+ * import { measureFactory, filterFactory } from '@sisense/sdk-data';
21
+ * import * as DM from '../assets/sample-retail-model';
20
22
  * import {PieChart,type PieChartProps} from '@sisense/sdk-ui-vue';
21
23
  *
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
- });
24
+ * const dimProductName = DM.DimProducts.ProductName;
25
+ * const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
26
+ * const pieChartProps = ref<PieChartProps>({
27
+ dataSet: DM.DataSource,
28
+ dataOptions: {
29
+ category: [dimProductName],
30
+ value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
31
+ },
32
+ filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
33
+ });
30
34
  * ```
31
- * <img src="media://pie-chart-example-1.png" width="600px" />
35
+ * <img src="media://vue-pie-chart-example.png" width="800px" />
32
36
  * @param props - Pie chart properties
33
37
  * @returns Pie Chart component
38
+ * @group Charts
34
39
  */
35
40
  export declare const PieChart: import("vue").DefineComponent<{
36
41
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CategoricalChartDataOptions>;
37
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
42
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
38
43
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
39
44
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
40
45
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
@@ -46,7 +51,7 @@ export declare const PieChart: import("vue").DefineComponent<{
46
51
  [key: string]: any;
47
52
  }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
48
53
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CategoricalChartDataOptions>;
49
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
54
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
50
55
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
51
56
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
52
57
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
package/dist/src/components/charts/pivot-table.d.ts CHANGED
@@ -1,32 +1,45 @@
1
1
  import type { PropType } from 'vue';
2
2
  /**
3
- * TBU
4
- * A Vue component that wraps the PivotTable Preact component for use in Vue applications.
5
- * It provides a single 'props' prop to pass all the TableProps to the Table Preact component,
6
- * enabling the use of the table within Vue's reactivity system.
3
+ * A Vue component for Pivot table with pagination.
7
4
  *
8
5
  * @example
9
- * Here's how you can use the Table component in a Vue application:
6
+ * Here's how you can use the PivotTable component in a Vue application:
10
7
  * ```vue
11
8
  * <template>
12
- * <Table :props="tableProps" />
9
+ <PivotTable :dataOptions="pivotTableProps.dataOptions" :dataSet="pivotTableProps.dataSet"
10
+ :styleOptions="pivotTableProps.styleOptions" :filters="pivotTableProps.filters" />
13
11
  * </template>
14
12
  *
15
13
  * <script setup lang="ts">
16
14
  * import { ref } from 'vue';
17
- * import Table from '@sisense/sdk-ui-vue/Table';
15
+ * import { measureFactory, filterFactory } from '@sisense/sdk-data';
16
+ * import * as DM from '../assets/sample-retail-model';
17
+ * import {PivotTable, type PivotTableProps} from '@sisense/sdk-ui-vue/Table';
18
18
  *
19
- * const tableProps = ref({
20
- * // Define your TableProps configuration here
21
- * });
19
+ * const dimProductName = DM.DimProducts.ProductName;
20
+ * const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
21
+ const pivotTableProps = ref<PivotTableProps>({
22
+ dataSet: DM.DataSource,
23
+ dataOptions: {
24
+ rows: [dimProductName, dimColor],
25
+ columns: [dimCategoryName],
26
+ values: [measureTotalRevenue],
27
+ },
28
+ styleOptions: {
29
+ width: 1200,
30
+ height: 500,
31
+ },
32
+ filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 1000)],
33
+ });
22
34
  * </script>
23
35
  * ```
24
- *
36
+ * <img src="media://vue-pivot-table-example.png" width="800px" />
37
+ * @group Data Grids
25
38
  * @alpha
26
39
  */
27
40
  export declare const PivotTable: import("vue").DefineComponent<{
28
41
  dataOptions: PropType<import("@sisense/sdk-ui-preact").PivotTableDataOptions>;
29
- dataSet: PropType<string | undefined>;
42
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | undefined>;
30
43
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
31
44
  refreshCounter: PropType<number | undefined>;
32
45
  styleOptions: PropType<import("@sisense/sdk-ui-preact").PivotTableStyleOptions | undefined>;
@@ -34,7 +47,7 @@ export declare const PivotTable: import("vue").DefineComponent<{
34
47
  [key: string]: any;
35
48
  }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
36
49
  dataOptions: PropType<import("@sisense/sdk-ui-preact").PivotTableDataOptions>;
37
- dataSet: PropType<string | undefined>;
50
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | undefined>;
38
51
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
39
52
  refreshCounter: PropType<number | undefined>;
40
53
  styleOptions: PropType<import("@sisense/sdk-ui-preact").PivotTableStyleOptions | undefined>;
package/dist/src/components/charts/polar-chart.d.ts CHANGED
@@ -16,25 +16,30 @@ import { type PropType } from 'vue';
16
16
  *
17
17
  * <script setup lang="ts">
18
18
  * import { ref } from 'vue';
19
+ * import { measureFactory, filterFactory } from '@sisense/sdk-data';
20
+ * import * as DM from '../assets/sample-retail-model';
19
21
  * import {PolarChart,type PolarChartProps} from '@sisense/sdk-ui-vue';
20
22
  *
21
- const polarChartProps = ref<PolarChartProps>({
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
- });
23
+ * const dimProductName = DM.DimProducts.ProductName;
24
+ * const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
25
+ * const polarChartProps = ref<PolarChartProps>({
26
+ dataSet: DM.DataSource,
27
+ dataOptions: {
28
+ category: [dimProductName],
29
+ value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
30
+ breakBy: [],
31
+ },
32
+ filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
33
+ });
30
34
  * ```
31
- * <img src="media://polar-chart-example-1.png" width="600px" />
35
+ * <img src="media://vue-polar-chart-example.png" width="600px" />
32
36
  * @param props - Polar chart properties
33
37
  * @returns Polar Chart component
38
+ * @group Charts
34
39
  */
35
40
  export declare const PolarChart: import("vue").DefineComponent<{
36
41
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CartesianChartDataOptions>;
37
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
42
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
38
43
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
39
44
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
40
45
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
@@ -46,7 +51,7 @@ export declare const PolarChart: import("vue").DefineComponent<{
46
51
  [key: string]: any;
47
52
  }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
48
53
  dataOptions: PropType<import("@sisense/sdk-ui-preact").CartesianChartDataOptions>;
49
- dataSet: PropType<string | import("@sisense/sdk-data").Data | undefined>;
54
+ dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
50
55
  filters: PropType<import("@sisense/sdk-data").Filter[] | import("@sisense/sdk-data").FilterRelations | undefined>;
51
56
  highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
52
57
  onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;