@sisense/sdk-ui-vue 1.34.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/ai.cjs +141 -29
- package/dist/ai.js +1071 -890
- package/dist/index.cjs +1 -1
- package/dist/index.js +1687 -1461
- package/dist/packages/sdk-ui-vue/src/ai/components/chatbot.d.ts +0 -5
- package/dist/packages/sdk-ui-vue/src/ai/components/get-nlg-insights.d.ts +10 -9
- package/dist/packages/sdk-ui-vue/src/ai/composables/use-get-nlg-insights.d.ts +0 -5
- package/dist/packages/sdk-ui-vue/src/ai/composables/use-get-nlq-result.d.ts +7 -5
- package/dist/packages/sdk-ui-vue/src/ai/composables/use-get-query-recommendations.d.ts +17 -6
- package/dist/packages/sdk-ui-vue/src/ai/providers/ai-context-provider/ai-context-provider.d.ts +0 -5
- package/dist/packages/sdk-ui-vue/src/ai/sdk-ui-core-exports.d.ts +1 -1
- package/dist/packages/sdk-ui-vue/src/components/charts/area-chart.d.ts +10 -6
- package/dist/packages/sdk-ui-vue/src/components/charts/area-range-chart.d.ts +10 -7
- package/dist/packages/sdk-ui-vue/src/components/charts/areamap-chart.d.ts +10 -6
- package/dist/packages/sdk-ui-vue/src/components/charts/bar-chart.d.ts +10 -6
- package/dist/packages/sdk-ui-vue/src/components/charts/boxplot-chart.d.ts +10 -6
- package/dist/packages/sdk-ui-vue/src/components/charts/chart.d.ts +18 -8
- package/dist/packages/sdk-ui-vue/src/components/charts/column-chart.d.ts +10 -6
- package/dist/packages/sdk-ui-vue/src/components/charts/funnel-chart.d.ts +10 -6
- package/dist/packages/sdk-ui-vue/src/components/charts/indicator-chart.d.ts +10 -6
- package/dist/packages/sdk-ui-vue/src/components/charts/line-chart.d.ts +10 -6
- package/dist/packages/sdk-ui-vue/src/components/charts/pie-chart.d.ts +10 -6
- package/dist/packages/sdk-ui-vue/src/components/charts/pivot-table.d.ts +10 -4
- package/dist/packages/sdk-ui-vue/src/components/charts/polar-chart.d.ts +10 -6
- package/dist/packages/sdk-ui-vue/src/components/charts/scatter-chart.d.ts +10 -6
- package/dist/packages/sdk-ui-vue/src/components/charts/scattermap-chart.d.ts +10 -6
- package/dist/packages/sdk-ui-vue/src/components/charts/sunburst-chart.d.ts +10 -6
- package/dist/packages/sdk-ui-vue/src/components/charts/table.d.ts +22 -4
- package/dist/packages/sdk-ui-vue/src/components/charts/treemap-chart.d.ts +10 -6
- package/dist/packages/sdk-ui-vue/src/components/context-menu.d.ts +8 -2
- package/dist/packages/sdk-ui-vue/src/components/dashboard/dashboard-by-id.d.ts +8 -2
- package/dist/packages/sdk-ui-vue/src/components/dashboard/dashboard.d.ts +16 -5
- package/dist/packages/sdk-ui-vue/src/components/drilldown-breadcrumbs.d.ts +32 -8
- package/dist/packages/sdk-ui-vue/src/components/drilldown-widget.d.ts +0 -25
- package/dist/packages/sdk-ui-vue/src/components/filters/criteria-filter-tile.d.ts +24 -6
- package/dist/packages/sdk-ui-vue/src/components/filters/date-range-filter-tile.d.ts +32 -8
- package/dist/packages/sdk-ui-vue/src/components/filters/filter-tile.d.ts +94 -0
- package/dist/packages/sdk-ui-vue/src/components/filters/index.d.ts +1 -0
- package/dist/packages/sdk-ui-vue/src/components/filters/member-filter-tile.d.ts +32 -8
- package/dist/packages/sdk-ui-vue/src/components/filters/relative-date-filter-tile.d.ts +24 -6
- package/dist/packages/sdk-ui-vue/src/components/widgets/chart-widget.d.ts +32 -8
- package/dist/packages/sdk-ui-vue/src/components/widgets/index.d.ts +1 -1
- package/dist/packages/sdk-ui-vue/src/components/widgets/table-widget.d.ts +25 -19
- package/dist/packages/sdk-ui-vue/src/components/widgets/widget-by-id.d.ts +28 -4
- package/dist/packages/sdk-ui-vue/src/components/widgets/widget.d.ts +298 -0
- package/dist/packages/sdk-ui-vue/src/composables/index.d.ts +1 -0
- package/dist/packages/sdk-ui-vue/src/composables/use-composed-dashboard.d.ts +40 -0
- package/dist/packages/sdk-ui-vue/src/providers/sisense-context-provider/sisense-context-provider.d.ts +8 -2
- package/dist/packages/sdk-ui-vue/src/sdk-ui-core-exports.d.ts +1 -1
- package/dist/packages/sdk-ui-vue/src/utilities/dashboard-helpers.d.ts +0 -11
- package/dist/{use-tracking-07070102.cjs → use-tracking-1ffcd697.cjs} +257 -253
- package/dist/{use-tracking-0536543b.js → use-tracking-38c33085.js} +23698 -23641
- package/package.json +2 -2
- package/dist/packages/sdk-ui-vue/src/components/widgets/dashboard-widget.d.ts +0 -233
@@ -40,7 +40,10 @@ export declare const DashboardById: import("vue").DefineComponent<{
|
|
40
40
|
/**
|
41
41
|
* {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.dashboardOid}
|
42
42
|
*/
|
43
|
-
dashboardOid:
|
43
|
+
dashboardOid: {
|
44
|
+
type: PropType<string>;
|
45
|
+
required: true;
|
46
|
+
};
|
44
47
|
/**
|
45
48
|
* {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.config}
|
46
49
|
*/
|
@@ -51,7 +54,10 @@ export declare const DashboardById: import("vue").DefineComponent<{
|
|
51
54
|
/**
|
52
55
|
* {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.dashboardOid}
|
53
56
|
*/
|
54
|
-
dashboardOid:
|
57
|
+
dashboardOid: {
|
58
|
+
type: PropType<string>;
|
59
|
+
required: true;
|
60
|
+
};
|
55
61
|
/**
|
56
62
|
* {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.config}
|
57
63
|
*/
|
@@ -1,10 +1,15 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
2
|
import type { DashboardProps as DashboardPropsPreact } from '@sisense/sdk-ui-preact';
|
3
3
|
import type { DashboardConfig } from '../../types';
|
4
|
+
import type { WidgetProps } from '../widgets';
|
4
5
|
/**
|
5
6
|
* Props of the {@link @sisense/sdk-ui-vue!Dashboard | `Dashboard`} component.
|
6
7
|
*/
|
7
|
-
export interface DashboardProps extends DashboardPropsPreact {
|
8
|
+
export interface DashboardProps extends Omit<DashboardPropsPreact, 'widgets'> {
|
9
|
+
/**
|
10
|
+
* {@inheritDoc @sisense/sdk-ui!DashboardProps.widgets}
|
11
|
+
*/
|
12
|
+
widgets: WidgetProps[];
|
8
13
|
/**
|
9
14
|
* {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.config}
|
10
15
|
*/
|
@@ -65,11 +70,14 @@ export declare const Dashboard: import("vue").DefineComponent<{
|
|
65
70
|
/**
|
66
71
|
* {@inheritDoc @sisense/sdk-ui!DashboardProps.widgets}
|
67
72
|
*/
|
68
|
-
widgets:
|
73
|
+
widgets: {
|
74
|
+
type: PropType<WidgetProps[]>;
|
75
|
+
required: true;
|
76
|
+
};
|
69
77
|
/**
|
70
78
|
* {@inheritDoc @sisense/sdk-ui!DashboardProps.filters}
|
71
79
|
*/
|
72
|
-
filters: PropType<import("@sisense/sdk-data").
|
80
|
+
filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
|
73
81
|
/**
|
74
82
|
* {@inheritDoc @sisense/sdk-ui!DashboardProps.defaultDataSource}
|
75
83
|
*/
|
@@ -100,11 +108,14 @@ export declare const Dashboard: import("vue").DefineComponent<{
|
|
100
108
|
/**
|
101
109
|
* {@inheritDoc @sisense/sdk-ui!DashboardProps.widgets}
|
102
110
|
*/
|
103
|
-
widgets:
|
111
|
+
widgets: {
|
112
|
+
type: PropType<WidgetProps[]>;
|
113
|
+
required: true;
|
114
|
+
};
|
104
115
|
/**
|
105
116
|
* {@inheritDoc @sisense/sdk-ui!DashboardProps.filters}
|
106
117
|
*/
|
107
|
-
filters: PropType<import("@sisense/sdk-data").
|
118
|
+
filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
|
108
119
|
/**
|
109
120
|
* {@inheritDoc @sisense/sdk-ui!DashboardProps.defaultDataSource}
|
110
121
|
*/
|
@@ -49,25 +49,37 @@ export declare const DrilldownBreadcrumbs: import("vue").DefineComponent<{
|
|
49
49
|
*
|
50
50
|
* @category Widget
|
51
51
|
*/
|
52
|
-
clearDrilldownSelections:
|
52
|
+
clearDrilldownSelections: {
|
53
|
+
type: PropType<() => void>;
|
54
|
+
required: true;
|
55
|
+
};
|
53
56
|
/**
|
54
57
|
* {@inheritDoc @sisense/sdk-ui!DrilldownBreadcrumbsProps.currentDimension}
|
55
58
|
*
|
56
59
|
* @category Widget
|
57
60
|
*/
|
58
|
-
currentDimension:
|
61
|
+
currentDimension: {
|
62
|
+
type: PropType<import("@sisense/sdk-data").Attribute>;
|
63
|
+
required: true;
|
64
|
+
};
|
59
65
|
/**
|
60
66
|
* {@inheritDoc @sisense/sdk-ui!DrilldownBreadcrumbsProps.sliceDrilldownSelections}
|
61
67
|
*
|
62
68
|
* @category Widget
|
63
69
|
*/
|
64
|
-
sliceDrilldownSelections:
|
70
|
+
sliceDrilldownSelections: {
|
71
|
+
type: PropType<(i: number) => void>;
|
72
|
+
required: true;
|
73
|
+
};
|
65
74
|
/**
|
66
75
|
* {@inheritDoc @sisense/sdk-ui!DrilldownBreadcrumbsProps.filtersDisplayValues}
|
67
76
|
*
|
68
77
|
* @category Widget
|
69
78
|
*/
|
70
|
-
filtersDisplayValues:
|
79
|
+
filtersDisplayValues: {
|
80
|
+
type: PropType<string[][]>;
|
81
|
+
required: true;
|
82
|
+
};
|
71
83
|
}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
72
84
|
[key: string]: any;
|
73
85
|
}>[], unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
@@ -76,23 +88,35 @@ export declare const DrilldownBreadcrumbs: import("vue").DefineComponent<{
|
|
76
88
|
*
|
77
89
|
* @category Widget
|
78
90
|
*/
|
79
|
-
clearDrilldownSelections:
|
91
|
+
clearDrilldownSelections: {
|
92
|
+
type: PropType<() => void>;
|
93
|
+
required: true;
|
94
|
+
};
|
80
95
|
/**
|
81
96
|
* {@inheritDoc @sisense/sdk-ui!DrilldownBreadcrumbsProps.currentDimension}
|
82
97
|
*
|
83
98
|
* @category Widget
|
84
99
|
*/
|
85
|
-
currentDimension:
|
100
|
+
currentDimension: {
|
101
|
+
type: PropType<import("@sisense/sdk-data").Attribute>;
|
102
|
+
required: true;
|
103
|
+
};
|
86
104
|
/**
|
87
105
|
* {@inheritDoc @sisense/sdk-ui!DrilldownBreadcrumbsProps.sliceDrilldownSelections}
|
88
106
|
*
|
89
107
|
* @category Widget
|
90
108
|
*/
|
91
|
-
sliceDrilldownSelections:
|
109
|
+
sliceDrilldownSelections: {
|
110
|
+
type: PropType<(i: number) => void>;
|
111
|
+
required: true;
|
112
|
+
};
|
92
113
|
/**
|
93
114
|
* {@inheritDoc @sisense/sdk-ui!DrilldownBreadcrumbsProps.filtersDisplayValues}
|
94
115
|
*
|
95
116
|
* @category Widget
|
96
117
|
*/
|
97
|
-
filtersDisplayValues:
|
118
|
+
filtersDisplayValues: {
|
119
|
+
type: PropType<string[][]>;
|
120
|
+
required: true;
|
121
|
+
};
|
98
122
|
}>>, {}, {}>;
|
@@ -117,18 +117,6 @@ export declare const DrilldownWidgetTs: import("vue").DefineComponent<{
|
|
117
117
|
required: false;
|
118
118
|
default: () => {};
|
119
119
|
};
|
120
|
-
/**
|
121
|
-
* {@inheritDoc @sisense/sdk-ui!DrilldownWidgetProps.drilldownDimensions}
|
122
|
-
*
|
123
|
-
* @category Widget
|
124
|
-
* @deprecated Use {@link drilldownPaths} instead
|
125
|
-
*
|
126
|
-
*/
|
127
|
-
drilldownDimensions: {
|
128
|
-
type: PropType<import("@sisense/sdk-data").Attribute[] | undefined>;
|
129
|
-
required: false;
|
130
|
-
default: () => never[];
|
131
|
-
};
|
132
120
|
/**
|
133
121
|
* {@inheritDoc @sisense/sdk-ui!DrilldownWidgetProps.drilldownPaths}
|
134
122
|
*
|
@@ -161,18 +149,6 @@ export declare const DrilldownWidgetTs: import("vue").DefineComponent<{
|
|
161
149
|
required: false;
|
162
150
|
default: () => {};
|
163
151
|
};
|
164
|
-
/**
|
165
|
-
* {@inheritDoc @sisense/sdk-ui!DrilldownWidgetProps.drilldownDimensions}
|
166
|
-
*
|
167
|
-
* @category Widget
|
168
|
-
* @deprecated Use {@link drilldownPaths} instead
|
169
|
-
*
|
170
|
-
*/
|
171
|
-
drilldownDimensions: {
|
172
|
-
type: PropType<import("@sisense/sdk-data").Attribute[] | undefined>;
|
173
|
-
required: false;
|
174
|
-
default: () => never[];
|
175
|
-
};
|
176
152
|
/**
|
177
153
|
* {@inheritDoc @sisense/sdk-ui!DrilldownWidgetProps.drilldownPaths}
|
178
154
|
*
|
@@ -196,7 +172,6 @@ export declare const DrilldownWidgetTs: import("vue").DefineComponent<{
|
|
196
172
|
};
|
197
173
|
}>>, {
|
198
174
|
config: DrilldownWidgetConfig;
|
199
|
-
drilldownDimensions: import("@sisense/sdk-data").Attribute[] | undefined;
|
200
175
|
drilldownPaths: (import("@sisense/sdk-data").Attribute | import("@sisense/sdk-ui-preact").Hierarchy)[] | undefined;
|
201
176
|
initialDimension: import("@sisense/sdk-data").Attribute;
|
202
177
|
}, {}>;
|
@@ -50,7 +50,10 @@ export declare const CriteriaFilterTile: import("vue").DefineComponent<{
|
|
50
50
|
/**
|
51
51
|
* {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.filter}
|
52
52
|
*/
|
53
|
-
filter:
|
53
|
+
filter: {
|
54
|
+
type: PropType<import("@sisense/sdk-data").Filter>;
|
55
|
+
required: true;
|
56
|
+
};
|
54
57
|
/**
|
55
58
|
* {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.measures}
|
56
59
|
*/
|
@@ -58,11 +61,17 @@ export declare const CriteriaFilterTile: import("vue").DefineComponent<{
|
|
58
61
|
/**
|
59
62
|
* {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.onUpdate}
|
60
63
|
*/
|
61
|
-
onUpdate:
|
64
|
+
onUpdate: {
|
65
|
+
type: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
|
66
|
+
required: true;
|
67
|
+
};
|
62
68
|
/**
|
63
69
|
* {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.title}
|
64
70
|
*/
|
65
|
-
title:
|
71
|
+
title: {
|
72
|
+
type: PropType<string>;
|
73
|
+
required: true;
|
74
|
+
};
|
66
75
|
/**
|
67
76
|
* {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.onDelete}
|
68
77
|
*/
|
@@ -81,7 +90,10 @@ export declare const CriteriaFilterTile: import("vue").DefineComponent<{
|
|
81
90
|
/**
|
82
91
|
* {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.filter}
|
83
92
|
*/
|
84
|
-
filter:
|
93
|
+
filter: {
|
94
|
+
type: PropType<import("@sisense/sdk-data").Filter>;
|
95
|
+
required: true;
|
96
|
+
};
|
85
97
|
/**
|
86
98
|
* {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.measures}
|
87
99
|
*/
|
@@ -89,11 +101,17 @@ export declare const CriteriaFilterTile: import("vue").DefineComponent<{
|
|
89
101
|
/**
|
90
102
|
* {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.onUpdate}
|
91
103
|
*/
|
92
|
-
onUpdate:
|
104
|
+
onUpdate: {
|
105
|
+
type: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
|
106
|
+
required: true;
|
107
|
+
};
|
93
108
|
/**
|
94
109
|
* {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.title}
|
95
110
|
*/
|
96
|
-
title:
|
111
|
+
title: {
|
112
|
+
type: PropType<string>;
|
113
|
+
required: true;
|
114
|
+
};
|
97
115
|
/**
|
98
116
|
* {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.onDelete}
|
99
117
|
*/
|
@@ -48,7 +48,10 @@ export declare const DateRangeFilterTile: import("vue").DefineComponent<{
|
|
48
48
|
/**
|
49
49
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.attribute}
|
50
50
|
*/
|
51
|
-
attribute:
|
51
|
+
attribute: {
|
52
|
+
type: PropType<import("@sisense/sdk-data").LevelAttribute>;
|
53
|
+
required: true;
|
54
|
+
};
|
52
55
|
/**
|
53
56
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.dataSource}
|
54
57
|
*/
|
@@ -60,7 +63,10 @@ export declare const DateRangeFilterTile: import("vue").DefineComponent<{
|
|
60
63
|
/**
|
61
64
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.filter}
|
62
65
|
*/
|
63
|
-
filter:
|
66
|
+
filter: {
|
67
|
+
type: PropType<import("@sisense/sdk-data").Filter>;
|
68
|
+
required: true;
|
69
|
+
};
|
64
70
|
/**
|
65
71
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.lastDate}
|
66
72
|
*/
|
@@ -68,7 +74,10 @@ export declare const DateRangeFilterTile: import("vue").DefineComponent<{
|
|
68
74
|
/**
|
69
75
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.onChange}
|
70
76
|
*/
|
71
|
-
onChange:
|
77
|
+
onChange: {
|
78
|
+
type: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
|
79
|
+
required: true;
|
80
|
+
};
|
72
81
|
/**
|
73
82
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.parentFilters}
|
74
83
|
*/
|
@@ -76,7 +85,10 @@ export declare const DateRangeFilterTile: import("vue").DefineComponent<{
|
|
76
85
|
/**
|
77
86
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.title}
|
78
87
|
*/
|
79
|
-
title:
|
88
|
+
title: {
|
89
|
+
type: PropType<string>;
|
90
|
+
required: true;
|
91
|
+
};
|
80
92
|
/**
|
81
93
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.tiled}
|
82
94
|
* @internal
|
@@ -96,7 +108,10 @@ export declare const DateRangeFilterTile: import("vue").DefineComponent<{
|
|
96
108
|
/**
|
97
109
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.attribute}
|
98
110
|
*/
|
99
|
-
attribute:
|
111
|
+
attribute: {
|
112
|
+
type: PropType<import("@sisense/sdk-data").LevelAttribute>;
|
113
|
+
required: true;
|
114
|
+
};
|
100
115
|
/**
|
101
116
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.dataSource}
|
102
117
|
*/
|
@@ -108,7 +123,10 @@ export declare const DateRangeFilterTile: import("vue").DefineComponent<{
|
|
108
123
|
/**
|
109
124
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.filter}
|
110
125
|
*/
|
111
|
-
filter:
|
126
|
+
filter: {
|
127
|
+
type: PropType<import("@sisense/sdk-data").Filter>;
|
128
|
+
required: true;
|
129
|
+
};
|
112
130
|
/**
|
113
131
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.lastDate}
|
114
132
|
*/
|
@@ -116,7 +134,10 @@ export declare const DateRangeFilterTile: import("vue").DefineComponent<{
|
|
116
134
|
/**
|
117
135
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.onChange}
|
118
136
|
*/
|
119
|
-
onChange:
|
137
|
+
onChange: {
|
138
|
+
type: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
|
139
|
+
required: true;
|
140
|
+
};
|
120
141
|
/**
|
121
142
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.parentFilters}
|
122
143
|
*/
|
@@ -124,7 +145,10 @@ export declare const DateRangeFilterTile: import("vue").DefineComponent<{
|
|
124
145
|
/**
|
125
146
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.title}
|
126
147
|
*/
|
127
|
-
title:
|
148
|
+
title: {
|
149
|
+
type: PropType<string>;
|
150
|
+
required: true;
|
151
|
+
};
|
128
152
|
/**
|
129
153
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.tiled}
|
130
154
|
* @internal
|
@@ -0,0 +1,94 @@
|
|
1
|
+
import type { PropType } from 'vue';
|
2
|
+
import type { FilterTileProps as FilterTilePropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
+
/**
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!FilterTile | `FilterTile`} component.
|
5
|
+
*/
|
6
|
+
export interface FilterTileProps extends FilterTilePropsPreact {
|
7
|
+
}
|
8
|
+
/**
|
9
|
+
* UI component that renders a filter tile based on filter type
|
10
|
+
*
|
11
|
+
* @example
|
12
|
+
* Here’s how to render a filter model as a filter tile.
|
13
|
+
* ```vue
|
14
|
+
<script setup lang="ts">
|
15
|
+
import { ref } from 'vue';
|
16
|
+
import { FilterTile } from '@sisense/sdk-ui-vue';
|
17
|
+
import { filterFactory, type Filter } from '@sisense/sdk-data';
|
18
|
+
import * as DM from '../assets/sample-ecommerce-model.js';
|
19
|
+
|
20
|
+
const filter = ref<Filter>(filterFactory.members(DM.Commerce.Gender, ['Male', 'Female']));
|
21
|
+
const handleFilterChange = (updatedFilter: Filter | null) => {
|
22
|
+
if (updatedFilter) {
|
23
|
+
filter.value = updatedFilter;
|
24
|
+
}
|
25
|
+
};
|
26
|
+
</script>
|
27
|
+
|
28
|
+
<template>
|
29
|
+
<FilterTile :filter="filter" :onChange="handleFilterChange" />
|
30
|
+
</template>
|
31
|
+
* ```
|
32
|
+
* <img src="media://vue-filter-tile-example.png" width="225px" />
|
33
|
+
* @param props - FilterTile props
|
34
|
+
* @returns FilterTile component
|
35
|
+
* @group Filter Tiles
|
36
|
+
* @shortDescription Facade component rendering a filter tile based on filter type
|
37
|
+
*/
|
38
|
+
export declare const FilterTile: import("vue").DefineComponent<{
|
39
|
+
/**
|
40
|
+
* {@inheritDoc @sisense/sdk-ui!FilterTileProps.filter}
|
41
|
+
*/
|
42
|
+
filter: {
|
43
|
+
type: PropType<import("@sisense/sdk-data").Filter>;
|
44
|
+
required: true;
|
45
|
+
};
|
46
|
+
/**
|
47
|
+
* {@inheritDoc @sisense/sdk-ui!FilterTileProps.defaultDataSource}
|
48
|
+
*/
|
49
|
+
defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
|
50
|
+
/**
|
51
|
+
* {@inheritDoc @sisense/sdk-ui!FilterTileProps.onChange}
|
52
|
+
*/
|
53
|
+
onChange: {
|
54
|
+
type: PropType<(filter: import("@sisense/sdk-data").Filter | null) => void>;
|
55
|
+
required: true;
|
56
|
+
};
|
57
|
+
/**
|
58
|
+
* {@inheritDoc @sisense/sdk-ui!FilterTileProps.onDelete}
|
59
|
+
*/
|
60
|
+
onDelete: PropType<(() => void) | undefined>;
|
61
|
+
/**
|
62
|
+
* {@inheritDoc @sisense/sdk-ui!FilterTileProps.onEdit}
|
63
|
+
*/
|
64
|
+
onEdit: PropType<((levelIndex?: number | undefined) => void) | undefined>;
|
65
|
+
}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
66
|
+
[key: string]: any;
|
67
|
+
}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
68
|
+
/**
|
69
|
+
* {@inheritDoc @sisense/sdk-ui!FilterTileProps.filter}
|
70
|
+
*/
|
71
|
+
filter: {
|
72
|
+
type: PropType<import("@sisense/sdk-data").Filter>;
|
73
|
+
required: true;
|
74
|
+
};
|
75
|
+
/**
|
76
|
+
* {@inheritDoc @sisense/sdk-ui!FilterTileProps.defaultDataSource}
|
77
|
+
*/
|
78
|
+
defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
|
79
|
+
/**
|
80
|
+
* {@inheritDoc @sisense/sdk-ui!FilterTileProps.onChange}
|
81
|
+
*/
|
82
|
+
onChange: {
|
83
|
+
type: PropType<(filter: import("@sisense/sdk-data").Filter | null) => void>;
|
84
|
+
required: true;
|
85
|
+
};
|
86
|
+
/**
|
87
|
+
* {@inheritDoc @sisense/sdk-ui!FilterTileProps.onDelete}
|
88
|
+
*/
|
89
|
+
onDelete: PropType<(() => void) | undefined>;
|
90
|
+
/**
|
91
|
+
* {@inheritDoc @sisense/sdk-ui!FilterTileProps.onEdit}
|
92
|
+
*/
|
93
|
+
onEdit: PropType<((levelIndex?: number | undefined) => void) | undefined>;
|
94
|
+
}>>, {}, {}>;
|
@@ -2,3 +2,4 @@ export { DateRangeFilterTile, type DateRangeFilterTileProps } from './date-range
|
|
2
2
|
export { MemberFilterTile, type MemberFilterTileProps } from './member-filter-tile';
|
3
3
|
export { CriteriaFilterTile, type CriteriaFilterTileProps } from './criteria-filter-tile';
|
4
4
|
export { RelativeDateFilterTile, type RelativeDateFilterTileProps, } from './relative-date-filter-tile';
|
5
|
+
export { FilterTile, type FilterTileProps } from './filter-tile';
|
@@ -50,7 +50,10 @@ export declare const MemberFilterTile: import("vue").DefineComponent<{
|
|
50
50
|
/**
|
51
51
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.attribute}
|
52
52
|
*/
|
53
|
-
attribute:
|
53
|
+
attribute: {
|
54
|
+
type: PropType<import("@sisense/sdk-data").Attribute>;
|
55
|
+
required: true;
|
56
|
+
};
|
54
57
|
/**
|
55
58
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.dataSource}
|
56
59
|
*/
|
@@ -58,11 +61,17 @@ export declare const MemberFilterTile: import("vue").DefineComponent<{
|
|
58
61
|
/**
|
59
62
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.filter}
|
60
63
|
*/
|
61
|
-
filter:
|
64
|
+
filter: {
|
65
|
+
type: PropType<import("@sisense/sdk-data").Filter | null>;
|
66
|
+
required: true;
|
67
|
+
};
|
62
68
|
/**
|
63
69
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.onChange}
|
64
70
|
*/
|
65
|
-
onChange:
|
71
|
+
onChange: {
|
72
|
+
type: PropType<(filter: import("@sisense/sdk-data").Filter | null) => void>;
|
73
|
+
required: true;
|
74
|
+
};
|
66
75
|
/**
|
67
76
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.parentFilters}
|
68
77
|
*/
|
@@ -70,7 +79,10 @@ export declare const MemberFilterTile: import("vue").DefineComponent<{
|
|
70
79
|
/**
|
71
80
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.title}
|
72
81
|
*/
|
73
|
-
title:
|
82
|
+
title: {
|
83
|
+
type: PropType<string>;
|
84
|
+
required: true;
|
85
|
+
};
|
74
86
|
/**
|
75
87
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.onDelete}
|
76
88
|
*/
|
@@ -85,7 +97,10 @@ export declare const MemberFilterTile: import("vue").DefineComponent<{
|
|
85
97
|
/**
|
86
98
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.attribute}
|
87
99
|
*/
|
88
|
-
attribute:
|
100
|
+
attribute: {
|
101
|
+
type: PropType<import("@sisense/sdk-data").Attribute>;
|
102
|
+
required: true;
|
103
|
+
};
|
89
104
|
/**
|
90
105
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.dataSource}
|
91
106
|
*/
|
@@ -93,11 +108,17 @@ export declare const MemberFilterTile: import("vue").DefineComponent<{
|
|
93
108
|
/**
|
94
109
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.filter}
|
95
110
|
*/
|
96
|
-
filter:
|
111
|
+
filter: {
|
112
|
+
type: PropType<import("@sisense/sdk-data").Filter | null>;
|
113
|
+
required: true;
|
114
|
+
};
|
97
115
|
/**
|
98
116
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.onChange}
|
99
117
|
*/
|
100
|
-
onChange:
|
118
|
+
onChange: {
|
119
|
+
type: PropType<(filter: import("@sisense/sdk-data").Filter | null) => void>;
|
120
|
+
required: true;
|
121
|
+
};
|
101
122
|
/**
|
102
123
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.parentFilters}
|
103
124
|
*/
|
@@ -105,7 +126,10 @@ export declare const MemberFilterTile: import("vue").DefineComponent<{
|
|
105
126
|
/**
|
106
127
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.title}
|
107
128
|
*/
|
108
|
-
title:
|
129
|
+
title: {
|
130
|
+
type: PropType<string>;
|
131
|
+
required: true;
|
132
|
+
};
|
109
133
|
/**
|
110
134
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.onDelete}
|
111
135
|
*/
|
@@ -47,11 +47,17 @@ export declare const RelativeDateFilterTile: import("vue").DefineComponent<{
|
|
47
47
|
/**
|
48
48
|
* {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.title}
|
49
49
|
*/
|
50
|
-
title:
|
50
|
+
title: {
|
51
|
+
type: PropType<string>;
|
52
|
+
required: true;
|
53
|
+
};
|
51
54
|
/**
|
52
55
|
* {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.filter}
|
53
56
|
*/
|
54
|
-
filter:
|
57
|
+
filter: {
|
58
|
+
type: PropType<import("@sisense/sdk-data").Filter>;
|
59
|
+
required: true;
|
60
|
+
};
|
55
61
|
/**
|
56
62
|
* {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.arrangement}
|
57
63
|
*/
|
@@ -59,7 +65,10 @@ export declare const RelativeDateFilterTile: import("vue").DefineComponent<{
|
|
59
65
|
/**
|
60
66
|
* {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.onUpdate}
|
61
67
|
*/
|
62
|
-
onUpdate:
|
68
|
+
onUpdate: {
|
69
|
+
type: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
|
70
|
+
required: true;
|
71
|
+
};
|
63
72
|
/**
|
64
73
|
* {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.limit}
|
65
74
|
*/
|
@@ -86,11 +95,17 @@ export declare const RelativeDateFilterTile: import("vue").DefineComponent<{
|
|
86
95
|
/**
|
87
96
|
* {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.title}
|
88
97
|
*/
|
89
|
-
title:
|
98
|
+
title: {
|
99
|
+
type: PropType<string>;
|
100
|
+
required: true;
|
101
|
+
};
|
90
102
|
/**
|
91
103
|
* {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.filter}
|
92
104
|
*/
|
93
|
-
filter:
|
105
|
+
filter: {
|
106
|
+
type: PropType<import("@sisense/sdk-data").Filter>;
|
107
|
+
required: true;
|
108
|
+
};
|
94
109
|
/**
|
95
110
|
* {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.arrangement}
|
96
111
|
*/
|
@@ -98,7 +113,10 @@ export declare const RelativeDateFilterTile: import("vue").DefineComponent<{
|
|
98
113
|
/**
|
99
114
|
* {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.onUpdate}
|
100
115
|
*/
|
101
|
-
onUpdate:
|
116
|
+
onUpdate: {
|
117
|
+
type: PropType<(filter: import("@sisense/sdk-data").Filter) => void>;
|
118
|
+
required: true;
|
119
|
+
};
|
102
120
|
/**
|
103
121
|
* {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.limit}
|
104
122
|
*/
|