@sisense/sdk-ui-vue 2.3.0 → 2.4.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 +23 -22
- package/dist/ai.js +642 -543
- package/dist/index.cjs +1 -1
- package/dist/index.js +935 -805
- package/dist/packages/sdk-ui-vue/src/components/charts/chart.d.ts +2 -2
- package/dist/packages/sdk-ui-vue/src/components/dashboard/dashboard-by-id.d.ts +2 -6
- package/dist/packages/sdk-ui-vue/src/components/dashboard/dashboard.d.ts +2 -6
- package/dist/packages/sdk-ui-vue/src/components/dashboard/index.d.ts +2 -2
- package/dist/packages/sdk-ui-vue/src/components/filters/filters-panel.d.ts +106 -0
- package/dist/packages/sdk-ui-vue/src/components/filters/index.d.ts +1 -0
- package/dist/packages/sdk-ui-vue/src/components/widgets/chart-widget.d.ts +2 -2
- package/dist/packages/sdk-ui-vue/src/components/widgets/index.d.ts +1 -1
- package/dist/packages/sdk-ui-vue/src/components/widgets/widget-by-id.d.ts +2 -2
- package/dist/packages/sdk-ui-vue/src/components/widgets/widget.d.ts +13 -13
- package/dist/packages/sdk-ui-vue/src/composables/index.d.ts +4 -1
- package/dist/packages/sdk-ui-vue/src/composables/use-custom-widgets.d.ts +46 -0
- package/dist/packages/sdk-ui-vue/src/composables/use-execute-custom-widget-query.d.ts +45 -0
- package/dist/packages/sdk-ui-vue/src/composables/use-get-filter-members.d.ts +46 -0
- package/dist/packages/sdk-ui-vue/src/helpers/context-connectors/custom-widgets-context-connector.d.ts +8 -0
- package/dist/packages/sdk-ui-vue/src/helpers/context-connectors/index.d.ts +1 -1
- package/dist/packages/sdk-ui-vue/src/helpers/dynamic-renderer.d.ts +16 -0
- package/dist/packages/sdk-ui-vue/src/helpers/setup-helper.d.ts +1 -1
- package/dist/packages/sdk-ui-vue/src/lib.d.ts +1 -1
- package/dist/packages/sdk-ui-vue/src/providers/custom-widgets-provider/custom-widgets-context.d.ts +12 -0
- package/dist/packages/sdk-ui-vue/src/providers/{plugins-provider/plugins-provider.d.ts → custom-widgets-provider/custom-widgets-provider.d.ts} +3 -3
- package/dist/packages/sdk-ui-vue/src/providers/custom-widgets-provider/index.d.ts +2 -0
- package/dist/packages/sdk-ui-vue/src/providers/index.d.ts +1 -1
- package/dist/packages/sdk-ui-vue/src/sdk-ui-core-exports.d.ts +1 -1
- package/dist/packages/sdk-ui-vue/src/types/index.d.ts +0 -1
- package/dist/use-tracking-522444fb.cjs +1073 -0
- package/dist/{use-tracking-594f296b.js → use-tracking-d5f179d9.js} +38192 -38020
- package/package.json +2 -2
- package/dist/packages/sdk-ui-vue/src/composables/use-plugins.d.ts +0 -4
- package/dist/packages/sdk-ui-vue/src/helpers/context-connectors/plugins-context-connector.d.ts +0 -8
- package/dist/packages/sdk-ui-vue/src/providers/plugins-provider/index.d.ts +0 -2
- package/dist/packages/sdk-ui-vue/src/providers/plugins-provider/plugins-context.d.ts +0 -10
- package/dist/packages/sdk-ui-vue/src/types/dashboard-config.d.ts +0 -24
- package/dist/use-tracking-58ebfa35.cjs +0 -1073
@@ -115,7 +115,7 @@ export declare const Chart: import("vue").DefineComponent<{
|
|
115
115
|
*
|
116
116
|
* @category Callbacks
|
117
117
|
*/
|
118
|
-
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
|
118
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | import("@sisense/sdk-ui-preact").IndicatorDataPointEventHandler | undefined>;
|
119
119
|
/**
|
120
120
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenu}
|
121
121
|
*
|
@@ -194,7 +194,7 @@ export declare const Chart: import("vue").DefineComponent<{
|
|
194
194
|
*
|
195
195
|
* @category Callbacks
|
196
196
|
*/
|
197
|
-
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
|
197
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | import("@sisense/sdk-ui-preact").IndicatorDataPointEventHandler | undefined>;
|
198
198
|
/**
|
199
199
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenu}
|
200
200
|
*
|
@@ -1,14 +1,10 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
-
import type { DashboardByIdProps as DashboardByIdPropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
-
|
2
|
+
import type { DashboardByIdProps as DashboardByIdPropsPreact, DashboardByIdConfig } from '@sisense/sdk-ui-preact';
|
3
|
+
export { DashboardByIdConfig };
|
4
4
|
/**
|
5
5
|
* Props of the {@link @sisense/sdk-ui-vue!DashboardById | `DashboardById`} component.
|
6
6
|
*/
|
7
7
|
export interface DashboardByIdProps extends DashboardByIdPropsPreact {
|
8
|
-
/**
|
9
|
-
* {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.config}
|
10
|
-
*/
|
11
|
-
config?: DashboardByIdConfig;
|
12
8
|
}
|
13
9
|
/**
|
14
10
|
* A component used for easily rendering a dashboard by its ID in a Sisense Fusion instance.
|
@@ -1,7 +1,7 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
-
import type { DashboardProps as DashboardPropsPreact } from '@sisense/sdk-ui-preact';
|
3
|
-
import type { DashboardConfig } from '../../types';
|
2
|
+
import type { DashboardProps as DashboardPropsPreact, DashboardConfig, DashboardFiltersPanelConfig } from '@sisense/sdk-ui-preact';
|
4
3
|
import type { WidgetProps } from '../widgets';
|
4
|
+
export { DashboardConfig, DashboardFiltersPanelConfig };
|
5
5
|
/**
|
6
6
|
* Props of the {@link @sisense/sdk-ui-vue!Dashboard | `Dashboard`} component.
|
7
7
|
*/
|
@@ -10,10 +10,6 @@ export interface DashboardProps extends Omit<DashboardPropsPreact, 'widgets'> {
|
|
10
10
|
* {@inheritDoc @sisense/sdk-ui!DashboardProps.widgets}
|
11
11
|
*/
|
12
12
|
widgets: WidgetProps[];
|
13
|
-
/**
|
14
|
-
* {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.config}
|
15
|
-
*/
|
16
|
-
config?: DashboardConfig;
|
17
13
|
}
|
18
14
|
/**
|
19
15
|
* A component used for easily rendering a dashboard.
|
@@ -1,2 +1,2 @@
|
|
1
|
-
export
|
2
|
-
export
|
1
|
+
export * from './dashboard-by-id';
|
2
|
+
export * from './dashboard';
|
@@ -0,0 +1,106 @@
|
|
1
|
+
import type { PropType } from 'vue';
|
2
|
+
import type { FiltersPanelProps as FiltersPanelPropsPreact, FiltersPanelConfig } from '@sisense/sdk-ui-preact';
|
3
|
+
/** Reexport related types */
|
4
|
+
export type { FiltersPanelConfig };
|
5
|
+
/**
|
6
|
+
* Props of the {@link @sisense/sdk-ui-vue!FiltersPanel | `FiltersPanel`} component.
|
7
|
+
*/
|
8
|
+
export interface FiltersPanelProps extends FiltersPanelPropsPreact {
|
9
|
+
}
|
10
|
+
/**
|
11
|
+
* Filters panel component that renders a list of filter tiles
|
12
|
+
*
|
13
|
+
* @example
|
14
|
+
* Here's how to render a filters panel with a set of filters.
|
15
|
+
* ```vue
|
16
|
+
<script setup lang="ts">
|
17
|
+
import { ref } from 'vue';
|
18
|
+
import { FiltersPanel } from '@sisense/sdk-ui-vue';
|
19
|
+
import { filterFactory, type Filter, type FilterRelations } from '@sisense/sdk-data';
|
20
|
+
import * as DM from '../assets/sample-ecommerce-model.js';
|
21
|
+
|
22
|
+
const filters = ref<Filter[]>([
|
23
|
+
filterFactory.members(DM.Commerce.Gender, ['Male', 'Female']),
|
24
|
+
filterFactory.members(DM.Commerce.AgeRange, ['0-18', '19-24']),
|
25
|
+
]);
|
26
|
+
|
27
|
+
const handleFiltersChange = (updatedFilters: Filter[] | FilterRelations) => {
|
28
|
+
filters.value = updatedFilters as Filter[];
|
29
|
+
console.log('Filters changed:', updatedFilters);
|
30
|
+
};
|
31
|
+
</script>
|
32
|
+
|
33
|
+
<template>
|
34
|
+
<FiltersPanel
|
35
|
+
:filters="filters"
|
36
|
+
:defaultDataSource="DM.DataSource"
|
37
|
+
:onFiltersChange="handleFiltersChange"
|
38
|
+
/>
|
39
|
+
</template>
|
40
|
+
* ```
|
41
|
+
* @param props - FiltersPanel props
|
42
|
+
* @returns FiltersPanel component
|
43
|
+
*
|
44
|
+
* @group Filter Tiles
|
45
|
+
*/
|
46
|
+
export declare const FiltersPanel: import("vue").DefineComponent<{
|
47
|
+
/**
|
48
|
+
* {@inheritDoc @sisense/sdk-ui!FiltersPanelProps.filters}
|
49
|
+
*/
|
50
|
+
filters: {
|
51
|
+
type: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[]>;
|
52
|
+
required: true;
|
53
|
+
};
|
54
|
+
/**
|
55
|
+
* {@inheritDoc @sisense/sdk-ui!FiltersPanelProps.defaultDataSource}
|
56
|
+
*/
|
57
|
+
defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
|
58
|
+
/**
|
59
|
+
* {@inheritDoc @sisense/sdk-ui!FiltersPanelProps.dataSources}
|
60
|
+
*
|
61
|
+
* @internal
|
62
|
+
*/
|
63
|
+
dataSources: PropType<import("@sisense/sdk-data").DataSource[] | undefined>;
|
64
|
+
/**
|
65
|
+
* {@inheritDoc @sisense/sdk-ui!FiltersPanelProps.config}
|
66
|
+
*/
|
67
|
+
config: PropType<FiltersPanelConfig | undefined>;
|
68
|
+
/**
|
69
|
+
* {@inheritDoc @sisense/sdk-ui!FiltersPanelProps.onFiltersChange}
|
70
|
+
*/
|
71
|
+
onFiltersChange: {
|
72
|
+
type: PropType<(filters: import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[]) => void>;
|
73
|
+
required: true;
|
74
|
+
};
|
75
|
+
}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
76
|
+
[key: string]: any;
|
77
|
+
}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
78
|
+
/**
|
79
|
+
* {@inheritDoc @sisense/sdk-ui!FiltersPanelProps.filters}
|
80
|
+
*/
|
81
|
+
filters: {
|
82
|
+
type: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[]>;
|
83
|
+
required: true;
|
84
|
+
};
|
85
|
+
/**
|
86
|
+
* {@inheritDoc @sisense/sdk-ui!FiltersPanelProps.defaultDataSource}
|
87
|
+
*/
|
88
|
+
defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
|
89
|
+
/**
|
90
|
+
* {@inheritDoc @sisense/sdk-ui!FiltersPanelProps.dataSources}
|
91
|
+
*
|
92
|
+
* @internal
|
93
|
+
*/
|
94
|
+
dataSources: PropType<import("@sisense/sdk-data").DataSource[] | undefined>;
|
95
|
+
/**
|
96
|
+
* {@inheritDoc @sisense/sdk-ui!FiltersPanelProps.config}
|
97
|
+
*/
|
98
|
+
config: PropType<FiltersPanelConfig | undefined>;
|
99
|
+
/**
|
100
|
+
* {@inheritDoc @sisense/sdk-ui!FiltersPanelProps.onFiltersChange}
|
101
|
+
*/
|
102
|
+
onFiltersChange: {
|
103
|
+
type: PropType<(filters: import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[]) => void>;
|
104
|
+
required: true;
|
105
|
+
};
|
106
|
+
}>>, {}, {}>;
|
@@ -3,3 +3,4 @@ export { MemberFilterTile, type MemberFilterTileProps } from './member-filter-ti
|
|
3
3
|
export { CriteriaFilterTile, type CriteriaFilterTileProps } from './criteria-filter-tile';
|
4
4
|
export { RelativeDateFilterTile, type RelativeDateFilterTileProps, } from './relative-date-filter-tile';
|
5
5
|
export { FilterTile, type FilterTileProps } from './filter-tile';
|
6
|
+
export { FiltersPanel, type FiltersPanelProps } from './filters-panel';
|
@@ -146,7 +146,7 @@ export declare const ChartWidget: import("vue").DefineComponent<{
|
|
146
146
|
*
|
147
147
|
* @category Callbacks
|
148
148
|
*/
|
149
|
-
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
|
149
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | import("@sisense/sdk-ui-preact").IndicatorDataPointEventHandler | undefined>;
|
150
150
|
/**
|
151
151
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenu}
|
152
152
|
*
|
@@ -280,7 +280,7 @@ export declare const ChartWidget: import("vue").DefineComponent<{
|
|
280
280
|
*
|
281
281
|
* @category Callbacks
|
282
282
|
*/
|
283
|
-
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
|
283
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | import("@sisense/sdk-ui-preact").IndicatorDataPointEventHandler | undefined>;
|
284
284
|
/**
|
285
285
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenu}
|
286
286
|
*
|
@@ -1,4 +1,4 @@
|
|
1
1
|
export { ChartWidget, type ChartWidgetProps } from './chart-widget';
|
2
2
|
export { WidgetById, type WidgetByIdProps } from './widget-by-id';
|
3
3
|
export { TableWidget, type TableWidgetProps } from './table-widget';
|
4
|
-
export { Widget, type WidgetProps, type WithCommonWidgetProps, type TextWidgetProps, type
|
4
|
+
export { Widget, type WidgetProps, type WithCommonWidgetProps, type TextWidgetProps, type CustomWidgetProps, type PivotTableWidgetProps, } from './widget';
|
@@ -96,7 +96,7 @@ export declare const WidgetById: import("vue").DefineComponent<{
|
|
96
96
|
*
|
97
97
|
* @category Callbacks
|
98
98
|
*/
|
99
|
-
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
|
99
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | import("@sisense/sdk-ui-preact").IndicatorDataPointEventHandler | undefined>;
|
100
100
|
/**
|
101
101
|
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointContextMenu}
|
102
102
|
*
|
@@ -207,7 +207,7 @@ export declare const WidgetById: import("vue").DefineComponent<{
|
|
207
207
|
*
|
208
208
|
* @category Callbacks
|
209
209
|
*/
|
210
|
-
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
|
210
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | import("@sisense/sdk-ui-preact").IndicatorDataPointEventHandler | undefined>;
|
211
211
|
/**
|
212
212
|
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointContextMenu}
|
213
213
|
*
|
@@ -1,12 +1,12 @@
|
|
1
1
|
import type { PropType } from 'vue';
|
2
|
-
import type { ChartWidgetProps, PivotTableWidgetProps as PivotTableWidgetPropsPreact,
|
3
|
-
export { WithCommonWidgetProps, TextWidgetProps,
|
2
|
+
import type { ChartWidgetProps, PivotTableWidgetProps as PivotTableWidgetPropsPreact, CustomWidgetProps, SoftUnion, TextWidgetProps, WithCommonWidgetProps } from '@sisense/sdk-ui-preact';
|
3
|
+
export { WithCommonWidgetProps, TextWidgetProps, CustomWidgetProps };
|
4
4
|
export interface PivotTableWidgetProps extends PivotTableWidgetPropsPreact {
|
5
5
|
}
|
6
6
|
/**
|
7
7
|
* Props of the {@link @sisense/sdk-ui-vue!Widget | `Widget`} component.
|
8
8
|
*/
|
9
|
-
export type WidgetProps = SoftUnion<WithCommonWidgetProps<ChartWidgetProps, 'chart'> | WithCommonWidgetProps<PivotTableWidgetProps, 'pivot'> | WithCommonWidgetProps<TextWidgetProps, 'text'> | WithCommonWidgetProps<
|
9
|
+
export type WidgetProps = SoftUnion<WithCommonWidgetProps<ChartWidgetProps, 'chart'> | WithCommonWidgetProps<PivotTableWidgetProps, 'pivot'> | WithCommonWidgetProps<TextWidgetProps, 'text'> | WithCommonWidgetProps<CustomWidgetProps, 'custom'>>;
|
10
10
|
/**
|
11
11
|
* Facade component that renders a widget within a dashboard based on the widget type.
|
12
12
|
*
|
@@ -63,7 +63,7 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
63
63
|
* @category Widget
|
64
64
|
*/
|
65
65
|
widgetType: {
|
66
|
-
type: PropType<"chart" | "pivot" | "text" | "
|
66
|
+
type: PropType<"chart" | "pivot" | "text" | "custom">;
|
67
67
|
required: true;
|
68
68
|
};
|
69
69
|
/**
|
@@ -73,11 +73,11 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
73
73
|
*/
|
74
74
|
chartType: PropType<import("@sisense/sdk-ui-preact").ChartType | undefined>;
|
75
75
|
/**
|
76
|
-
* {@inheritDoc @sisense/sdk-ui!
|
76
|
+
* {@inheritDoc @sisense/sdk-ui!CustomWidgetProps.customWidgetType}
|
77
77
|
*
|
78
78
|
* @category Widget
|
79
79
|
*/
|
80
|
-
|
80
|
+
customWidgetType: PropType<string | undefined>;
|
81
81
|
/**
|
82
82
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataSource}
|
83
83
|
*
|
@@ -107,7 +107,7 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
107
107
|
*
|
108
108
|
* @category Widget
|
109
109
|
*/
|
110
|
-
styleOptions: PropType<import("@sisense/sdk-ui-preact").TextWidgetStyleOptions | import("@sisense/sdk-ui-preact").
|
110
|
+
styleOptions: PropType<import("@sisense/sdk-ui-preact").TextWidgetStyleOptions | import("@sisense/sdk-ui-preact").CustomWidgetStyleOptions | import("@sisense/sdk-ui-preact").PivotTableWidgetStyleOptions | import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | undefined>;
|
111
111
|
/**
|
112
112
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.drilldownOptions}
|
113
113
|
*
|
@@ -157,7 +157,7 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
157
157
|
*
|
158
158
|
* @category Callbacks
|
159
159
|
*/
|
160
|
-
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
|
160
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").TextWidgetDataPointEventHandler | import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | import("@sisense/sdk-ui-preact").IndicatorDataPointEventHandler | undefined>;
|
161
161
|
/**
|
162
162
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointContextMenu}
|
163
163
|
*
|
@@ -188,7 +188,7 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
188
188
|
* @category Widget
|
189
189
|
*/
|
190
190
|
widgetType: {
|
191
|
-
type: PropType<"chart" | "pivot" | "text" | "
|
191
|
+
type: PropType<"chart" | "pivot" | "text" | "custom">;
|
192
192
|
required: true;
|
193
193
|
};
|
194
194
|
/**
|
@@ -198,11 +198,11 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
198
198
|
*/
|
199
199
|
chartType: PropType<import("@sisense/sdk-ui-preact").ChartType | undefined>;
|
200
200
|
/**
|
201
|
-
* {@inheritDoc @sisense/sdk-ui!
|
201
|
+
* {@inheritDoc @sisense/sdk-ui!CustomWidgetProps.customWidgetType}
|
202
202
|
*
|
203
203
|
* @category Widget
|
204
204
|
*/
|
205
|
-
|
205
|
+
customWidgetType: PropType<string | undefined>;
|
206
206
|
/**
|
207
207
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataSource}
|
208
208
|
*
|
@@ -232,7 +232,7 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
232
232
|
*
|
233
233
|
* @category Widget
|
234
234
|
*/
|
235
|
-
styleOptions: PropType<import("@sisense/sdk-ui-preact").TextWidgetStyleOptions | import("@sisense/sdk-ui-preact").
|
235
|
+
styleOptions: PropType<import("@sisense/sdk-ui-preact").TextWidgetStyleOptions | import("@sisense/sdk-ui-preact").CustomWidgetStyleOptions | import("@sisense/sdk-ui-preact").PivotTableWidgetStyleOptions | import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | undefined>;
|
236
236
|
/**
|
237
237
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.drilldownOptions}
|
238
238
|
*
|
@@ -282,7 +282,7 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
282
282
|
*
|
283
283
|
* @category Callbacks
|
284
284
|
*/
|
285
|
-
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
|
285
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").TextWidgetDataPointEventHandler | import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | import("@sisense/sdk-ui-preact").IndicatorDataPointEventHandler | undefined>;
|
286
286
|
/**
|
287
287
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointContextMenu}
|
288
288
|
*
|
@@ -1,12 +1,15 @@
|
|
1
1
|
export { useExecuteQuery } from './use-execute-query.js';
|
2
2
|
export { useExecuteQueryByWidgetId } from './use-execute-query-by-widget-id.js';
|
3
3
|
export { useExecuteCsvQuery } from './use-execute-csv-query.js';
|
4
|
+
export { useExecuteCustomWidgetQuery, type ExecuteCustomWidgetQueryParams, type CustomWidgetQueryState, } from './use-execute-custom-widget-query.js';
|
5
|
+
export { useGetFilterMembers } from './use-get-filter-members.js';
|
4
6
|
export { useGetDashboardModel } from './use-get-dashboard-model.js';
|
5
7
|
export { useGetDashboardModels } from './use-get-dashboard-models.js';
|
6
8
|
export { useGetSharedFormula } from './use-get-shared-formula.js';
|
7
9
|
export { useGetWidgetModel } from './use-get-widget-model.js';
|
8
10
|
export { useGetHierarchyModels } from './use-get-hierarchy-models.js';
|
9
11
|
export { useFetch } from './use-fetch.js';
|
10
|
-
export {
|
12
|
+
export { useCustomWidgets, type CustomWidgetComponent, type CustomWidgetComponentProps, type GenericDataOptions, } from './use-custom-widgets.js';
|
11
13
|
export { useComposedDashboard, type ComposableDashboardProps } from './use-composed-dashboard.js';
|
12
14
|
export type { UseFetchOptions } from './use-fetch.js';
|
15
|
+
export type { GetFilterMembersParams, GetFilterMembersData, FilterMembersState, FilterMembersLoadingState, FilterMembersErrorState, FilterMembersSuccessState, } from './use-get-filter-members.js';
|
@@ -0,0 +1,46 @@
|
|
1
|
+
import { type CustomWidgetComponentProps, type GenericDataOptions } from '@sisense/sdk-ui-preact';
|
2
|
+
import type { Component, DefineComponent } from 'vue';
|
3
|
+
/** Re-export related types */
|
4
|
+
export type { CustomWidgetComponentProps, GenericDataOptions };
|
5
|
+
/**
|
6
|
+
* Type representing a Vue component that can be used as a user-defined custom widget.
|
7
|
+
* This can be a Vue component options object, a defineComponent result, or any valid Vue component.
|
8
|
+
*/
|
9
|
+
export type CustomWidgetComponent<Props extends CustomWidgetComponentProps = CustomWidgetComponentProps> = Component<Props> | DefineComponent<Props>;
|
10
|
+
/**
|
11
|
+
* Vue composable function for working with custom widgets
|
12
|
+
*
|
13
|
+
* @example
|
14
|
+
* How to use `useCustomWidgets` to register a custom widget in a dashboard:
|
15
|
+
* ```vue
|
16
|
+
<script setup lang="ts">
|
17
|
+
import { useCustomWidgets, DashboardById } from '@sisense/sdk-ui-vue';
|
18
|
+
import CustomHistogramWidget from './custom-histogram-widget';
|
19
|
+
|
20
|
+
const { registerCustomWidget } = useCustomWidgets();
|
21
|
+
registerCustomWidget('histogramwidget', CustomHistogramWidget);
|
22
|
+
|
23
|
+
</script>
|
24
|
+
<template>
|
25
|
+
<DashboardById dashboardOid="your-dashboard-oid" />
|
26
|
+
</template>
|
27
|
+
* ```
|
28
|
+
*
|
29
|
+
* @group Dashboards
|
30
|
+
*/
|
31
|
+
export declare const useCustomWidgets: () => {
|
32
|
+
/**
|
33
|
+
* Registers a new custom widget.
|
34
|
+
*
|
35
|
+
* @param customWidgetType - The unique identifier for the custom widget type.
|
36
|
+
* @param customWidget - The custom widget component to register.
|
37
|
+
*/
|
38
|
+
registerCustomWidget: <Props extends CustomWidgetComponentProps<GenericDataOptions, any> = CustomWidgetComponentProps<GenericDataOptions, any>>(customWidgetType: string, customWidget: CustomWidgetComponent<Props>) => void;
|
39
|
+
/**
|
40
|
+
* Checks if a custom widget is registered.
|
41
|
+
*
|
42
|
+
* @param customWidgetType - The type of the custom widget.
|
43
|
+
* @returns True if the custom widget is registered, false otherwise.
|
44
|
+
*/
|
45
|
+
hasCustomWidget: (customWidgetType: string) => boolean;
|
46
|
+
};
|
@@ -0,0 +1,45 @@
|
|
1
|
+
import { type ExecuteCustomWidgetQueryParams as ExecuteCustomWidgetQueryParamsPreact, type CustomWidgetQueryState } from '@sisense/sdk-ui-preact';
|
2
|
+
import type { MaybeRefOrWithRefs } from '../types';
|
3
|
+
export type { CustomWidgetQueryState };
|
4
|
+
/**
|
5
|
+
* Parameters for executing a query for a custom widget.
|
6
|
+
*/
|
7
|
+
export interface ExecuteCustomWidgetQueryParams extends ExecuteCustomWidgetQueryParamsPreact {
|
8
|
+
}
|
9
|
+
/**
|
10
|
+
* Vue composable that takes a custom widget component's props and executes a data query.
|
11
|
+
*
|
12
|
+
* @example
|
13
|
+
* ```vue
|
14
|
+
* <script setup>
|
15
|
+
* import {
|
16
|
+
* useExecuteCustomWidgetQuery,
|
17
|
+
* type CustomWidgetComponentProps,
|
18
|
+
* type ExecuteCustomWidgetQueryParams,
|
19
|
+
* } from '@sisense/sdk-ui-vue';
|
20
|
+
* import * as DM from './sample-ecommerce';
|
21
|
+
*
|
22
|
+
* const props: CustomWidgetComponentProps = {
|
23
|
+
* dataSource: DM.DataSource,
|
24
|
+
* dataOptions: {
|
25
|
+
* category: [DM.Commerce.Gender],
|
26
|
+
* value: [DM.Measures.SumRevenue],
|
27
|
+
* },
|
28
|
+
* styleOptions: {},
|
29
|
+
* };
|
30
|
+
*
|
31
|
+
* const params: ExecuteCustomWidgetQueryParams = {
|
32
|
+
* ...props,
|
33
|
+
* count: 10,
|
34
|
+
* offset: 0,
|
35
|
+
* };
|
36
|
+
*
|
37
|
+
* const { data, isLoading, isError, isSuccess } = useExecuteCustomWidgetQuery(params);
|
38
|
+
* </script>
|
39
|
+
* ```
|
40
|
+
*
|
41
|
+
* @param params - Custom widget component props containing data source, data options, filters, etc.
|
42
|
+
* @returns Query state object with data, loading, and error states
|
43
|
+
* @group Queries
|
44
|
+
*/
|
45
|
+
export declare const useExecuteCustomWidgetQuery: (params: MaybeRefOrWithRefs<ExecuteCustomWidgetQueryParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").QueryState>;
|
@@ -0,0 +1,46 @@
|
|
1
|
+
import { type ToRefs } from 'vue';
|
2
|
+
import { type GetFilterMembersParams, type GetFilterMembersData, type FilterMembersState, type FilterMembersLoadingState, type FilterMembersErrorState, type FilterMembersSuccessState } from '@sisense/sdk-ui-preact';
|
3
|
+
import type { MaybeRefOrWithRefs } from '../types';
|
4
|
+
/** Reexport types from @sisense/sdk-ui-preact */
|
5
|
+
export { GetFilterMembersParams, GetFilterMembersData, FilterMembersState, FilterMembersLoadingState, FilterMembersErrorState, FilterMembersSuccessState, };
|
6
|
+
/**
|
7
|
+
* A Vue composable function `useGetFilterMembers` that fetches members of a provided filter.
|
8
|
+
*
|
9
|
+
* Those members can be used to display a list of members in a third-party filter component.
|
10
|
+
*
|
11
|
+
* @param {MaybeRefOrWithRefs<GetFilterMembersParams>} params - The parameters for fetching filter members, supporting reactive Vue refs.
|
12
|
+
* Includes the filter to fetch members for, optional default data source, parent filters, and count.
|
13
|
+
*
|
14
|
+
* @example
|
15
|
+
* How to use `useGetFilterMembers` within a Vue component:
|
16
|
+
* ```vue
|
17
|
+
* <script setup>
|
18
|
+
* import { ref } from 'vue';
|
19
|
+
* import { useGetFilterMembers, filterFactory } from '@sisense/sdk-ui-vue';
|
20
|
+
* import * as DM from './data-model';
|
21
|
+
*
|
22
|
+
* const filter = ref(filterFactory.members(DM.Country.Country, ['United States', 'Canada']));
|
23
|
+
*
|
24
|
+
* const { data, isLoading, isError, isSuccess, error, loadMore } = useGetFilterMembers({
|
25
|
+
* filter,
|
26
|
+
* // Optional parameters
|
27
|
+
* defaultDataSource: 'Sample ECommerce',
|
28
|
+
* parentFilters: [],
|
29
|
+
* });
|
30
|
+
* </script>
|
31
|
+
* ```
|
32
|
+
*
|
33
|
+
* The composable returns an object with the following reactive properties to manage the filter members state:
|
34
|
+
* - `data`: The filter members data containing selectedMembers, allMembers, excludeMembers, enableMultiSelection, and hasBackgroundFilter.
|
35
|
+
* - `isLoading`: Indicates if the filter members fetching is in progress.
|
36
|
+
* - `isError`: Indicates if an error occurred during filter members fetching.
|
37
|
+
* - `isSuccess`: Indicates if the filter members fetching executed successfully without errors.
|
38
|
+
* - `error`: Contains the error object if an error occurred during the fetching.
|
39
|
+
* - `loadMore`: Function to load more data rows.
|
40
|
+
*
|
41
|
+
* This composable facilitates integrating Sisense filter members fetching into Vue applications, enabling developers
|
42
|
+
* to easily manage filter member states and dynamically adjust parameters based on application needs.
|
43
|
+
*
|
44
|
+
* @group Filter Tiles
|
45
|
+
*/
|
46
|
+
export declare const useGetFilterMembers: (params: MaybeRefOrWithRefs<GetFilterMembersParams>) => ToRefs<FilterMembersState>;
|
@@ -0,0 +1,8 @@
|
|
1
|
+
import type { ContextConnector, CustomWidgetsProviderAdapterProps } from '@sisense/sdk-ui-preact';
|
2
|
+
/**
|
3
|
+
* Creates custom widgets context connector
|
4
|
+
*
|
5
|
+
* @group Contexts
|
6
|
+
* @internal
|
7
|
+
*/
|
8
|
+
export declare const createCustomWidgetsContextConnector: () => ContextConnector<CustomWidgetsProviderAdapterProps>;
|
@@ -0,0 +1,16 @@
|
|
1
|
+
import { type App } from 'vue';
|
2
|
+
import type { Component, DefineComponent } from 'vue';
|
3
|
+
type AnyObject = Record<string, any>;
|
4
|
+
/**
|
5
|
+
* Result of rendering a dynamic component
|
6
|
+
*/
|
7
|
+
export interface RenderedComponent {
|
8
|
+
/** The DOM element containing the rendered component */
|
9
|
+
element: HTMLElement;
|
10
|
+
/** Function to properly destroy the component and clean up resources */
|
11
|
+
destroy: () => void;
|
12
|
+
/** Reference to the Vue app instance */
|
13
|
+
app: App<Element>;
|
14
|
+
}
|
15
|
+
export declare function renderComponent<Props extends AnyObject>(Component: Component<Props> | DefineComponent<Props>, props: Props): RenderedComponent;
|
16
|
+
export {};
|
@@ -1,6 +1,6 @@
|
|
1
1
|
import { type Slots } from 'vue';
|
2
2
|
import { type ContextConnector, type AnyComponentFunction } from '@sisense/sdk-ui-preact';
|
3
|
-
export declare function createDefaultContextConnectors(): (ContextConnector<import("@sisense/sdk-ui-preact").CustomSisenseContextProviderProps> | ContextConnector<import("@sisense/sdk-ui-preact").CustomThemeProviderProps> | ContextConnector<import("@sisense/sdk-ui-preact").
|
3
|
+
export declare function createDefaultContextConnectors(): (ContextConnector<import("@sisense/sdk-ui-preact").CustomSisenseContextProviderProps> | ContextConnector<import("@sisense/sdk-ui-preact").CustomThemeProviderProps> | ContextConnector<import("@sisense/sdk-ui-preact").CustomWidgetsProviderAdapterProps>)[];
|
4
4
|
export declare function getRawData<T>(data: T): T;
|
5
5
|
export declare function toDeepRaw<T>(data: T): T;
|
6
6
|
/**
|
@@ -1,7 +1,7 @@
|
|
1
1
|
export { DrilldownBreadcrumbs, type DrilldownBreadcrumbsProps, } from './components/drilldown-breadcrumbs';
|
2
2
|
export * from './components/charts';
|
3
3
|
export * from './components/filters';
|
4
|
-
export { SisenseContextProvider, type SisenseContextProviderProps, ThemeProvider, type ThemeProviderProps,
|
4
|
+
export { SisenseContextProvider, type SisenseContextProviderProps, ThemeProvider, type ThemeProviderProps, CustomWidgetsProvider, } from './providers';
|
5
5
|
export * from './composables';
|
6
6
|
export * from './components/context-menu';
|
7
7
|
export * from './types';
|
package/dist/packages/sdk-ui-vue/src/providers/custom-widgets-provider/custom-widgets-context.d.ts
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
import type { InjectionKey, Ref } from 'vue';
|
2
|
+
import type { CustomWidgetsContextAdapter, CustomWidgetComponent } from '@sisense/sdk-ui-preact';
|
3
|
+
export declare const defaultCustomWidgetsContext: {
|
4
|
+
customWidgetsMap: Map<string, CustomWidgetComponent<any>>;
|
5
|
+
};
|
6
|
+
export declare const customWidgetsContextKey: InjectionKey<Ref<CustomWidgetsContextAdapter>>;
|
7
|
+
/**
|
8
|
+
* Gets Custom Widgets context
|
9
|
+
*
|
10
|
+
* @group Contexts
|
11
|
+
*/
|
12
|
+
export declare const getCustomWidgetsContext: () => Ref<CustomWidgetsContextAdapter>;
|
@@ -1,11 +1,11 @@
|
|
1
1
|
/**
|
2
|
-
* Provider for working with
|
2
|
+
* Provider for working with custom widgets fetched from an external environment.
|
3
3
|
*
|
4
|
-
* Provides methods for registering, retrieving, and interacting with
|
4
|
+
* Provides methods for registering, retrieving, and interacting with custom widgets.
|
5
5
|
*
|
6
6
|
* @internal
|
7
7
|
* @group Contexts
|
8
8
|
*/
|
9
|
-
export declare const
|
9
|
+
export declare const CustomWidgetsProvider: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
10
10
|
[key: string]: any;
|
11
11
|
}>[] | undefined, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
|
@@ -1,2 +1,2 @@
|
|
1
|
-
export { boxWhiskerProcessResult } from '@sisense/sdk-ui-preact';
|
1
|
+
export { boxWhiskerProcessResult, extractDimensionsAndMeasures } from '@sisense/sdk-ui-preact';
|
2
2
|
export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, 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, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, IndicatorBeforeRenderHandler, IndicatorRenderOptions, DashboardLayoutOptions, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, Member, FilterVariant, TranslationConfig, } from '@sisense/sdk-ui-preact';
|