@sisense/sdk-ui-vue 2.31.1 → 2.33.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 +1 -1
- package/dist/ai.js +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.js +744 -493
- package/dist/src/components/charts/chart.d.ts +6 -6
- package/dist/src/components/charts/index.d.ts +1 -0
- package/dist/src/components/charts/sankey-chart.d.ts +178 -0
- package/dist/src/components/dashboard/dashboard-by-id.d.ts +1 -1
- package/dist/src/components/dashboard/dashboard-header-config.d.ts +87 -0
- package/dist/src/components/dashboard/dashboard.d.ts +6 -7
- package/dist/src/components/widgets/chart-widget.d.ts +18 -6
- package/dist/src/components/widgets/widget-by-id.d.ts +8 -8
- package/dist/src/components/widgets/widget.d.ts +14 -14
- package/dist/src/helpers/component-translator.d.ts +64 -0
- package/dist/src/helpers/dashboard-props-preact-translator.d.ts +33 -0
- package/dist/src/helpers/setup-helper.d.ts +10 -1
- package/dist/src/helpers/vue-component-adapter.d.ts +14 -7
- package/dist/src/sdk-ui-core-exports.d.ts +2 -1
- package/dist/src/utilities/dashboard-helpers.d.ts +5 -0
- package/dist/{use-tracking-1cbd274b.js → use-tracking-39f8225d.js} +29 -28
- package/dist/{use-tracking-94bc9fc5.cjs → use-tracking-bc372dcd.cjs} +1 -1
- package/package.json +3 -3
|
@@ -103,7 +103,7 @@ export declare const Chart: import("vue").DefineComponent<{
|
|
|
103
103
|
*
|
|
104
104
|
* @category Callbacks
|
|
105
105
|
*/
|
|
106
|
-
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
|
|
106
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | import("@sisense/sdk-ui-preact").KpiBeforeRenderHandler | undefined>;
|
|
107
107
|
/**
|
|
108
108
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataReady}
|
|
109
109
|
*
|
|
@@ -115,13 +115,13 @@ 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 | import("@sisense/sdk-ui-preact").IndicatorDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | 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 | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
119
119
|
/**
|
|
120
120
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenu}
|
|
121
121
|
*
|
|
122
122
|
* @category Callbacks
|
|
123
123
|
*/
|
|
124
|
-
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
|
|
124
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
125
125
|
/**
|
|
126
126
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointsSelected}
|
|
127
127
|
*
|
|
@@ -182,7 +182,7 @@ export declare const Chart: import("vue").DefineComponent<{
|
|
|
182
182
|
*
|
|
183
183
|
* @category Callbacks
|
|
184
184
|
*/
|
|
185
|
-
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
|
|
185
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | import("@sisense/sdk-ui-preact").KpiBeforeRenderHandler | undefined>;
|
|
186
186
|
/**
|
|
187
187
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataReady}
|
|
188
188
|
*
|
|
@@ -194,13 +194,13 @@ 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 | import("@sisense/sdk-ui-preact").IndicatorDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | 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 | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
198
198
|
/**
|
|
199
199
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenu}
|
|
200
200
|
*
|
|
201
201
|
* @category Callbacks
|
|
202
202
|
*/
|
|
203
|
-
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
|
|
203
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
204
204
|
/**
|
|
205
205
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointsSelected}
|
|
206
206
|
*
|
|
@@ -18,3 +18,4 @@ export { AreamapChart, type AreamapChartProps } from './areamap-chart';
|
|
|
18
18
|
export { ScattermapChart, type ScattermapChartProps } from './scattermap-chart';
|
|
19
19
|
export { StreamgraphChart, type StreamgraphChartProps } from './streamgraph-chart';
|
|
20
20
|
export { AreaRangeChart, type AreaRangeChartProps } from './area-range-chart';
|
|
21
|
+
export { SankeyChart, type SankeyChartProps } from './sankey-chart';
|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
import type { SankeyChartProps as SankeyChartPropsPreact } from '@sisense/sdk-ui-preact';
|
|
2
|
+
import type { PropType } from 'vue';
|
|
3
|
+
/**
|
|
4
|
+
* Props of the {@link @sisense/sdk-ui-vue!SankeyChart | `SankeyChart`} component.
|
|
5
|
+
*/
|
|
6
|
+
export interface SankeyChartProps extends SankeyChartPropsPreact {
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* A Vue component that visualizes flow and volume between nodes using a Sankey diagram.
|
|
10
|
+
*
|
|
11
|
+
* Node width represents the total flow through that node; link width represents the flow
|
|
12
|
+
* between two connected nodes.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* Here's how you can use the SankeyChart component in a Vue application:
|
|
16
|
+
* ```vue
|
|
17
|
+
* <template>
|
|
18
|
+
* <SankeyChart
|
|
19
|
+
* :dataOptions="sankeyChartProps.dataOptions"
|
|
20
|
+
* :dataSet="sankeyChartProps.dataSet"
|
|
21
|
+
* :styleOptions="sankeyChartProps.styleOptions"
|
|
22
|
+
* />
|
|
23
|
+
* </template>
|
|
24
|
+
*
|
|
25
|
+
* <script setup lang="ts">
|
|
26
|
+
* import { ref } from 'vue';
|
|
27
|
+
* import { measureFactory } from '@sisense/sdk-data';
|
|
28
|
+
* import * as DM from '../assets/sample-ecommerce';
|
|
29
|
+
* import { SankeyChart, type SankeyChartProps } from '@sisense/sdk-ui-vue';
|
|
30
|
+
*
|
|
31
|
+
* const sankeyChartProps = ref<SankeyChartProps>({
|
|
32
|
+
* dataSet: DM.DataSource,
|
|
33
|
+
* dataOptions: {
|
|
34
|
+
* category: [DM.Commerce.Gender, DM.Commerce.AgeRange],
|
|
35
|
+
* value: measureFactory.sum(DM.Commerce.Revenue, 'Revenue'),
|
|
36
|
+
* },
|
|
37
|
+
* styleOptions: {
|
|
38
|
+
* orientation: 'horizontal',
|
|
39
|
+
* nodeAlignment: 'top',
|
|
40
|
+
* },
|
|
41
|
+
* });
|
|
42
|
+
* </script>
|
|
43
|
+
* ```
|
|
44
|
+
* @param {SankeyChartProps} - Sankey chart properties
|
|
45
|
+
* @returns Sankey Chart component
|
|
46
|
+
* @group Charts
|
|
47
|
+
*/
|
|
48
|
+
export declare const SankeyChart: import("vue").DefineComponent<{
|
|
49
|
+
/**
|
|
50
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.dataOptions}
|
|
51
|
+
*
|
|
52
|
+
* @category Chart
|
|
53
|
+
*/
|
|
54
|
+
dataOptions: {
|
|
55
|
+
type: PropType<import("@sisense/sdk-ui-preact").SankeyChartDataOptions>;
|
|
56
|
+
required: true;
|
|
57
|
+
};
|
|
58
|
+
/**
|
|
59
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.dataSet}
|
|
60
|
+
*
|
|
61
|
+
* @category Data
|
|
62
|
+
*/
|
|
63
|
+
dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
|
|
64
|
+
/**
|
|
65
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.filters}
|
|
66
|
+
*
|
|
67
|
+
* @category Data
|
|
68
|
+
*/
|
|
69
|
+
filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
|
|
70
|
+
/**
|
|
71
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.highlights}
|
|
72
|
+
*
|
|
73
|
+
* @category Data
|
|
74
|
+
*/
|
|
75
|
+
highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
|
|
76
|
+
/**
|
|
77
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.styleOptions}
|
|
78
|
+
*
|
|
79
|
+
* @category Chart
|
|
80
|
+
*/
|
|
81
|
+
styleOptions: PropType<import("@sisense/sdk-ui-preact").SankeyStyleOptions | undefined>;
|
|
82
|
+
/**
|
|
83
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.onBeforeRender}
|
|
84
|
+
*
|
|
85
|
+
* @category Callbacks
|
|
86
|
+
*/
|
|
87
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
|
|
88
|
+
/**
|
|
89
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.onDataReady}
|
|
90
|
+
*
|
|
91
|
+
* @category Callbacks
|
|
92
|
+
*/
|
|
93
|
+
onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
|
|
94
|
+
/**
|
|
95
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.onDataPointClick}
|
|
96
|
+
*
|
|
97
|
+
* @category Callbacks
|
|
98
|
+
*/
|
|
99
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
|
|
100
|
+
/**
|
|
101
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.onDataPointContextMenu}
|
|
102
|
+
*
|
|
103
|
+
* @category Callbacks
|
|
104
|
+
*/
|
|
105
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
|
|
106
|
+
/**
|
|
107
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.onDataPointsSelected}
|
|
108
|
+
*
|
|
109
|
+
* @category Callbacks
|
|
110
|
+
*/
|
|
111
|
+
onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | undefined>;
|
|
112
|
+
}, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
113
|
+
[key: string]: any;
|
|
114
|
+
}>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
115
|
+
/**
|
|
116
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.dataOptions}
|
|
117
|
+
*
|
|
118
|
+
* @category Chart
|
|
119
|
+
*/
|
|
120
|
+
dataOptions: {
|
|
121
|
+
type: PropType<import("@sisense/sdk-ui-preact").SankeyChartDataOptions>;
|
|
122
|
+
required: true;
|
|
123
|
+
};
|
|
124
|
+
/**
|
|
125
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.dataSet}
|
|
126
|
+
*
|
|
127
|
+
* @category Data
|
|
128
|
+
*/
|
|
129
|
+
dataSet: PropType<import("@sisense/sdk-data").DataSource | import("@sisense/sdk-data").Data | undefined>;
|
|
130
|
+
/**
|
|
131
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.filters}
|
|
132
|
+
*
|
|
133
|
+
* @category Data
|
|
134
|
+
*/
|
|
135
|
+
filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
|
|
136
|
+
/**
|
|
137
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.highlights}
|
|
138
|
+
*
|
|
139
|
+
* @category Data
|
|
140
|
+
*/
|
|
141
|
+
highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
|
|
142
|
+
/**
|
|
143
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.styleOptions}
|
|
144
|
+
*
|
|
145
|
+
* @category Chart
|
|
146
|
+
*/
|
|
147
|
+
styleOptions: PropType<import("@sisense/sdk-ui-preact").SankeyStyleOptions | undefined>;
|
|
148
|
+
/**
|
|
149
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.onBeforeRender}
|
|
150
|
+
*
|
|
151
|
+
* @category Callbacks
|
|
152
|
+
*/
|
|
153
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
|
|
154
|
+
/**
|
|
155
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.onDataReady}
|
|
156
|
+
*
|
|
157
|
+
* @category Callbacks
|
|
158
|
+
*/
|
|
159
|
+
onDataReady: PropType<((data: import("@sisense/sdk-data").Data) => import("@sisense/sdk-data").Data) | undefined>;
|
|
160
|
+
/**
|
|
161
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.onDataPointClick}
|
|
162
|
+
*
|
|
163
|
+
* @category Callbacks
|
|
164
|
+
*/
|
|
165
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
|
|
166
|
+
/**
|
|
167
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.onDataPointContextMenu}
|
|
168
|
+
*
|
|
169
|
+
* @category Callbacks
|
|
170
|
+
*/
|
|
171
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | undefined>;
|
|
172
|
+
/**
|
|
173
|
+
* {@inheritDoc @sisense/sdk-ui!SankeyChartProps.onDataPointsSelected}
|
|
174
|
+
*
|
|
175
|
+
* @category Callbacks
|
|
176
|
+
*/
|
|
177
|
+
onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | undefined>;
|
|
178
|
+
}>>, {}, {}>;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { DashboardByIdConfig as DashboardByIdConfigPreact, DashboardByIdProps as DashboardByIdPropsPreact } from '@sisense/sdk-ui-preact';
|
|
2
2
|
import type { PropType } from 'vue';
|
|
3
|
-
import type
|
|
3
|
+
import { type DashboardHeaderConfig } from './dashboard-header-config';
|
|
4
4
|
/**
|
|
5
5
|
* Configuration for the {@link @sisense/sdk-ui-vue!DashboardById | `DashboardById`} component.
|
|
6
6
|
*/
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { type DashboardHeaderConfig as DashboardHeaderConfigPreact, type DashboardHeaderItemComponentProps, type DashboardHeaderItem as DashboardHeaderItemPreact } from '@sisense/sdk-ui-preact';
|
|
2
|
+
import type { Component, DefineComponent } from 'vue';
|
|
3
|
+
/**
|
|
4
|
+
* A Vue component that renders the content of a custom dashboard header item.
|
|
5
|
+
* This can be a Vue component options object, a `defineComponent` result, or any valid Vue component.
|
|
6
|
+
*
|
|
7
|
+
* The item size resolved by the header layout is provided via the `size` prop.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* A Vue header item component rendering an export button that uses its resolved size:
|
|
11
|
+
* ```vue
|
|
12
|
+
* <script setup lang="ts">
|
|
13
|
+
* import { type DashboardHeaderItemComponentProps } from '@sisense/sdk-ui-vue';
|
|
14
|
+
*
|
|
15
|
+
* const props = defineProps<DashboardHeaderItemComponentProps>();
|
|
16
|
+
*
|
|
17
|
+
* const onExport = () => {
|
|
18
|
+
* // trigger the export
|
|
19
|
+
* };
|
|
20
|
+
* </script>
|
|
21
|
+
* <template>
|
|
22
|
+
* <button :style="{ height: props.size.height + 'px' }" @click="onExport">Export</button>
|
|
23
|
+
* </template>
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
export type DashboardHeaderItemComponent = Component<DashboardHeaderItemComponentProps> | DefineComponent<DashboardHeaderItemComponentProps>;
|
|
27
|
+
/**
|
|
28
|
+
* A custom item to inject into the dashboard header.
|
|
29
|
+
*/
|
|
30
|
+
export interface DashboardHeaderItem extends Omit<DashboardHeaderItemPreact, 'component'> {
|
|
31
|
+
/**
|
|
32
|
+
* Vue component that renders the content of the item.
|
|
33
|
+
*/
|
|
34
|
+
component: DashboardHeaderItemComponent;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* A dashboard header item after the built-in and custom items have been ordered (position applied).
|
|
38
|
+
*
|
|
39
|
+
* This is the shape passed to {@link DashboardHeaderConfig.onBeforeRender}.
|
|
40
|
+
*
|
|
41
|
+
* For custom items, `component` is the same Vue component that was registered in
|
|
42
|
+
* {@link DashboardHeaderConfig.items}, so items can be matched by component identity as well as by
|
|
43
|
+
* `id`. For built-in items, `component` is an opaque handle to an internal renderer: reorder, keep,
|
|
44
|
+
* or remove such an item, but do not invoke or replace its component.
|
|
45
|
+
*/
|
|
46
|
+
export type DashboardResolvedHeaderItem = Omit<DashboardHeaderItem, 'position'>;
|
|
47
|
+
/**
|
|
48
|
+
* Transforms the fully ordered list of dashboard header items right before rendering.
|
|
49
|
+
*/
|
|
50
|
+
export type DashboardHeaderItemsTransform = (items: ReadonlyArray<DashboardResolvedHeaderItem>) => DashboardResolvedHeaderItem[];
|
|
51
|
+
/**
|
|
52
|
+
* Configuration for the dashboard header.
|
|
53
|
+
*
|
|
54
|
+
* Injects custom {@link DashboardHeaderItem | items} into the header and, via
|
|
55
|
+
* {@link DashboardHeaderConfig.onBeforeRender | `onBeforeRender`}, reorders or removes the
|
|
56
|
+
* built-in items (referenced by {@link DashboardHeaderTargets}).
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* Add a custom item after the title and hide the built-in title:
|
|
60
|
+
* ```ts
|
|
61
|
+
* import { DashboardHeaderTargets, type DashboardConfig } from '@sisense/sdk-ui-vue';
|
|
62
|
+
* import ExportButton from './export-button.vue';
|
|
63
|
+
*
|
|
64
|
+
* const config: DashboardConfig = {
|
|
65
|
+
* header: {
|
|
66
|
+
* items: [
|
|
67
|
+
* {
|
|
68
|
+
* id: 'export',
|
|
69
|
+
* component: ExportButton,
|
|
70
|
+
* position: { type: 'after', target: DashboardHeaderTargets.Title },
|
|
71
|
+
* },
|
|
72
|
+
* ],
|
|
73
|
+
* onBeforeRender: (items) => items.filter((item) => item.id !== DashboardHeaderTargets.Title),
|
|
74
|
+
* },
|
|
75
|
+
* };
|
|
76
|
+
* ```
|
|
77
|
+
*/
|
|
78
|
+
export interface DashboardHeaderConfig extends Omit<DashboardHeaderConfigPreact, 'items' | 'onBeforeRender'> {
|
|
79
|
+
/**
|
|
80
|
+
* {@inheritDoc @sisense/sdk-ui!DashboardHeaderConfig.items}
|
|
81
|
+
*/
|
|
82
|
+
items?: DashboardHeaderItem[];
|
|
83
|
+
/**
|
|
84
|
+
* {@inheritDoc @sisense/sdk-ui!DashboardHeaderConfig.onBeforeRender}
|
|
85
|
+
*/
|
|
86
|
+
onBeforeRender?: DashboardHeaderItemsTransform;
|
|
87
|
+
}
|
|
@@ -1,12 +1,11 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { DashboardHeaderTargets } from '@sisense/sdk-ui-preact';
|
|
2
|
+
import type { DashboardConfig as DashboardConfigPreact, DashboardFiltersPanelConfig, DashboardHeaderItemComponentProps, DashboardHeaderItemPosition, DashboardHeaderItemSize, DashboardHeaderTarget, DashboardProps as DashboardPropsPreact } from '@sisense/sdk-ui-preact';
|
|
2
3
|
import type { PropType } from 'vue';
|
|
3
4
|
import type { WidgetProps } from '../widgets';
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
export interface DashboardHeaderConfig extends Omit<DashboardHeaderConfigPreact, 'items' | 'onBeforeRender'> {
|
|
9
|
-
}
|
|
5
|
+
import { type DashboardHeaderConfig } from './dashboard-header-config';
|
|
6
|
+
export { DashboardHeaderTargets };
|
|
7
|
+
export type { DashboardFiltersPanelConfig, DashboardHeaderItemComponentProps, DashboardHeaderItemPosition, DashboardHeaderItemSize, DashboardHeaderTarget, };
|
|
8
|
+
export type { DashboardHeaderConfig, DashboardHeaderItem, DashboardHeaderItemComponent, DashboardHeaderItemsTransform, DashboardResolvedHeaderItem, } from './dashboard-header-config';
|
|
10
9
|
/**
|
|
11
10
|
* Configuration for the {@link @sisense/sdk-ui-vue!Dashboard | `Dashboard`} component.
|
|
12
11
|
*/
|
|
@@ -126,19 +126,19 @@ export declare const ChartWidget: import("vue").DefineComponent<{
|
|
|
126
126
|
*
|
|
127
127
|
* @category Callbacks
|
|
128
128
|
*/
|
|
129
|
-
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
|
|
129
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | import("@sisense/sdk-ui-preact").KpiBeforeRenderHandler | undefined>;
|
|
130
130
|
/**
|
|
131
131
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointClick}
|
|
132
132
|
*
|
|
133
133
|
* @category Callbacks
|
|
134
134
|
*/
|
|
135
|
-
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 | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
|
|
135
|
+
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 | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
136
136
|
/**
|
|
137
137
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenu}
|
|
138
138
|
*
|
|
139
139
|
* @category Callbacks
|
|
140
140
|
*/
|
|
141
|
-
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
|
|
141
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
142
142
|
/**
|
|
143
143
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointsSelected}
|
|
144
144
|
*
|
|
@@ -157,6 +157,12 @@ export declare const ChartWidget: import("vue").DefineComponent<{
|
|
|
157
157
|
* @category Widget
|
|
158
158
|
*/
|
|
159
159
|
config: PropType<import("@sisense/sdk-ui-preact").WidgetConfig | undefined>;
|
|
160
|
+
/**
|
|
161
|
+
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.id}
|
|
162
|
+
*
|
|
163
|
+
* @category Widget
|
|
164
|
+
*/
|
|
165
|
+
id: PropType<string | undefined>;
|
|
160
166
|
/**
|
|
161
167
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.title}
|
|
162
168
|
*
|
|
@@ -252,19 +258,19 @@ export declare const ChartWidget: import("vue").DefineComponent<{
|
|
|
252
258
|
*
|
|
253
259
|
* @category Callbacks
|
|
254
260
|
*/
|
|
255
|
-
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
|
|
261
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | import("@sisense/sdk-ui-preact").KpiBeforeRenderHandler | undefined>;
|
|
256
262
|
/**
|
|
257
263
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointClick}
|
|
258
264
|
*
|
|
259
265
|
* @category Callbacks
|
|
260
266
|
*/
|
|
261
|
-
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 | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
|
|
267
|
+
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 | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
262
268
|
/**
|
|
263
269
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenu}
|
|
264
270
|
*
|
|
265
271
|
* @category Callbacks
|
|
266
272
|
*/
|
|
267
|
-
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
|
|
273
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
268
274
|
/**
|
|
269
275
|
* {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointsSelected}
|
|
270
276
|
*
|
|
@@ -283,6 +289,12 @@ export declare const ChartWidget: import("vue").DefineComponent<{
|
|
|
283
289
|
* @category Widget
|
|
284
290
|
*/
|
|
285
291
|
config: PropType<import("@sisense/sdk-ui-preact").WidgetConfig | undefined>;
|
|
292
|
+
/**
|
|
293
|
+
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.id}
|
|
294
|
+
*
|
|
295
|
+
* @category Widget
|
|
296
|
+
*/
|
|
297
|
+
id: PropType<string | undefined>;
|
|
286
298
|
/**
|
|
287
299
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.title}
|
|
288
300
|
*
|
|
@@ -50,7 +50,7 @@ export declare const WidgetById: import("vue").DefineComponent<{
|
|
|
50
50
|
*/
|
|
51
51
|
description: PropType<string | undefined>;
|
|
52
52
|
/** @internal */
|
|
53
|
-
drilldownOptions: PropType<import("@sisense/sdk-ui-preact").
|
|
53
|
+
drilldownOptions: PropType<import("@sisense/sdk-ui-preact").DrilldownOptions | import("@sisense/sdk-ui-preact").PivotTableDrilldownOptions | undefined>;
|
|
54
54
|
/**
|
|
55
55
|
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.filters}
|
|
56
56
|
*
|
|
@@ -86,19 +86,19 @@ export declare const WidgetById: import("vue").DefineComponent<{
|
|
|
86
86
|
*
|
|
87
87
|
* @category Callbacks
|
|
88
88
|
*/
|
|
89
|
-
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
|
|
89
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | import("@sisense/sdk-ui-preact").KpiBeforeRenderHandler | undefined>;
|
|
90
90
|
/**
|
|
91
91
|
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointClick}
|
|
92
92
|
*
|
|
93
93
|
* @category Callbacks
|
|
94
94
|
*/
|
|
95
|
-
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 | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
|
|
95
|
+
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 | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
96
96
|
/**
|
|
97
97
|
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointContextMenu}
|
|
98
98
|
*
|
|
99
99
|
* @category Callbacks
|
|
100
100
|
*/
|
|
101
|
-
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
|
|
101
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
102
102
|
/**
|
|
103
103
|
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointsSelected}
|
|
104
104
|
*
|
|
@@ -157,7 +157,7 @@ export declare const WidgetById: import("vue").DefineComponent<{
|
|
|
157
157
|
*/
|
|
158
158
|
description: PropType<string | undefined>;
|
|
159
159
|
/** @internal */
|
|
160
|
-
drilldownOptions: PropType<import("@sisense/sdk-ui-preact").
|
|
160
|
+
drilldownOptions: PropType<import("@sisense/sdk-ui-preact").DrilldownOptions | import("@sisense/sdk-ui-preact").PivotTableDrilldownOptions | undefined>;
|
|
161
161
|
/**
|
|
162
162
|
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.filters}
|
|
163
163
|
*
|
|
@@ -193,19 +193,19 @@ export declare const WidgetById: import("vue").DefineComponent<{
|
|
|
193
193
|
*
|
|
194
194
|
* @category Callbacks
|
|
195
195
|
*/
|
|
196
|
-
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
|
|
196
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | import("@sisense/sdk-ui-preact").KpiBeforeRenderHandler | undefined>;
|
|
197
197
|
/**
|
|
198
198
|
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointClick}
|
|
199
199
|
*
|
|
200
200
|
* @category Callbacks
|
|
201
201
|
*/
|
|
202
|
-
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 | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
|
|
202
|
+
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 | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
203
203
|
/**
|
|
204
204
|
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointContextMenu}
|
|
205
205
|
*
|
|
206
206
|
* @category Callbacks
|
|
207
207
|
*/
|
|
208
|
-
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
|
|
208
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | undefined>;
|
|
209
209
|
/**
|
|
210
210
|
* {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointsSelected}
|
|
211
211
|
*
|
|
@@ -63,7 +63,7 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
|
63
63
|
* @category Widget
|
|
64
64
|
*/
|
|
65
65
|
widgetType: {
|
|
66
|
-
type: PropType<"filter" | "
|
|
66
|
+
type: PropType<"filter" | "text" | "custom" | "chart" | "pivot">;
|
|
67
67
|
required: true;
|
|
68
68
|
};
|
|
69
69
|
/**
|
|
@@ -89,7 +89,7 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
|
89
89
|
*
|
|
90
90
|
* @category Chart
|
|
91
91
|
*/
|
|
92
|
-
dataOptions: PropType<import("@sisense/sdk-ui-preact").
|
|
92
|
+
dataOptions: PropType<import("@sisense/sdk-ui-preact").GenericDataOptions | import("@sisense/sdk-ui-preact").ChartDataOptions | import("@sisense/sdk-ui-preact").PivotTableDataOptions | undefined>;
|
|
93
93
|
/**
|
|
94
94
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.filters}
|
|
95
95
|
*
|
|
@@ -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").
|
|
110
|
+
styleOptions: PropType<import("@sisense/sdk-ui-preact").WidgetContainerStyleOptions | import("@sisense/sdk-ui-preact").CustomWidgetStyleOptions | import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | import("@sisense/sdk-ui-preact").PivotTableWidgetStyleOptions | import("@sisense/sdk-ui-preact").TextWidgetStyleOptions | undefined>;
|
|
111
111
|
/**
|
|
112
112
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.config}
|
|
113
113
|
*
|
|
@@ -126,7 +126,7 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
|
126
126
|
*
|
|
127
127
|
* @category Widget
|
|
128
128
|
*/
|
|
129
|
-
drilldownOptions: PropType<import("@sisense/sdk-ui-preact").
|
|
129
|
+
drilldownOptions: PropType<import("@sisense/sdk-ui-preact").DrilldownOptions | import("@sisense/sdk-ui-preact").PivotTableDrilldownOptions | undefined>;
|
|
130
130
|
/**
|
|
131
131
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.title}
|
|
132
132
|
*
|
|
@@ -151,7 +151,7 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
|
151
151
|
*
|
|
152
152
|
* @category Callbacks
|
|
153
153
|
*/
|
|
154
|
-
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
|
|
154
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | import("@sisense/sdk-ui-preact").KpiBeforeRenderHandler | undefined>;
|
|
155
155
|
/**
|
|
156
156
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataReady}
|
|
157
157
|
*
|
|
@@ -170,13 +170,13 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
|
170
170
|
*
|
|
171
171
|
* @category Callbacks
|
|
172
172
|
*/
|
|
173
|
-
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").
|
|
173
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").CustomWidgetDataPointEventHandler<import("@sisense/sdk-ui-preact").AbstractDataPointWithEntries> | 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 | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | import("@sisense/sdk-ui-preact").PivotTableDataPointEventHandler | import("@sisense/sdk-ui-preact").TextWidgetDataPointEventHandler | undefined>;
|
|
174
174
|
/**
|
|
175
175
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointContextMenu}
|
|
176
176
|
*
|
|
177
177
|
* @category Callbacks
|
|
178
178
|
*/
|
|
179
|
-
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").
|
|
179
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").CustomWidgetDataPointContextMenuHandler<import("@sisense/sdk-ui-preact").AbstractDataPointWithEntries> | import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | import("@sisense/sdk-ui-preact").PivotTableDataPointEventHandler | undefined>;
|
|
180
180
|
/**
|
|
181
181
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointsSelected}
|
|
182
182
|
*
|
|
@@ -201,7 +201,7 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
|
201
201
|
* @category Widget
|
|
202
202
|
*/
|
|
203
203
|
widgetType: {
|
|
204
|
-
type: PropType<"filter" | "
|
|
204
|
+
type: PropType<"filter" | "text" | "custom" | "chart" | "pivot">;
|
|
205
205
|
required: true;
|
|
206
206
|
};
|
|
207
207
|
/**
|
|
@@ -227,7 +227,7 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
|
227
227
|
*
|
|
228
228
|
* @category Chart
|
|
229
229
|
*/
|
|
230
|
-
dataOptions: PropType<import("@sisense/sdk-ui-preact").
|
|
230
|
+
dataOptions: PropType<import("@sisense/sdk-ui-preact").GenericDataOptions | import("@sisense/sdk-ui-preact").ChartDataOptions | import("@sisense/sdk-ui-preact").PivotTableDataOptions | undefined>;
|
|
231
231
|
/**
|
|
232
232
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.filters}
|
|
233
233
|
*
|
|
@@ -245,7 +245,7 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
|
245
245
|
*
|
|
246
246
|
* @category Widget
|
|
247
247
|
*/
|
|
248
|
-
styleOptions: PropType<import("@sisense/sdk-ui-preact").
|
|
248
|
+
styleOptions: PropType<import("@sisense/sdk-ui-preact").WidgetContainerStyleOptions | import("@sisense/sdk-ui-preact").CustomWidgetStyleOptions | import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | import("@sisense/sdk-ui-preact").PivotTableWidgetStyleOptions | import("@sisense/sdk-ui-preact").TextWidgetStyleOptions | undefined>;
|
|
249
249
|
/**
|
|
250
250
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.config}
|
|
251
251
|
*
|
|
@@ -264,7 +264,7 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
|
264
264
|
*
|
|
265
265
|
* @category Widget
|
|
266
266
|
*/
|
|
267
|
-
drilldownOptions: PropType<import("@sisense/sdk-ui-preact").
|
|
267
|
+
drilldownOptions: PropType<import("@sisense/sdk-ui-preact").DrilldownOptions | import("@sisense/sdk-ui-preact").PivotTableDrilldownOptions | undefined>;
|
|
268
268
|
/**
|
|
269
269
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.title}
|
|
270
270
|
*
|
|
@@ -289,7 +289,7 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
|
289
289
|
*
|
|
290
290
|
* @category Callbacks
|
|
291
291
|
*/
|
|
292
|
-
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
|
|
292
|
+
onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | import("@sisense/sdk-ui-preact").KpiBeforeRenderHandler | undefined>;
|
|
293
293
|
/**
|
|
294
294
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataReady}
|
|
295
295
|
*
|
|
@@ -308,13 +308,13 @@ export declare const Widget: import("vue").DefineComponent<{
|
|
|
308
308
|
*
|
|
309
309
|
* @category Callbacks
|
|
310
310
|
*/
|
|
311
|
-
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").
|
|
311
|
+
onDataPointClick: PropType<import("@sisense/sdk-ui-preact").CustomWidgetDataPointEventHandler<import("@sisense/sdk-ui-preact").AbstractDataPointWithEntries> | 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 | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | import("@sisense/sdk-ui-preact").PivotTableDataPointEventHandler | import("@sisense/sdk-ui-preact").TextWidgetDataPointEventHandler | undefined>;
|
|
312
312
|
/**
|
|
313
313
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointContextMenu}
|
|
314
314
|
*
|
|
315
315
|
* @category Callbacks
|
|
316
316
|
*/
|
|
317
|
-
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").
|
|
317
|
+
onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").CustomWidgetDataPointContextMenuHandler<import("@sisense/sdk-ui-preact").AbstractDataPointWithEntries> | import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").KpiDataPointEventHandler | import("@sisense/sdk-ui-preact").PivotTableDataPointEventHandler | undefined>;
|
|
318
318
|
/**
|
|
319
319
|
* {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointsSelected}
|
|
320
320
|
*
|