@sisense/sdk-ui-vue 1.22.0 → 1.24.0
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/index.cjs +629 -628
- package/dist/index.js +92555 -88757
- package/dist/packages/sdk-ui-vue/src/components/drilldown-widget.d.ts +33 -8
- package/dist/packages/sdk-ui-vue/src/components/widgets/index.d.ts +1 -0
- package/dist/packages/sdk-ui-vue/src/components/widgets/widget-by-id.d.ts +224 -0
- package/dist/packages/sdk-ui-vue/src/composables/index.d.ts +1 -0
- package/dist/packages/sdk-ui-vue/src/composables/use-custom-drilldown.d.ts +9 -8
- package/dist/packages/sdk-ui-vue/src/composables/use-get-hierarchy-models.d.ts +33 -0
- package/dist/packages/sdk-ui-vue/src/providers/sisense-context-provider.d.ts +3 -3
- package/dist/packages/sdk-ui-vue/src/sdk-ui-core-exports.d.ts +1 -1
- package/package.json +2 -2
@@ -25,7 +25,7 @@ export type DrilldownWidgetConfig = {
|
|
25
25
|
* ```vue
|
26
26
|
* <template>
|
27
27
|
<DrilldownWidget
|
28
|
-
:
|
28
|
+
:drilldownPaths="drilldownPaths"
|
29
29
|
:initialDimension="dimProductName"
|
30
30
|
>
|
31
31
|
<template
|
@@ -49,7 +49,7 @@ export type DrilldownWidgetConfig = {
|
|
49
49
|
onDataPointsSelected([dataPoint]);
|
50
50
|
onContextMenu({ left: event.clientX, top: event.clientY });
|
51
51
|
}"
|
52
|
-
|
52
|
+
:on-data-point-context-menu="(dataPoint: any, event: any) => {
|
53
53
|
onDataPointsSelected([dataPoint]);
|
54
54
|
onContextMenu({ left: event.clientX, top: event.clientY });
|
55
55
|
}"
|
@@ -86,7 +86,7 @@ export type DrilldownWidgetConfig = {
|
|
86
86
|
},
|
87
87
|
},
|
88
88
|
});
|
89
|
-
* const
|
89
|
+
* const drilldownPaths = [DM.DimCountries.CountryName, DM.DimProducts.ProductName];
|
90
90
|
* const dimProductName = DM.DimProducts.ProductName;
|
91
91
|
* </script>
|
92
92
|
* ```
|
@@ -110,10 +110,22 @@ export declare const DrilldownWidgetTs: import("vue").DefineComponent<{
|
|
110
110
|
* {@inheritDoc @sisense/sdk-ui!DrilldownWidgetProps.drilldownDimensions}
|
111
111
|
*
|
112
112
|
* @category Widget
|
113
|
+
* @deprecated Use {@link drilldownPaths} instead
|
113
114
|
*
|
114
115
|
*/
|
115
116
|
drilldownDimensions: {
|
116
|
-
type: PropType<import("@sisense/sdk-data").Attribute[]>;
|
117
|
+
type: PropType<import("@sisense/sdk-data").Attribute[] | undefined>;
|
118
|
+
required: false;
|
119
|
+
default: () => never[];
|
120
|
+
};
|
121
|
+
/**
|
122
|
+
* {@inheritDoc @sisense/sdk-ui!DrilldownWidgetProps.drilldownPaths}
|
123
|
+
*
|
124
|
+
* @category Widget
|
125
|
+
*
|
126
|
+
*/
|
127
|
+
drilldownPaths: {
|
128
|
+
type: PropType<(import("@sisense/sdk-data").Attribute | import("@sisense/sdk-ui-preact").Hierarchy)[] | undefined>;
|
117
129
|
required: false;
|
118
130
|
default: () => never[];
|
119
131
|
};
|
@@ -124,7 +136,7 @@ export declare const DrilldownWidgetTs: import("vue").DefineComponent<{
|
|
124
136
|
*/
|
125
137
|
initialDimension: {
|
126
138
|
type: PropType<import("@sisense/sdk-data").Attribute>;
|
127
|
-
required:
|
139
|
+
required: true;
|
128
140
|
default: () => {};
|
129
141
|
};
|
130
142
|
}, void, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
@@ -142,10 +154,22 @@ export declare const DrilldownWidgetTs: import("vue").DefineComponent<{
|
|
142
154
|
* {@inheritDoc @sisense/sdk-ui!DrilldownWidgetProps.drilldownDimensions}
|
143
155
|
*
|
144
156
|
* @category Widget
|
157
|
+
* @deprecated Use {@link drilldownPaths} instead
|
145
158
|
*
|
146
159
|
*/
|
147
160
|
drilldownDimensions: {
|
148
|
-
type: PropType<import("@sisense/sdk-data").Attribute[]>;
|
161
|
+
type: PropType<import("@sisense/sdk-data").Attribute[] | undefined>;
|
162
|
+
required: false;
|
163
|
+
default: () => never[];
|
164
|
+
};
|
165
|
+
/**
|
166
|
+
* {@inheritDoc @sisense/sdk-ui!DrilldownWidgetProps.drilldownPaths}
|
167
|
+
*
|
168
|
+
* @category Widget
|
169
|
+
*
|
170
|
+
*/
|
171
|
+
drilldownPaths: {
|
172
|
+
type: PropType<(import("@sisense/sdk-data").Attribute | import("@sisense/sdk-ui-preact").Hierarchy)[] | undefined>;
|
149
173
|
required: false;
|
150
174
|
default: () => never[];
|
151
175
|
};
|
@@ -156,11 +180,12 @@ export declare const DrilldownWidgetTs: import("vue").DefineComponent<{
|
|
156
180
|
*/
|
157
181
|
initialDimension: {
|
158
182
|
type: PropType<import("@sisense/sdk-data").Attribute>;
|
159
|
-
required:
|
183
|
+
required: true;
|
160
184
|
default: () => {};
|
161
185
|
};
|
162
186
|
}>>, {
|
163
|
-
drilldownDimensions: import("@sisense/sdk-data").Attribute[];
|
187
|
+
drilldownDimensions: import("@sisense/sdk-data").Attribute[] | undefined;
|
188
|
+
drilldownPaths: (import("@sisense/sdk-data").Attribute | import("@sisense/sdk-ui-preact").Hierarchy)[] | undefined;
|
164
189
|
initialDimension: import("@sisense/sdk-data").Attribute;
|
165
190
|
config: DrilldownWidgetConfig;
|
166
191
|
}, {}>;
|
@@ -0,0 +1,224 @@
|
|
1
|
+
/// <reference types="react" />
|
2
|
+
import type { PropType } from 'vue';
|
3
|
+
/**
|
4
|
+
* The `WidgetById` component, which is a thin wrapper on the {@link ChartWidget} component,
|
5
|
+
* used to render a widget created in the Sisense instance.
|
6
|
+
*
|
7
|
+
* **Note:** Widget extensions based on JS scripts and add-ons in Fusion are not supported.
|
8
|
+
*
|
9
|
+
* @example
|
10
|
+
* Here's how you can use the WidgetById component in a Vue application:
|
11
|
+
* ```vue
|
12
|
+
* <template>
|
13
|
+
* <WidgetById
|
14
|
+
* widgetOid="64473e07dac1920034bce77f"
|
15
|
+
* dashboardOid="6441e728dac1920034bce737"
|
16
|
+
* />
|
17
|
+
* </template>
|
18
|
+
*
|
19
|
+
* <script setup lang="ts">
|
20
|
+
* import { ref } from 'vue';
|
21
|
+
* import { WidgetById } from '@sisense/sdk-ui-vue';
|
22
|
+
*
|
23
|
+
* </script>
|
24
|
+
* ```
|
25
|
+
* @group Fusion Assets
|
26
|
+
* @fusionEmbed
|
27
|
+
*/
|
28
|
+
export declare const WidgetById: import("vue").DefineComponent<{
|
29
|
+
/** @internal */
|
30
|
+
bottomSlot: PropType<import("react").ReactNode>;
|
31
|
+
/** @internal */
|
32
|
+
contextMenuItems: PropType<import("@sisense/sdk-ui-preact").MenuItemSection[] | undefined>;
|
33
|
+
/**
|
34
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.dashboardOid}
|
35
|
+
*
|
36
|
+
* @category Widget
|
37
|
+
*/
|
38
|
+
dashboardOid: PropType<string>;
|
39
|
+
/**
|
40
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.description}
|
41
|
+
*
|
42
|
+
* @category Widget
|
43
|
+
*/
|
44
|
+
description: PropType<string | undefined>;
|
45
|
+
/** @internal */
|
46
|
+
drilldownOptions: PropType<import("@sisense/sdk-ui-preact").DrilldownOptions | undefined>;
|
47
|
+
/**
|
48
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.filters}
|
49
|
+
*
|
50
|
+
* @category Data
|
51
|
+
*/
|
52
|
+
filters: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
|
53
|
+
/**
|
54
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.filtersMergeStrategy}
|
55
|
+
*
|
56
|
+
* @category Data
|
57
|
+
*/
|
58
|
+
filtersMergeStrategy: PropType<"widgetFirst" | "codeFirst" | "codeOnly" | undefined>;
|
59
|
+
/**
|
60
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.highlightSelectionDisabled}
|
61
|
+
*
|
62
|
+
* @category Widget
|
63
|
+
*/
|
64
|
+
highlightSelectionDisabled: PropType<boolean | undefined>;
|
65
|
+
/**
|
66
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.highlights}
|
67
|
+
*
|
68
|
+
* @category Data
|
69
|
+
*/
|
70
|
+
highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
|
71
|
+
/**
|
72
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.includeDashboardFilters}
|
73
|
+
*
|
74
|
+
* @category Data
|
75
|
+
*/
|
76
|
+
includeDashboardFilters: PropType<boolean | undefined>;
|
77
|
+
/**
|
78
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onBeforeRender}
|
79
|
+
*
|
80
|
+
* @category Callbacks
|
81
|
+
*/
|
82
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
|
83
|
+
/** @internal */
|
84
|
+
onContextMenuClose: PropType<(() => void) | undefined>;
|
85
|
+
/**
|
86
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointClick}
|
87
|
+
*
|
88
|
+
* @category Callbacks
|
89
|
+
*/
|
90
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
|
91
|
+
/**
|
92
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointContextMenu}
|
93
|
+
*
|
94
|
+
* @category Callbacks
|
95
|
+
*/
|
96
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
|
97
|
+
/**
|
98
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointsSelected}
|
99
|
+
*
|
100
|
+
* @category Callbacks
|
101
|
+
*/
|
102
|
+
onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
|
103
|
+
/**
|
104
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.styleOptions}
|
105
|
+
*
|
106
|
+
* @category Widget
|
107
|
+
*/
|
108
|
+
styleOptions: PropType<import("@sisense/sdk-ui-preact").WidgetByIdStyleOptions | undefined>;
|
109
|
+
/**
|
110
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.title}
|
111
|
+
*
|
112
|
+
* @category Widget
|
113
|
+
*/
|
114
|
+
title: PropType<string | undefined>;
|
115
|
+
/** @internal */
|
116
|
+
topSlot: PropType<import("react").ReactNode>;
|
117
|
+
/**
|
118
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.widgetOid}
|
119
|
+
*
|
120
|
+
* @category Widget
|
121
|
+
*/
|
122
|
+
widgetOid: PropType<string>;
|
123
|
+
/** @internal */
|
124
|
+
widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").WidgetByIdStyleOptions | undefined>;
|
125
|
+
}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
126
|
+
[key: string]: any;
|
127
|
+
}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
128
|
+
/** @internal */
|
129
|
+
bottomSlot: PropType<import("react").ReactNode>;
|
130
|
+
/** @internal */
|
131
|
+
contextMenuItems: PropType<import("@sisense/sdk-ui-preact").MenuItemSection[] | undefined>;
|
132
|
+
/**
|
133
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.dashboardOid}
|
134
|
+
*
|
135
|
+
* @category Widget
|
136
|
+
*/
|
137
|
+
dashboardOid: PropType<string>;
|
138
|
+
/**
|
139
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.description}
|
140
|
+
*
|
141
|
+
* @category Widget
|
142
|
+
*/
|
143
|
+
description: PropType<string | undefined>;
|
144
|
+
/** @internal */
|
145
|
+
drilldownOptions: PropType<import("@sisense/sdk-ui-preact").DrilldownOptions | undefined>;
|
146
|
+
/**
|
147
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.filters}
|
148
|
+
*
|
149
|
+
* @category Data
|
150
|
+
*/
|
151
|
+
filters: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
|
152
|
+
/**
|
153
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.filtersMergeStrategy}
|
154
|
+
*
|
155
|
+
* @category Data
|
156
|
+
*/
|
157
|
+
filtersMergeStrategy: PropType<"widgetFirst" | "codeFirst" | "codeOnly" | undefined>;
|
158
|
+
/**
|
159
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.highlightSelectionDisabled}
|
160
|
+
*
|
161
|
+
* @category Widget
|
162
|
+
*/
|
163
|
+
highlightSelectionDisabled: PropType<boolean | undefined>;
|
164
|
+
/**
|
165
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.highlights}
|
166
|
+
*
|
167
|
+
* @category Data
|
168
|
+
*/
|
169
|
+
highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
|
170
|
+
/**
|
171
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.includeDashboardFilters}
|
172
|
+
*
|
173
|
+
* @category Data
|
174
|
+
*/
|
175
|
+
includeDashboardFilters: PropType<boolean | undefined>;
|
176
|
+
/**
|
177
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onBeforeRender}
|
178
|
+
*
|
179
|
+
* @category Callbacks
|
180
|
+
*/
|
181
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
|
182
|
+
/** @internal */
|
183
|
+
onContextMenuClose: PropType<(() => void) | undefined>;
|
184
|
+
/**
|
185
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointClick}
|
186
|
+
*
|
187
|
+
* @category Callbacks
|
188
|
+
*/
|
189
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
|
190
|
+
/**
|
191
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointContextMenu}
|
192
|
+
*
|
193
|
+
* @category Callbacks
|
194
|
+
*/
|
195
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
|
196
|
+
/**
|
197
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointsSelected}
|
198
|
+
*
|
199
|
+
* @category Callbacks
|
200
|
+
*/
|
201
|
+
onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
|
202
|
+
/**
|
203
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.styleOptions}
|
204
|
+
*
|
205
|
+
* @category Widget
|
206
|
+
*/
|
207
|
+
styleOptions: PropType<import("@sisense/sdk-ui-preact").WidgetByIdStyleOptions | undefined>;
|
208
|
+
/**
|
209
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.title}
|
210
|
+
*
|
211
|
+
* @category Widget
|
212
|
+
*/
|
213
|
+
title: PropType<string | undefined>;
|
214
|
+
/** @internal */
|
215
|
+
topSlot: PropType<import("react").ReactNode>;
|
216
|
+
/**
|
217
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.widgetOid}
|
218
|
+
*
|
219
|
+
* @category Widget
|
220
|
+
*/
|
221
|
+
widgetOid: PropType<string>;
|
222
|
+
/** @internal */
|
223
|
+
widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").WidgetByIdStyleOptions | undefined>;
|
224
|
+
}>>, {}, {}>;
|
@@ -4,6 +4,7 @@ export { useGetDashboardModel } from './use-get-dashboard-model.js';
|
|
4
4
|
export { useGetDashboardModels } from './use-get-dashboard-models.js';
|
5
5
|
export { useGetSharedFormula } from './use-get-shared-formula.js';
|
6
6
|
export { useGetWidgetModel } from './use-get-widget-model.js';
|
7
|
+
export { useGetHierarchyModels } from './use-get-hierarchy-models.js';
|
7
8
|
export { useFetch } from './use-fetch.js';
|
8
9
|
export { usePlugins } from './use-plugins.js';
|
9
10
|
export type { UseFetchOptions } from './use-fetch.js';
|
@@ -1,16 +1,13 @@
|
|
1
|
-
import type
|
2
|
-
import { type DataPoint, type StyledColumn } from '@sisense/sdk-ui-preact';
|
1
|
+
import { type Attribute, type Column } from '@sisense/sdk-data';
|
2
|
+
import { type DataPoint, type Hierarchy, type StyledColumn } from '@sisense/sdk-ui-preact';
|
3
3
|
import { type Ref } from 'vue';
|
4
4
|
/**
|
5
5
|
* @internal
|
6
6
|
*/
|
7
|
-
export declare const useCustomDrilldown: ({
|
8
|
-
|
7
|
+
export declare const useCustomDrilldown: ({ drilldownPaths, initialDimension, }: {
|
8
|
+
drilldownPaths: Ref<(Attribute | Hierarchy)[]>;
|
9
9
|
initialDimension: Column | StyledColumn;
|
10
10
|
}) => {
|
11
|
-
selectDrilldown: (points: DataPoint[], nextDimension: Attribute) => void;
|
12
|
-
sliceDrilldownSelections: (i: number) => void;
|
13
|
-
clearDrilldownSelections: () => void;
|
14
11
|
drilldownSelections: Ref<{
|
15
12
|
points: ({
|
16
13
|
value?: string | number | undefined;
|
@@ -5725,11 +5722,12 @@ export declare const useCustomDrilldown: ({ drilldownDimensions, initialDimensio
|
|
5725
5722
|
composeCode?: string | undefined;
|
5726
5723
|
};
|
5727
5724
|
}[]>;
|
5728
|
-
|
5725
|
+
availableDrilldownPaths: import("vue").ComputedRef<(Attribute | Hierarchy)[]>;
|
5729
5726
|
drilldownDimension: Ref<Attribute | undefined>;
|
5730
5727
|
drilldownFilters: Ref<{
|
5731
5728
|
readonly members: any[];
|
5732
5729
|
excludeMembers: boolean;
|
5730
|
+
multiSelection: boolean;
|
5733
5731
|
deactivatedMembers: any[];
|
5734
5732
|
backgroundFilter?: {
|
5735
5733
|
readonly guid: string;
|
@@ -5832,4 +5830,7 @@ export declare const useCustomDrilldown: ({ drilldownDimensions, initialDimensio
|
|
5832
5830
|
toString: () => string;
|
5833
5831
|
}[]>;
|
5834
5832
|
drilldownFiltersDisplayValues: Ref<string[][]>;
|
5833
|
+
selectDrilldown: (points: DataPoint[], nextDimension: Attribute, hierarchy?: Hierarchy) => void;
|
5834
|
+
sliceDrilldownSelections: (i: number) => void;
|
5835
|
+
clearDrilldownSelections: () => void;
|
5835
5836
|
};
|
@@ -0,0 +1,33 @@
|
|
1
|
+
import type { GetHierarchyModelsParams, HierarchyModel } from '@sisense/sdk-ui-preact';
|
2
|
+
import type { MaybeRefOrWithRefs } from '../types';
|
3
|
+
/**
|
4
|
+
* A Vue composable function `useGetHierarchyModels` for retrieving hierarchy models from Sisense instance.
|
5
|
+
*
|
6
|
+
* @param {GetHierarchyModelsParams} params - The parameters for fetching the hierarchy models.
|
7
|
+
*
|
8
|
+
* @example
|
9
|
+
* Retrieve hierarchy models:
|
10
|
+
*
|
11
|
+
* ```vue
|
12
|
+
* <script setup lang="ts">
|
13
|
+
* import { useGetHierarchyModels } from '@sisense/sdk-ui-vue';
|
14
|
+
* const { data: hierarchyModels } = useGetHierarchyModels({
|
15
|
+
* dataSource: DM.DataSource,
|
16
|
+
* dimension: DM.DimCountries.Region,
|
17
|
+
* });
|
18
|
+
* </script>
|
19
|
+
* ```
|
20
|
+
*
|
21
|
+
* The composable returns an object with reactive properties that represent the state of the hierarchy models fetch operation:
|
22
|
+
* - `data`: Fetched hierarchy models, which is `undefined` until the operation is successfully completed.
|
23
|
+
* - `isLoading`: A boolean indicating whether the fetch operation is currently in progress.
|
24
|
+
* - `isError`: A boolean indicating whether an error occurred during the fetch operation.
|
25
|
+
* - `isSuccess`: A boolean indicating whether the fetch operation was successfully completed without any errors.
|
26
|
+
* - `error`: An error object containing details about any errors that occurred during the fetch operation.
|
27
|
+
*
|
28
|
+
* This composable streamlines the process of fetching and managing Sisense hierarchy models within Vue applications, providing
|
29
|
+
* developers with a reactive and efficient way to integrate Sisense data visualizations and analytics.
|
30
|
+
* @group Fusion Assets
|
31
|
+
* @fusionEmbed
|
32
|
+
*/
|
33
|
+
export declare const useGetHierarchyModels: (params: MaybeRefOrWithRefs<GetHierarchyModelsParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").DataState<HierarchyModel[]>>;
|
@@ -4,14 +4,14 @@ import { type CustomSisenseContext } from '@sisense/sdk-ui-preact';
|
|
4
4
|
* Gets Sisense application
|
5
5
|
* @internal
|
6
6
|
*/
|
7
|
-
export declare const getSisenseContext: () => Ref<
|
7
|
+
export declare const getSisenseContext: () => Ref<import("@sisense/sdk-ui/dist/packages/sdk-ui/src/sisense-context/sisense-context").SisenseContextPayload>;
|
8
8
|
/**
|
9
9
|
* Creates Sisense context connector
|
10
10
|
* @internal
|
11
11
|
*/
|
12
12
|
export declare const createSisenseContextConnector: (context: CustomSisenseContext) => {
|
13
|
-
prepareContext(): Promise<
|
14
|
-
renderContextProvider: (contextData:
|
13
|
+
prepareContext(): Promise<import("@sisense/sdk-ui/dist/packages/sdk-ui/src/sisense-context/sisense-context").SisenseContextPayload>;
|
14
|
+
renderContextProvider: (contextData: import("@sisense/sdk-ui/dist/packages/sdk-ui/src/sisense-context/sisense-context").SisenseContextPayload | undefined, children: import("preact").VNode<{}>, error?: Error | undefined) => import("preact").VNode<{}>;
|
15
15
|
};
|
16
16
|
/**
|
17
17
|
* Sisense Context Provider Component allowing you to connect to
|
@@ -1,5 +1,5 @@
|
|
1
1
|
export { boxWhiskerProcessResult, widgetModelTranslator, dashboardModelTranslator, dashboardHelpers, } from '@sisense/sdk-ui-preact';
|
2
|
-
export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, AreaChartProps, BarChartProps, ChartProps, LineChartProps, ColumnChartProps, FunnelChartProps, PolarChartProps, ScatterChartProps, PieChartProps, TreemapChartProps, SunburstChartProps, IndicatorChartProps, AreaRangeChartProps, MemberFilterTileProps, BasicMemberFilterTileProps, CriteriaFilterTileProps, DateRangeFilterTileProps, RelativeDateFilterTileProps, ChartWidgetProps, TableWidgetProps, TableProps, PivotTableProps, DrilldownBreadcrumbsProps, BoxplotChartProps, AreamapChartProps, ScattermapChartProps, SisenseContextProviderProps, DashboardWidgetProps, DashboardProps, WidgetProps, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, DashboardWidgetStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, DashboardLayoutOptions, DashboardConfig, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, CriteriaFilterType, Member, FilterVariant, } from '@sisense/sdk-ui-preact';
|
2
|
+
export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, AreaChartProps, BarChartProps, ChartProps, LineChartProps, ColumnChartProps, FunnelChartProps, PolarChartProps, ScatterChartProps, PieChartProps, TreemapChartProps, SunburstChartProps, IndicatorChartProps, AreaRangeChartProps, MemberFilterTileProps, BasicMemberFilterTileProps, CriteriaFilterTileProps, DateRangeFilterTileProps, RelativeDateFilterTileProps, ChartWidgetProps, TableWidgetProps, TableProps, PivotTableProps, DrilldownBreadcrumbsProps, BoxplotChartProps, AreamapChartProps, ScattermapChartProps, SisenseContextProviderProps, DashboardWidgetProps, WidgetByIdProps, DashboardProps, WidgetProps, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, GetHierarchyModelsParams, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, DashboardWidgetStyleOptions, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, DashboardLayoutOptions, DashboardConfig, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, CriteriaFilterType, Member, FilterVariant, } from '@sisense/sdk-ui-preact';
|
3
3
|
import type { ContextMenuProps as ContextMenuPropsPreact, ThemeProviderProps as ThemeProviderPropsPreact, DashboardByIdProps as DashboardByIdPropsPreact } from '@sisense/sdk-ui-preact';
|
4
4
|
export type ContextMenuProps = Omit<ContextMenuPropsPreact, 'children'>;
|
5
5
|
export type ThemeProviderProps = Omit<ThemeProviderPropsPreact, 'children'>;
|
package/package.json
CHANGED
@@ -11,7 +11,7 @@
|
|
11
11
|
"Sisense",
|
12
12
|
"Compose SDK"
|
13
13
|
],
|
14
|
-
"version": "1.
|
14
|
+
"version": "1.24.0",
|
15
15
|
"type": "module",
|
16
16
|
"main": "./dist/index.cjs",
|
17
17
|
"module": "./dist/index.js",
|
@@ -42,7 +42,7 @@
|
|
42
42
|
"format:check": "prettier --check ."
|
43
43
|
},
|
44
44
|
"dependencies": {
|
45
|
-
"@sisense/sdk-ui-preact": "^1.
|
45
|
+
"@sisense/sdk-ui-preact": "^1.24.0",
|
46
46
|
"deepmerge": "^4.3.1",
|
47
47
|
"lodash-es": "^4.17.21",
|
48
48
|
"vue": "^3.3.2"
|