@sisense/sdk-ui-vue 1.5.0 → 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.
- package/dist/index.js +88381 -83531
- package/dist/src/components/charts/area-chart.d.ts +6 -1
- package/dist/src/components/charts/areamap-chart.d.ts +8 -1
- package/dist/src/components/charts/bar-chart.d.ts +8 -3
- package/dist/src/components/charts/boxplot-chart.d.ts +8 -3
- package/dist/src/components/charts/chart.d.ts +27 -11
- package/dist/src/components/charts/column-chart.d.ts +7 -1
- package/dist/src/components/charts/funnel-chart.d.ts +8 -2
- package/dist/src/components/charts/index.d.ts +0 -3
- package/dist/src/components/charts/indicator-chart.d.ts +13 -8
- package/dist/src/components/charts/line-chart.d.ts +16 -11
- package/dist/src/components/charts/pie-chart.d.ts +14 -9
- package/dist/src/components/charts/pivot-table.d.ts +24 -11
- package/dist/src/components/charts/polar-chart.d.ts +15 -10
- package/dist/src/components/charts/scatter-chart.d.ts +14 -9
- package/dist/src/components/charts/scattermap-chart.d.ts +14 -9
- package/dist/src/components/charts/sunburst-chart.d.ts +17 -8
- package/dist/src/components/charts/table.d.ts +21 -6
- package/dist/src/components/charts/treemap-chart.d.ts +15 -10
- package/dist/src/components/context-menu.d.ts +1 -0
- package/dist/src/components/drilldown-breadcrumbs.d.ts +1 -0
- package/dist/src/components/drilldown-widget.d.ts +90 -0
- package/dist/src/components/filters/criteria-filter-tile.d.ts +2 -1
- package/dist/src/components/filters/date-range-filter-tile.d.ts +22 -13
- package/dist/src/components/filters/member-filter-tile.d.ts +21 -12
- package/dist/src/components/{charts → widgets}/chart-widget.d.ts +6 -2
- package/dist/src/components/{charts → widgets}/dashboard-widget.d.ts +5 -0
- package/dist/src/components/widgets/index.d.ts +3 -0
- package/dist/src/components/{charts → widgets}/table-widget.d.ts +1 -0
- package/dist/src/composables/use-execute-query-by-widget-id.d.ts +2 -0
- package/dist/src/composables/use-execute-query.d.ts +1 -0
- package/dist/src/composables/use-get-dashboard-model.d.ts +1 -0
- package/dist/src/composables/use-get-dashboard-models.d.ts +1 -0
- package/dist/src/composables/use-get-shared-formula.d.ts +1 -0
- package/dist/src/composables/use-get-widget-model.d.ts +1 -0
- package/dist/src/lib.d.ts +1 -0
- package/dist/src/providers/sisense-context-provider.d.ts +1 -0
- package/dist/src/providers/theme-provider.d.ts +2 -0
- package/dist/src/sdk-ui-core-exports.d.ts +1 -1
- package/package.json +2 -1
@@ -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,8 +33,10 @@ 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>;
|
@@ -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,8 +33,10 @@ 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<{
|
@@ -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 {
|
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
|
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
|
/**
|
@@ -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
|
-
|
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,9 +33,10 @@ import type { PropType } from 'vue';
|
|
29
33
|
filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
|
30
34
|
});
|
31
35
|
* ```
|
32
|
-
* <img src="media://boxplot-chart-example
|
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<{
|
@@ -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
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
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,13 +48,15 @@ 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-
|
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>;
|
@@ -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,9 +34,10 @@ const columnChartProps = ref<ColumnChartProps>({
|
|
29
34
|
filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
|
30
35
|
});
|
31
36
|
* ```
|
32
|
-
* <img src="media://column-chart-example
|
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>;
|
@@ -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
|
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,11 +33,12 @@ const funnelChartProps = ref<FunnelChartProps>({
|
|
28
33
|
});
|
29
34
|
* </script>
|
30
35
|
* ```
|
31
|
-
* <img src="media://funnel-chart-example
|
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>;
|
@@ -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';
|
@@ -16,20 +16,25 @@ 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
|
-
|
22
|
-
|
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
|
-
|
25
|
-
|
26
|
-
|
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
|
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>;
|
@@ -16,21 +16,26 @@ 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
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
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
|
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>;
|
@@ -17,20 +17,25 @@ 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
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
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
|
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>;
|
@@ -1,27 +1,40 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
2
|
/**
|
3
|
-
*
|
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
|
6
|
+
* Here's how you can use the PivotTable component in a Vue application:
|
10
7
|
* ```vue
|
11
8
|
* <template>
|
12
|
-
|
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
|
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
|
20
|
-
*
|
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<{
|
@@ -16,21 +16,26 @@ 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
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
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
|
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>;
|
@@ -23,20 +23,25 @@ import type { PropType } from 'vue';
|
|
23
23
|
*
|
24
24
|
* <script setup lang="ts">
|
25
25
|
* import { ref } from 'vue';
|
26
|
+
* import { measureFactory, filterFactory } from '@sisense/sdk-data';
|
27
|
+
* import * as DM from '../assets/sample-retail-model';
|
26
28
|
* import {ScatterChart, type ScatterChartProps} from '@sisense/sdk-ui-vue';
|
27
29
|
*
|
28
|
-
const
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
}
|
30
|
+
* const dimProductName = DM.DimProducts.ProductName;
|
31
|
+
* const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
|
32
|
+
* const scatterChartProps = ref<ScatterChartProps>({
|
33
|
+
dataSet: DM.DataSource,
|
34
|
+
dataOptions: {
|
35
|
+
x: dimProductName,
|
36
|
+
y: measureTotalRevenue,
|
37
|
+
},
|
38
|
+
filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
|
39
|
+
});
|
36
40
|
* ```
|
37
|
-
* <img src="media://scatter-chart-example
|
41
|
+
* <img src="media://vue-scatter-chart-example.png" width="800px" />
|
38
42
|
* @param props - Scatter chart properties
|
39
43
|
* @returns Scatter Chart component
|
44
|
+
* @group Charts
|
40
45
|
*/
|
41
46
|
export declare const ScatterChart: import("vue").DefineComponent<{
|
42
47
|
dataOptions: PropType<import("@sisense/sdk-ui-preact").ScatterChartDataOptions>;
|
@@ -16,21 +16,26 @@ 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 {ScattermapChart,type ScattermapChartProps} from '@sisense/sdk-ui-vue';
|
20
22
|
*
|
21
|
-
const
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
}
|
23
|
+
* const dimProductName = DM.DimProducts.ProductName;
|
24
|
+
* const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
|
25
|
+
* const scattermapChartProps = ref<ScattermapChartProps>({
|
26
|
+
dataSet: DM.DataSource,
|
27
|
+
dataOptions: {
|
28
|
+
geo: [DM.DimCountries.CountryName],
|
29
|
+
size: { column: measureTotalRevenue, title: 'Total Revenue' },
|
30
|
+
},
|
31
|
+
filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
|
32
|
+
});
|
29
33
|
* </script>
|
30
34
|
* ```
|
31
|
-
* <img src="media://scattermap-chart-example
|
35
|
+
* <img src="media://vue-scattermap-chart-example.png" width="600px" />
|
32
36
|
* @param props - Scattermap chart properties
|
33
37
|
* @returns Scattermap Chart component
|
38
|
+
* @group Charts
|
34
39
|
* @beta
|
35
40
|
*/
|
36
41
|
export declare const ScattermapChart: import("vue").DefineComponent<{
|
@@ -16,17 +16,26 @@ 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 {SunburstChart,type SunburstChartProps} from '@sisense/sdk-ui-vue';
|
20
22
|
*
|
21
|
-
const
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
}
|
23
|
+
* const dimProductName = DM.DimProducts.ProductName;
|
24
|
+
* const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
|
25
|
+
* const sunburstChartProps = ref<SunburstChartProps>({
|
26
|
+
dataSet: DM.DataSource,
|
27
|
+
dataOptions: {
|
28
|
+
category: [dimProductName],
|
29
|
+
value: [{ column: measureTotalRevenue, sortType: 'sortDesc' }],
|
30
|
+
},
|
31
|
+
filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
|
32
|
+
});
|
29
33
|
* ```
|
34
|
+
* <img src="media://vue-sunburst-chart-example.png" width="600px" />
|
35
|
+
* @param props - Sunburst Chart properties
|
36
|
+
* @returns Sunburst Chart component
|
37
|
+
* @group Charts
|
38
|
+
* @beta
|
30
39
|
*/
|
31
40
|
export declare const SunburstChart: import("vue").DefineComponent<{
|
32
41
|
dataOptions: PropType<import("@sisense/sdk-ui-preact").CategoricalChartDataOptions>;
|
@@ -6,21 +6,36 @@ import type { PropType } from 'vue';
|
|
6
6
|
* Here's how you can use the Table component in a Vue application:
|
7
7
|
* ```vue
|
8
8
|
* <template>
|
9
|
-
*
|
9
|
+
* <Table :dataOptions="tableProps.dataOptions" :dataSet="tableProps.dataSet"
|
10
|
+
:styleOptions="tableProps.styleOptions" :filters="tableProps.filters" />
|
10
11
|
* </template>
|
11
12
|
*
|
12
13
|
* <script setup lang="ts">
|
13
14
|
* import { ref } from 'vue';
|
14
|
-
* import
|
15
|
+
* import { measureFactory, filterFactory } from '@sisense/sdk-data';
|
16
|
+
* import * as DM from '../assets/sample-retail-model';
|
17
|
+
* import { Table, type TableProps } from '@sisense/sdk-ui-vue';
|
15
18
|
*
|
16
|
-
* const
|
17
|
-
*
|
18
|
-
*
|
19
|
+
* const dimProductName = DM.DimProducts.ProductName;
|
20
|
+
* const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
|
21
|
+
*
|
22
|
+
* const tableProps = ref<TableProps>({
|
23
|
+
dataSet: DM.DataSource,
|
24
|
+
dataOptions: {
|
25
|
+
columns: [dimProductName, measureTotalRevenue],
|
26
|
+
},
|
27
|
+
styleOptions: {
|
28
|
+
width: 800,
|
29
|
+
height: 500,
|
30
|
+
},
|
31
|
+
filters: [filterFactory.topRanking(dimProductName, measureTotalRevenue, 10)],
|
32
|
+
* });
|
19
33
|
* </script>
|
20
34
|
* ```
|
21
|
-
* <img src="media://table-example
|
35
|
+
* <img src="media://vue-table-example.png" width="800px" />
|
22
36
|
* @param props - Table properties
|
23
37
|
* @returns Table component
|
38
|
+
* @group Data Grids
|
24
39
|
*/
|
25
40
|
export declare const Table: import("vue").DefineComponent<{
|
26
41
|
dataOptions: PropType<import("@sisense/sdk-ui-preact").TableDataOptions>;
|
@@ -17,20 +17,25 @@ import type { PropType } from 'vue';
|
|
17
17
|
*
|
18
18
|
* <script setup lang="ts">
|
19
19
|
* import { ref } from 'vue';
|
20
|
-
* import
|
20
|
+
* import { measureFactory, filterFactory } from '@sisense/sdk-data';
|
21
|
+
* import * as DM from '../assets/sample-retail-model';
|
22
|
+
* import {TreemapChart, type TreemapChartProps} from '@sisense/sdk-ui-vue';
|
21
23
|
*
|
22
|
-
const
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
}
|
24
|
+
* const dimProductName = DM.DimProducts.ProductName;
|
25
|
+
* const measureTotalRevenue = measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue');
|
26
|
+
* const treemapChartProps = ref<TreemapChartProps>({
|
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://treemap-chart-example
|
35
|
+
* <img src="media://vue-treemap-chart-example.png" width="600px" />
|
32
36
|
* @param props - Treemap chart properties
|
33
37
|
* @returns Treemap Chart component
|
38
|
+
* @group Charts
|
34
39
|
*/
|
35
40
|
export declare const TreemapChart: import("vue").DefineComponent<{
|
36
41
|
dataOptions: PropType<import("@sisense/sdk-ui-preact").CategoricalChartDataOptions>;
|
@@ -30,6 +30,7 @@ import type { PropType } from 'vue';
|
|
30
30
|
* @prop {Function} closeContextMenu - Function to close the context menu. It should be a function that sets the visibility of the context menu to false.
|
31
31
|
* @prop {Array} itemSections - An array of sections, each containing an array of items to be rendered in the context menu. Each item can be a string or an object specifying the item's properties.
|
32
32
|
* @prop {Object} position - An object specifying the position of the context menu. It should contain `top` and `left` properties to position the menu on the screen.
|
33
|
+
* @group Drilldown
|
33
34
|
*/
|
34
35
|
export declare const ContextMenu: import("vue").DefineComponent<{
|
35
36
|
closeContextMenu: PropType<() => void>;
|