@sisense/sdk-ui-vue 2.33.1 → 2.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +1 -1
- package/dist/index.js +421 -338
- package/dist/src/components/charts/index.d.ts +1 -0
- package/dist/src/components/charts/kpi-chart.d.ts +171 -0
- package/dist/src/components/dashboard/dashboard-model.d.ts +14 -0
- package/dist/src/components/dashboard/index.d.ts +1 -0
- package/dist/src/components/filters/criteria-filter-tile.d.ts +8 -0
- package/dist/src/components/filters/date-range-filter-tile.d.ts +8 -0
- package/dist/src/components/filters/filter-tile.d.ts +12 -1
- package/dist/src/components/filters/index.d.ts +2 -2
- package/dist/src/components/filters/member-filter-tile.d.ts +8 -0
- package/dist/src/components/widgets/chart-widget.d.ts +15 -4
- package/dist/src/components/widgets/index.d.ts +5 -2
- package/dist/src/components/widgets/widget-by-id.d.ts +8 -1
- package/dist/src/components/widgets/widget-config.d.ts +57 -0
- package/dist/src/components/widgets/widget-header-config.d.ts +6 -0
- package/dist/src/components/widgets/widget-model.d.ts +14 -0
- package/dist/src/components/widgets/widget.d.ts +43 -7
- package/dist/src/composables/use-get-widget-model.d.ts +2 -1
- package/dist/src/sdk-ui-core-exports.d.ts +1 -1
- package/dist/src/utilities/dashboard-model-translator.d.ts +1 -1
- package/dist/src/utilities/widget-model-translator.d.ts +5 -2
- package/package.json +3 -3
|
@@ -12,6 +12,7 @@ export { TreemapChart, type TreemapChartProps } from './treemap-chart';
|
|
|
12
12
|
export { SunburstChart, type SunburstChartProps } from './sunburst-chart';
|
|
13
13
|
export { PolarChart, type PolarChartProps } from './polar-chart';
|
|
14
14
|
export { IndicatorChart, type IndicatorChartProps } from './indicator-chart';
|
|
15
|
+
export { KpiChart, type KpiChartProps } from './kpi-chart';
|
|
15
16
|
export { Chart, type ChartProps } from './chart';
|
|
16
17
|
export { BoxplotChart, type BoxplotChartProps } from './boxplot-chart';
|
|
17
18
|
export { AreamapChart, type AreamapChartProps } from './areamap-chart';
|
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
import type { KpiChartProps as KpiChartPropsPreact } from '@sisense/sdk-ui-preact';
|
|
2
|
+
import type { PropType } from 'vue';
|
|
3
|
+
/**
|
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!KpiChart | `KpiChart`} component.
|
|
5
|
+
*/
|
|
6
|
+
export interface KpiChartProps extends KpiChartPropsPreact {
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* A Vue component that displays a single headline metric as a card, optionally with a
|
|
10
|
+
* sparkline of its trend and a readout comparing it against a baseline.
|
|
11
|
+
*
|
|
12
|
+
* Given just a measure, the card shows that number on its own. Adding a `category` — typically
|
|
13
|
+
* a date dimension — gives it a sparkline and a caption for the period being shown. Adding a
|
|
14
|
+
* `comparison` makes it also report how the metric moved: against the previous period, against
|
|
15
|
+
* a second measure, or against a target.
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* Here's how you can use the KpiChart component in a Vue application:
|
|
19
|
+
* ```vue
|
|
20
|
+
* <template>
|
|
21
|
+
* <KpiChart
|
|
22
|
+
:dataSet="kpiChartProps.dataSet"
|
|
23
|
+
:dataOptions="kpiChartProps.dataOptions"
|
|
24
|
+
:filters="kpiChartProps.filters"
|
|
25
|
+
:styleOptions="kpiChartProps.styleOptions"
|
|
26
|
+
/>
|
|
27
|
+
* </template>
|
|
28
|
+
*
|
|
29
|
+
* <script setup lang="ts">
|
|
30
|
+
* import { ref } from 'vue';
|
|
31
|
+
* import { measureFactory } from '@sisense/sdk-data';
|
|
32
|
+
* import * as DM from '../assets/sample-retail-model';
|
|
33
|
+
* import { KpiChart, type KpiChartProps } from '@sisense/sdk-ui-vue';
|
|
34
|
+
*
|
|
35
|
+
* const kpiChartProps = ref<KpiChartProps>({
|
|
36
|
+
* dataSet: DM.DataSource,
|
|
37
|
+
* dataOptions: {
|
|
38
|
+
* value: measureFactory.sum(DM.Fact_Sale_orders.OrderRevenue, 'Total Revenue'),
|
|
39
|
+
* category: DM.DimDate.Date.Months,
|
|
40
|
+
* comparison: { type: 'previous-period' },
|
|
41
|
+
* },
|
|
42
|
+
* styleOptions: {
|
|
43
|
+
* title: { text: 'Total Revenue' },
|
|
44
|
+
* },
|
|
45
|
+
* filters: [],
|
|
46
|
+
* });
|
|
47
|
+
* </script>
|
|
48
|
+
* ```
|
|
49
|
+
* @param {KpiChartProps} - KPI chart properties
|
|
50
|
+
* @returns KPI Chart component
|
|
51
|
+
* @group Charts
|
|
52
|
+
*/
|
|
53
|
+
export declare const KpiChart: import("vue").DefineComponent<{
|
|
54
|
+
/**
|
|
55
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.dataOptions}
|
|
56
|
+
*
|
|
57
|
+
* @category Chart
|
|
58
|
+
*/
|
|
59
|
+
dataOptions: {
|
|
60
|
+
type: PropType<import("@sisense/sdk-ui-preact").KpiChartDataOptions>;
|
|
61
|
+
required: true;
|
|
62
|
+
};
|
|
63
|
+
/**
|
|
64
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.dataSet}
|
|
65
|
+
*
|
|
66
|
+
* @category Data
|
|
67
|
+
*/
|
|
68
|
+
dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
|
|
69
|
+
/**
|
|
70
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.filters}
|
|
71
|
+
*
|
|
72
|
+
* @category Data
|
|
73
|
+
*/
|
|
74
|
+
filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
|
|
75
|
+
/**
|
|
76
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.highlights}
|
|
77
|
+
*
|
|
78
|
+
* @category Data
|
|
79
|
+
*/
|
|
80
|
+
highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
|
|
81
|
+
/**
|
|
82
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.styleOptions}
|
|
83
|
+
*
|
|
84
|
+
* @category Chart
|
|
85
|
+
*/
|
|
86
|
+
styleOptions: PropType<import("@sisense/sdk-ui-preact").KpiStyleOptions | undefined>;
|
|
87
|
+
/**
|
|
88
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.onBeforeRender}
|
|
89
|
+
*
|
|
90
|
+
* @category Callbacks
|
|
91
|
+
*/
|
|
92
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").KpiBeforeRenderHandler | undefined>;
|
|
93
|
+
/**
|
|
94
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.onDataReady}
|
|
95
|
+
*
|
|
96
|
+
* @category Callbacks
|
|
97
|
+
*/
|
|
98
|
+
onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
|
|
99
|
+
/**
|
|
100
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.onDataPointClick}
|
|
101
|
+
*
|
|
102
|
+
* @category Callbacks
|
|
103
|
+
*/
|
|
104
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
105
|
+
/**
|
|
106
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.onDataPointContextMenu}
|
|
107
|
+
*
|
|
108
|
+
* @category Callbacks
|
|
109
|
+
*/
|
|
110
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
111
|
+
}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
112
|
+
[key: string]: any;
|
|
113
|
+
}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
114
|
+
/**
|
|
115
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.dataOptions}
|
|
116
|
+
*
|
|
117
|
+
* @category Chart
|
|
118
|
+
*/
|
|
119
|
+
dataOptions: {
|
|
120
|
+
type: PropType<import("@sisense/sdk-ui-preact").KpiChartDataOptions>;
|
|
121
|
+
required: true;
|
|
122
|
+
};
|
|
123
|
+
/**
|
|
124
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.dataSet}
|
|
125
|
+
*
|
|
126
|
+
* @category Data
|
|
127
|
+
*/
|
|
128
|
+
dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
|
|
129
|
+
/**
|
|
130
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.filters}
|
|
131
|
+
*
|
|
132
|
+
* @category Data
|
|
133
|
+
*/
|
|
134
|
+
filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
|
|
135
|
+
/**
|
|
136
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.highlights}
|
|
137
|
+
*
|
|
138
|
+
* @category Data
|
|
139
|
+
*/
|
|
140
|
+
highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
|
|
141
|
+
/**
|
|
142
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.styleOptions}
|
|
143
|
+
*
|
|
144
|
+
* @category Chart
|
|
145
|
+
*/
|
|
146
|
+
styleOptions: PropType<import("@sisense/sdk-ui-preact").KpiStyleOptions | undefined>;
|
|
147
|
+
/**
|
|
148
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.onBeforeRender}
|
|
149
|
+
*
|
|
150
|
+
* @category Callbacks
|
|
151
|
+
*/
|
|
152
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").KpiBeforeRenderHandler | undefined>;
|
|
153
|
+
/**
|
|
154
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.onDataReady}
|
|
155
|
+
*
|
|
156
|
+
* @category Callbacks
|
|
157
|
+
*/
|
|
158
|
+
onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
|
|
159
|
+
/**
|
|
160
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.onDataPointClick}
|
|
161
|
+
*
|
|
162
|
+
* @category Callbacks
|
|
163
|
+
*/
|
|
164
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
165
|
+
/**
|
|
166
|
+
* {@inheritDoc @sisense/sdk-ui!KpiChartProps.onDataPointContextMenu}
|
|
167
|
+
*
|
|
168
|
+
* @category Callbacks
|
|
169
|
+
*/
|
|
170
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
171
|
+
}>>, {}, {}>;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { type DashboardModel as DashboardModelPreact } from '@sisense/sdk-ui-preact';
|
|
2
|
+
import { type WidgetModel } from '../widgets/widget-model';
|
|
3
|
+
/**
|
|
4
|
+
* {@inheritDoc @sisense/sdk-ui!DashboardModel}
|
|
5
|
+
*
|
|
6
|
+
* @group Fusion Assets
|
|
7
|
+
* @fusionEmbed
|
|
8
|
+
*/
|
|
9
|
+
export interface DashboardModel extends Omit<DashboardModelPreact, 'widgets'> {
|
|
10
|
+
/**
|
|
11
|
+
* {@inheritDoc @sisense/sdk-ui!DashboardModel.widgets}
|
|
12
|
+
*/
|
|
13
|
+
widgets: WidgetModel[];
|
|
14
|
+
}
|
|
@@ -80,6 +80,10 @@ export declare const CriteriaFilterTile: import("vue").DefineComponent<{
|
|
|
80
80
|
* {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.onEdit}
|
|
81
81
|
*/
|
|
82
82
|
onEdit: PropType<(() => void) | undefined>;
|
|
83
|
+
/**
|
|
84
|
+
* {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.config}
|
|
85
|
+
*/
|
|
86
|
+
config: PropType<import("@sisense/sdk-ui-preact").FilterTileConfig | undefined>;
|
|
83
87
|
}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
84
88
|
[key: string]: any;
|
|
85
89
|
}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
@@ -120,4 +124,8 @@ export declare const CriteriaFilterTile: import("vue").DefineComponent<{
|
|
|
120
124
|
* {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.onEdit}
|
|
121
125
|
*/
|
|
122
126
|
onEdit: PropType<(() => void) | undefined>;
|
|
127
|
+
/**
|
|
128
|
+
* {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.config}
|
|
129
|
+
*/
|
|
130
|
+
config: PropType<import("@sisense/sdk-ui-preact").FilterTileConfig | undefined>;
|
|
123
131
|
}>>, {}, {}>;
|
|
@@ -102,6 +102,10 @@ export declare const DateRangeFilterTile: import("vue").DefineComponent<{
|
|
|
102
102
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.onEdit}
|
|
103
103
|
*/
|
|
104
104
|
onEdit: PropType<(() => void) | undefined>;
|
|
105
|
+
/**
|
|
106
|
+
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.config}
|
|
107
|
+
*/
|
|
108
|
+
config: PropType<import("@sisense/sdk-ui-preact").FilterTileConfig | undefined>;
|
|
105
109
|
}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
106
110
|
[key: string]: any;
|
|
107
111
|
}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
@@ -162,4 +166,8 @@ export declare const DateRangeFilterTile: import("vue").DefineComponent<{
|
|
|
162
166
|
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.onEdit}
|
|
163
167
|
*/
|
|
164
168
|
onEdit: PropType<(() => void) | undefined>;
|
|
169
|
+
/**
|
|
170
|
+
* {@inheritDoc @sisense/sdk-ui!DateRangeFilterTileProps.config}
|
|
171
|
+
*/
|
|
172
|
+
config: PropType<import("@sisense/sdk-ui-preact").FilterTileConfig | undefined>;
|
|
165
173
|
}>>, {}, {}>;
|
|
@@ -1,5 +1,8 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { FilterTileMenuTargets } from '@sisense/sdk-ui-preact';
|
|
2
|
+
import type { FilterTileActionsConfig, FilterTileConfig, FilterTileHeaderConfig, FilterTileMenuActionItem, FilterTileMenuConfig, FilterTileMenuItem, FilterTileMenuSubmenuItem, FilterTileMenuTarget, FilterTileProps as FilterTilePropsPreact } from '@sisense/sdk-ui-preact';
|
|
2
3
|
import type { PropType } from 'vue';
|
|
4
|
+
/** Reexport related types */
|
|
5
|
+
export { FilterTileMenuTargets, type FilterTileActionsConfig, type FilterTileConfig, type FilterTileHeaderConfig, type FilterTileMenuActionItem, type FilterTileMenuConfig, type FilterTileMenuItem, type FilterTileMenuSubmenuItem, type FilterTileMenuTarget, };
|
|
3
6
|
/**
|
|
4
7
|
* Props of the {@link @sisense/sdk-ui-vue!FilterTile | `FilterTile`} component.
|
|
5
8
|
*/
|
|
@@ -62,6 +65,10 @@ export declare const FilterTile: import("vue").DefineComponent<{
|
|
|
62
65
|
* {@inheritDoc @sisense/sdk-ui!FilterTileProps.onEdit}
|
|
63
66
|
*/
|
|
64
67
|
onEdit: PropType<((levelIndex?: number | undefined) => void) | undefined>;
|
|
68
|
+
/**
|
|
69
|
+
* {@inheritDoc @sisense/sdk-ui!FilterTileProps.config}
|
|
70
|
+
*/
|
|
71
|
+
config: PropType<FilterTileConfig | undefined>;
|
|
65
72
|
}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
66
73
|
[key: string]: any;
|
|
67
74
|
}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
@@ -91,4 +98,8 @@ export declare const FilterTile: import("vue").DefineComponent<{
|
|
|
91
98
|
* {@inheritDoc @sisense/sdk-ui!FilterTileProps.onEdit}
|
|
92
99
|
*/
|
|
93
100
|
onEdit: PropType<((levelIndex?: number | undefined) => void) | undefined>;
|
|
101
|
+
/**
|
|
102
|
+
* {@inheritDoc @sisense/sdk-ui!FilterTileProps.config}
|
|
103
|
+
*/
|
|
104
|
+
config: PropType<FilterTileConfig | undefined>;
|
|
94
105
|
}>>, {}, {}>;
|
|
@@ -2,5 +2,5 @@ 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';
|
|
6
|
-
export { FiltersPanel, type FiltersPanelProps } from './filters-panel';
|
|
5
|
+
export { FilterTile, type FilterTileProps, FilterTileMenuTargets, type FilterTileActionsConfig, type FilterTileConfig, type FilterTileHeaderConfig, type FilterTileMenuActionItem, type FilterTileMenuConfig, type FilterTileMenuItem, type FilterTileMenuSubmenuItem, type FilterTileMenuTarget, } from './filter-tile';
|
|
6
|
+
export { FiltersPanel, type FiltersPanelProps, type FiltersPanelConfig } from './filters-panel';
|
|
@@ -91,6 +91,10 @@ export declare const MemberFilterTile: import("vue").DefineComponent<{
|
|
|
91
91
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.onEdit}
|
|
92
92
|
*/
|
|
93
93
|
onEdit: PropType<(() => void) | undefined>;
|
|
94
|
+
/**
|
|
95
|
+
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.config}
|
|
96
|
+
*/
|
|
97
|
+
config: PropType<import("@sisense/sdk-ui-preact").FilterTileConfig | undefined>;
|
|
94
98
|
}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
95
99
|
[key: string]: any;
|
|
96
100
|
}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
@@ -138,4 +142,8 @@ export declare const MemberFilterTile: import("vue").DefineComponent<{
|
|
|
138
142
|
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.onEdit}
|
|
139
143
|
*/
|
|
140
144
|
onEdit: PropType<(() => void) | undefined>;
|
|
145
|
+
/**
|
|
146
|
+
* {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.config}
|
|
147
|
+
*/
|
|
148
|
+
config: PropType<import("@sisense/sdk-ui-preact").FilterTileConfig | undefined>;
|
|
141
149
|
}>>, {}, {}>;
|
|
@@ -1,7 +1,18 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
|
-
import type { ChartWidgetProps } from '@sisense/sdk-ui-preact';
|
|
2
|
+
import type { ChartWidgetProps as ChartWidgetPropsPreact } from '@sisense/sdk-ui-preact';
|
|
3
3
|
import type { PropType } from 'vue';
|
|
4
|
-
|
|
4
|
+
import type { ChartWidgetConfig } from './widget-config';
|
|
5
|
+
/**
|
|
6
|
+
* Props of the {@link @sisense/sdk-ui-vue!ChartWidget | `ChartWidget`} component.
|
|
7
|
+
*/
|
|
8
|
+
export interface ChartWidgetProps extends Omit<ChartWidgetPropsPreact, 'config'> {
|
|
9
|
+
/**
|
|
10
|
+
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.config}
|
|
11
|
+
*
|
|
12
|
+
* @category Widget
|
|
13
|
+
*/
|
|
14
|
+
config?: ChartWidgetConfig;
|
|
15
|
+
}
|
|
5
16
|
/**
|
|
6
17
|
* The Chart Widget component extending the {@link Chart} component to support widget style options.
|
|
7
18
|
* It can be used along with the {@link DrilldownWidget} component to support advanced data drilldown.
|
|
@@ -156,7 +167,7 @@ export declare const ChartWidget: import("vue").DefineComponent<{
|
|
|
156
167
|
*
|
|
157
168
|
* @category Widget
|
|
158
169
|
*/
|
|
159
|
-
config: PropType<
|
|
170
|
+
config: PropType<ChartWidgetConfig | undefined>;
|
|
160
171
|
/**
|
|
161
172
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.id}
|
|
162
173
|
*
|
|
@@ -288,7 +299,7 @@ export declare const ChartWidget: import("vue").DefineComponent<{
|
|
|
288
299
|
*
|
|
289
300
|
* @category Widget
|
|
290
301
|
*/
|
|
291
|
-
config: PropType<
|
|
302
|
+
config: PropType<ChartWidgetConfig | undefined>;
|
|
292
303
|
/**
|
|
293
304
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.id}
|
|
294
305
|
*
|
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
export { ChartWidget, type ChartWidgetProps } from './chart-widget';
|
|
2
2
|
export { WidgetById, type WidgetByIdProps } from './widget-by-id';
|
|
3
|
-
export { PivotTableWidget } from './pivot-table-widget';
|
|
4
|
-
export { Widget, type WidgetProps, type WithCommonWidgetProps, type TextWidgetProps, type CustomWidgetProps, type
|
|
3
|
+
export { PivotTableWidget, type PivotTableWidgetProps } from './pivot-table-widget';
|
|
4
|
+
export { Widget, type WidgetProps, type WithCommonWidgetProps, type TextWidgetProps, type CustomWidgetProps, type FilterWidgetProps, } from './widget';
|
|
5
|
+
export * from './widget-config';
|
|
6
|
+
export * from './widget-header-config';
|
|
7
|
+
export * from './widget-model';
|
|
@@ -1,10 +1,17 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import type { WidgetByIdProps as WidgetByIdPropsPreact } from '@sisense/sdk-ui-preact';
|
|
3
3
|
import type { PropType } from 'vue';
|
|
4
|
+
import type { WidgetConfig } from './widget-config';
|
|
4
5
|
/**
|
|
5
6
|
* Props of the {@link @sisense/sdk-ui-vue!WidgetById | `WidgetById`} component.
|
|
6
7
|
*/
|
|
7
|
-
export interface WidgetByIdProps extends WidgetByIdPropsPreact {
|
|
8
|
+
export interface WidgetByIdProps extends Omit<WidgetByIdPropsPreact, 'config'> {
|
|
9
|
+
/**
|
|
10
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.config}
|
|
11
|
+
*
|
|
12
|
+
* @category Widget
|
|
13
|
+
*/
|
|
14
|
+
config?: WidgetConfig;
|
|
8
15
|
}
|
|
9
16
|
/**
|
|
10
17
|
* The `WidgetById` component, which is a thin wrapper on the {@link ChartWidget} component,
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { type ChartWidgetConfig as ChartWidgetConfigPreact, type CustomWidgetConfig as CustomWidgetConfigPreact, type FilterWidgetConfig as FilterWidgetConfigPreact, type PivotTableWidgetConfig as PivotTableWidgetConfigPreact, type TextWidgetConfig as TextWidgetConfigPreact } from '@sisense/sdk-ui-preact';
|
|
2
|
+
import { type WidgetHeaderConfig } from './widget-header-config';
|
|
3
|
+
/**
|
|
4
|
+
* Configuration of a chart widget.
|
|
5
|
+
*/
|
|
6
|
+
export interface ChartWidgetConfig extends Omit<ChartWidgetConfigPreact, 'header'> {
|
|
7
|
+
/**
|
|
8
|
+
* {@inheritDoc @sisense/sdk-ui!ChartWidgetConfig.header}
|
|
9
|
+
*/
|
|
10
|
+
header?: WidgetHeaderConfig;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Configuration of a pivot table widget.
|
|
14
|
+
*/
|
|
15
|
+
export interface PivotTableWidgetConfig extends Omit<PivotTableWidgetConfigPreact, 'header'> {
|
|
16
|
+
/**
|
|
17
|
+
* {@inheritDoc @sisense/sdk-ui!PivotTableWidgetConfig.header}
|
|
18
|
+
*/
|
|
19
|
+
header?: WidgetHeaderConfig;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Configuration of a custom widget.
|
|
23
|
+
*/
|
|
24
|
+
export interface CustomWidgetConfig extends Omit<CustomWidgetConfigPreact, 'header'> {
|
|
25
|
+
/**
|
|
26
|
+
* {@inheritDoc @sisense/sdk-ui!CustomWidgetConfig.header}
|
|
27
|
+
*/
|
|
28
|
+
header?: WidgetHeaderConfig;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Configuration of a text widget.
|
|
32
|
+
*/
|
|
33
|
+
export interface TextWidgetConfig extends Omit<TextWidgetConfigPreact, 'header'> {
|
|
34
|
+
/**
|
|
35
|
+
* {@inheritDoc @sisense/sdk-ui!TextWidgetConfig.header}
|
|
36
|
+
*/
|
|
37
|
+
header?: WidgetHeaderConfig;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Configuration of a filter widget.
|
|
41
|
+
*
|
|
42
|
+
* @beta
|
|
43
|
+
*/
|
|
44
|
+
export interface FilterWidgetConfig extends Omit<FilterWidgetConfigPreact, 'header'> {
|
|
45
|
+
/**
|
|
46
|
+
* {@inheritDoc @sisense/sdk-ui!FilterWidgetConfig.header}
|
|
47
|
+
*/
|
|
48
|
+
header?: WidgetHeaderConfig;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Configuration of a widget — the union of every widget-type-specific configuration.
|
|
52
|
+
*
|
|
53
|
+
* Used where the widget type is not known statically, for example {@link WidgetModel.config}. When
|
|
54
|
+
* the widget type is known, prefer that widget's own configuration type, which lists only the
|
|
55
|
+
* options the widget supports.
|
|
56
|
+
*/
|
|
57
|
+
export type WidgetConfig = ChartWidgetConfig | PivotTableWidgetConfig | CustomWidgetConfig | TextWidgetConfig | FilterWidgetConfig;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { type WidgetModel as WidgetModelPreact } from '@sisense/sdk-ui-preact';
|
|
2
|
+
import { type WidgetConfig } from './widget-config';
|
|
3
|
+
/**
|
|
4
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetModel}
|
|
5
|
+
*
|
|
6
|
+
* @group Fusion Assets
|
|
7
|
+
* @fusionEmbed
|
|
8
|
+
*/
|
|
9
|
+
export interface WidgetModel extends Omit<WidgetModelPreact, 'config'> {
|
|
10
|
+
/**
|
|
11
|
+
* {@inheritDoc @sisense/sdk-ui!WidgetModel.config}
|
|
12
|
+
*/
|
|
13
|
+
config?: WidgetConfig;
|
|
14
|
+
}
|
|
@@ -1,7 +1,43 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { CustomWidgetProps as CustomWidgetPropsPreact, FilterWidgetProps as FilterWidgetPropsPreact, SoftUnion, TextWidgetProps as TextWidgetPropsPreact, WithCommonWidgetProps } from '@sisense/sdk-ui-preact';
|
|
2
2
|
import type { PropType } from 'vue';
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
import type { ChartWidgetProps } from './chart-widget';
|
|
4
|
+
import type { PivotTableWidgetProps } from './pivot-table-widget';
|
|
5
|
+
import type { CustomWidgetConfig, FilterWidgetConfig, TextWidgetConfig } from './widget-config';
|
|
6
|
+
export { WithCommonWidgetProps };
|
|
7
|
+
/**
|
|
8
|
+
* Props for the text widget component.
|
|
9
|
+
*/
|
|
10
|
+
export interface TextWidgetProps extends Omit<TextWidgetPropsPreact, 'config'> {
|
|
11
|
+
/**
|
|
12
|
+
* {@inheritDoc @sisense/sdk-ui!TextWidgetProps.config}
|
|
13
|
+
*
|
|
14
|
+
* @category Widget
|
|
15
|
+
*/
|
|
16
|
+
config?: TextWidgetConfig;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Props for the custom widget component
|
|
20
|
+
*/
|
|
21
|
+
export interface CustomWidgetProps extends Omit<CustomWidgetPropsPreact, 'config'> {
|
|
22
|
+
/**
|
|
23
|
+
* {@inheritDoc @sisense/sdk-ui!CustomWidgetProps.config}
|
|
24
|
+
*
|
|
25
|
+
* @category Widget
|
|
26
|
+
*/
|
|
27
|
+
config?: CustomWidgetConfig;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Props for the filter widget component.
|
|
31
|
+
*
|
|
32
|
+
* @beta
|
|
33
|
+
*/
|
|
34
|
+
export interface FilterWidgetProps extends Omit<FilterWidgetPropsPreact, 'config'> {
|
|
35
|
+
/**
|
|
36
|
+
* {@inheritDoc @sisense/sdk-ui!FilterWidgetProps.config}
|
|
37
|
+
*
|
|
38
|
+
* @category Widget
|
|
39
|
+
*/
|
|
40
|
+
config?: FilterWidgetConfig;
|
|
5
41
|
}
|
|
6
42
|
/**
|
|
7
43
|
* Props of the {@link @sisense/sdk-ui-vue!Widget | `Widget`} component.
|
|
@@ -107,13 +143,13 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
|
107
143
|
*
|
|
108
144
|
* @category Widget
|
|
109
145
|
*/
|
|
110
|
-
styleOptions: PropType<import("@sisense/sdk-ui-preact").
|
|
146
|
+
styleOptions: PropType<import("@sisense/sdk-ui-preact").CustomWidgetStyleOptions | import("@sisense/sdk-ui-preact").TextWidgetStyleOptions | import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | import("@sisense/sdk-ui-preact").PivotTableWidgetStyleOptions | import("@sisense/sdk-ui-preact").FilterWidgetStyleOptions | undefined>;
|
|
111
147
|
/**
|
|
112
148
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.config}
|
|
113
149
|
*
|
|
114
150
|
* @category Widget
|
|
115
151
|
*/
|
|
116
|
-
config: PropType<import("
|
|
152
|
+
config: PropType<import("./widget-config").ChartWidgetConfig | import("./widget-config").PivotTableWidgetConfig | CustomWidgetConfig | TextWidgetConfig | FilterWidgetConfig | undefined>;
|
|
117
153
|
/**
|
|
118
154
|
* {@inheritDoc @sisense/sdk-ui!CustomWidgetProps.customOptions}
|
|
119
155
|
*
|
|
@@ -245,13 +281,13 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
|
245
281
|
*
|
|
246
282
|
* @category Widget
|
|
247
283
|
*/
|
|
248
|
-
styleOptions: PropType<import("@sisense/sdk-ui-preact").
|
|
284
|
+
styleOptions: PropType<import("@sisense/sdk-ui-preact").CustomWidgetStyleOptions | import("@sisense/sdk-ui-preact").TextWidgetStyleOptions | import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | import("@sisense/sdk-ui-preact").PivotTableWidgetStyleOptions | import("@sisense/sdk-ui-preact").FilterWidgetStyleOptions | undefined>;
|
|
249
285
|
/**
|
|
250
286
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.config}
|
|
251
287
|
*
|
|
252
288
|
* @category Widget
|
|
253
289
|
*/
|
|
254
|
-
config: PropType<import("
|
|
290
|
+
config: PropType<import("./widget-config").ChartWidgetConfig | import("./widget-config").PivotTableWidgetConfig | CustomWidgetConfig | TextWidgetConfig | FilterWidgetConfig | undefined>;
|
|
255
291
|
/**
|
|
256
292
|
* {@inheritDoc @sisense/sdk-ui!CustomWidgetProps.customOptions}
|
|
257
293
|
*
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import type { GetWidgetModelParams
|
|
1
|
+
import type { GetWidgetModelParams } from '@sisense/sdk-ui-preact';
|
|
2
|
+
import type { WidgetModel } from '../components/widgets/widget-model';
|
|
2
3
|
import type { MaybeRefOrWithRefs } from '../types';
|
|
3
4
|
/**
|
|
4
5
|
* A Vue composable function `useGetWidgetModel` for retrieving widget models from a Sisense dashboard.
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
export { boxWhiskerProcessResult, extractDimensionsAndMeasures, formatNumber, formatDate, getDefaultDateFormat, formatDataSet, } from '@sisense/sdk-ui-preact';
|
|
2
2
|
export { WidgetHeaderMenuTargets } from '@sisense/sdk-ui-preact';
|
|
3
|
-
export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, CalendarHeatmapChartType, ScattermapChartType, AreamapChartType, SankeyChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, CalendarHeatmapSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, GetHierarchyModelsParams, CommonDataOptions, FormatDateOptions, FormatDataSetOptions, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, CalendarHeatmapChartDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, SankeyChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, DataOptionLocation, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, StreamgraphStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, CalendarHeatmapStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, SankeyStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, LineOptions, DashStyle, EndCapType, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, CalendarHeatmapViewType,
|
|
3
|
+
export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, KpiChartType, CalendarHeatmapChartType, ScattermapChartType, AreamapChartType, SankeyChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, CalendarHeatmapSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, GetHierarchyModelsParams, CommonDataOptions, FormatDateOptions, FormatDataSetOptions, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, CalendarHeatmapChartDataOptions, KpiChartDataOptions, KpiComparison, KpiValueMode, ScattermapChartDataOptions, AreamapChartDataOptions, SankeyChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, DataOptionLocation, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, StreamgraphStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, CalendarHeatmapStyleOptions, KpiStyleOptions, KpiValueStyleOptions, KpiTitleStyleOptions, KpiComparisonStyleOptions, KpiSparklineStyleOptions, KpiSparklineType, KpiCardStyleOptions, KpiTextSize, KpiIconCondition, KpiIcon, KpiIconName, ScattermapStyleOptions, AreamapStyleOptions, SankeyStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, LineOptions, DashStyle, EndCapType, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, CalendarHeatmapViewType, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, CalendarHeatmapDataPoint, CalendarDayOfWeek, IndicatorBeforeRenderHandler, IndicatorRenderOptions, KpiBeforeRenderHandler, KpiRenderOptions, KpiDataPoint, KpiComparisonInfo, KpiDataPointEventHandler, DashboardLayoutOptions, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, WidgetHeaderMenuActionItem, WidgetHeaderMenuConfig, WidgetHeaderMenuItem, WidgetHeaderMenuSubmenuItem, WidgetHeaderMenuTarget, WidgetNarrativeConfig, WidgetNarrativeDisplayLocation, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, PivotTableDrilldownOptions, PivotTableSelectableDrilldownOptions, PivotTableNonSelectableDrilldownOptions, Member, FilterVariant, FilterWidgetFilterType, TranslationConfig, Plugin, } from '@sisense/sdk-ui-preact';
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { type DashboardModel } from '@sisense/sdk-ui-preact';
|
|
2
1
|
import type { DashboardProps } from '../components/dashboard';
|
|
2
|
+
import type { DashboardModel } from '../components/dashboard/dashboard-model';
|
|
3
3
|
/**
|
|
4
4
|
* Translates {@link DashboardModel} to {@link DashboardProps}.
|
|
5
5
|
*
|
|
@@ -1,6 +1,9 @@
|
|
|
1
|
-
import { type ExecutePivotQueryParams, type ExecuteQueryParams
|
|
1
|
+
import { type ExecutePivotQueryParams, type ExecuteQueryParams } from '@sisense/sdk-ui-preact';
|
|
2
2
|
import type { ChartProps, PivotTableProps, TableProps } from '../components/charts';
|
|
3
|
-
import type { ChartWidgetProps
|
|
3
|
+
import type { ChartWidgetProps } from '../components/widgets/chart-widget';
|
|
4
|
+
import type { PivotTableWidgetProps } from '../components/widgets/pivot-table-widget';
|
|
5
|
+
import type { TextWidgetProps, WidgetProps } from '../components/widgets/widget';
|
|
6
|
+
import type { WidgetModel } from '../components/widgets/widget-model';
|
|
4
7
|
/**
|
|
5
8
|
* Translates a {@link WidgetModel} to the parameters for executing a query for the widget.
|
|
6
9
|
*
|
package/package.json
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"Sisense",
|
|
12
12
|
"Compose SDK"
|
|
13
13
|
],
|
|
14
|
-
"version": "2.
|
|
14
|
+
"version": "2.35.0",
|
|
15
15
|
"type": "module",
|
|
16
16
|
"main": "./dist/index.cjs",
|
|
17
17
|
"module": "./dist/index.js",
|
|
@@ -72,8 +72,8 @@
|
|
|
72
72
|
"clean": "rm -rf ./dist && rm -rf ./coverage && rm -rf tsconfig.tsbuildinfo"
|
|
73
73
|
},
|
|
74
74
|
"dependencies": {
|
|
75
|
-
"@sisense/sdk-data": "2.
|
|
76
|
-
"@sisense/sdk-ui-preact": "2.
|
|
75
|
+
"@sisense/sdk-data": "2.35.0",
|
|
76
|
+
"@sisense/sdk-ui-preact": "2.35.0",
|
|
77
77
|
"lodash-es": "^4.17.21",
|
|
78
78
|
"ts-deepmerge": "^8.0.0",
|
|
79
79
|
"vue": "^3.3.2"
|