@progress/kendo-react-pivotgrid 7.2.4-develop.3 → 7.2.4-develop.4
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/PivotGrid.js +8 -0
- package/PivotGrid.mjs +252 -0
- package/components/AxesEditor.js +8 -0
- package/components/AxesEditor.mjs +43 -0
- package/components/AxisEditor.js +8 -0
- package/components/AxisEditor.mjs +108 -0
- package/components/AxisFilterFieldsEditor.js +8 -0
- package/components/AxisFilterFieldsEditor.mjs +159 -0
- package/components/Cell.js +8 -0
- package/components/Cell.mjs +45 -0
- package/components/Column.js +8 -0
- package/components/Column.mjs +40 -0
- package/components/Configurator.js +8 -0
- package/components/Configurator.mjs +134 -0
- package/components/ConfiguratorButton.js +8 -0
- package/components/ConfiguratorButton.mjs +42 -0
- package/components/ConfiguratorEditor.js +8 -0
- package/components/ConfiguratorEditor.mjs +240 -0
- package/components/Container.js +8 -0
- package/components/Container.mjs +40 -0
- package/components/EditorContext.js +8 -0
- package/components/EditorContext.mjs +13 -0
- package/components/FieldsEditor.js +8 -0
- package/components/FieldsEditor.mjs +78 -0
- package/components/HeaderCell.js +8 -0
- package/components/HeaderCell.mjs +69 -0
- package/components/Row.js +8 -0
- package/components/Row.mjs +42 -0
- package/dist/cdn/js/kendo-react-pivotgrid.js +8 -5
- package/hooks/useExpansion.js +8 -0
- package/hooks/useExpansion.mjs +46 -0
- package/hooks/useHeaders.js +8 -0
- package/hooks/useHeaders.mjs +18 -0
- package/hooks/useHorizontalScrollSync.js +8 -0
- package/hooks/useHorizontalScrollSync.mjs +25 -0
- package/hooks/usePivotConfiguratorEditor.js +8 -0
- package/hooks/usePivotConfiguratorEditor.mjs +67 -0
- package/hooks/usePivotLocalDataService.js +8 -0
- package/hooks/usePivotLocalDataService.mjs +94 -0
- package/hooks/usePivotOLAPService.js +8 -0
- package/hooks/usePivotOLAPService.mjs +230 -0
- package/hooks/useVerticalScrollSync.js +8 -0
- package/hooks/useVerticalScrollSync.mjs +25 -0
- package/index.d.mts +1342 -5
- package/index.d.ts +1342 -22
- package/index.js +8 -5
- package/index.mjs +46 -1583
- package/messages/index.js +8 -0
- package/messages/index.mjs +39 -0
- package/package-metadata.js +8 -0
- package/package-metadata.mjs +19 -0
- package/package.json +9 -9
- package/shared/PivotGridConfiguratorEditorEventsContext.js +8 -0
- package/shared/PivotGridConfiguratorEditorEventsContext.mjs +13 -0
- package/shared/PivotGridConfiguratorEditorStateContext.js +8 -0
- package/shared/PivotGridConfiguratorEditorStateContext.mjs +28 -0
- package/utils/index.js +8 -0
- package/utils/index.mjs +59 -0
- package/PivotGrid.d.ts +0 -181
- package/components/AxesEditor.d.ts +0 -44
- package/components/AxisEditor.d.ts +0 -56
- package/components/AxisFilterFieldsEditor.d.ts +0 -118
- package/components/Cell.d.ts +0 -69
- package/components/Column.d.ts +0 -46
- package/components/Configurator.d.ts +0 -129
- package/components/ConfiguratorButton.d.ts +0 -44
- package/components/ConfiguratorEditor.d.ts +0 -130
- package/components/Container.d.ts +0 -50
- package/components/EditorContext.d.ts +0 -11
- package/components/FieldsEditor.d.ts +0 -78
- package/components/HeaderCell.d.ts +0 -100
- package/components/Row.d.ts +0 -54
- package/hooks/index.d.ts +0 -6
- package/hooks/useExpansion.d.ts +0 -23
- package/hooks/useHeaders.d.ts +0 -16
- package/hooks/useHorizontalScrollSync.d.ts +0 -9
- package/hooks/usePivotConfiguratorEditor.d.ts +0 -87
- package/hooks/usePivotLocalDataService.d.ts +0 -83
- package/hooks/usePivotOLAPService.d.ts +0 -45
- package/hooks/useVerticalScrollSync.d.ts +0 -9
- package/messages/index.d.ts +0 -74
- package/models/index.d.ts +0 -48
- package/package-metadata.d.ts +0 -9
- package/shared/PivotGridConfiguratorEditorEventsContext.d.ts +0 -17
- package/shared/PivotGridConfiguratorEditorStateContext.d.ts +0 -10
- package/shared/index.d.ts +0 -6
- package/utils/index.d.ts +0 -51
package/index.d.ts
CHANGED
|
@@ -1,22 +1,1342 @@
|
|
|
1
|
-
|
|
2
|
-
*
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2024 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
import { Aggregate } from '@progress/kendo-pivotgrid-common';
|
|
9
|
+
import { averageAggregate } from '@progress/kendo-pivotgrid-common';
|
|
10
|
+
import { AxisDataItem } from '@progress/kendo-pivotgrid-common';
|
|
11
|
+
import { AxisRow } from '@progress/kendo-pivotgrid-common';
|
|
12
|
+
import { ButtonProps } from '@progress/kendo-react-buttons';
|
|
13
|
+
import { ChipListProps } from '@progress/kendo-react-buttons';
|
|
14
|
+
import { ChipProps } from '@progress/kendo-react-buttons';
|
|
15
|
+
import { ColumnMenuFormProps } from '@progress/kendo-react-data-tools';
|
|
16
|
+
import { ColumnMenuItemProps } from '@progress/kendo-react-data-tools';
|
|
17
|
+
import { ColumnMenuProps } from '@progress/kendo-react-data-tools';
|
|
18
|
+
import { CustomComponent } from '@progress/kendo-react-common';
|
|
19
|
+
import { Dimension } from '@progress/kendo-pivotgrid-common';
|
|
20
|
+
import { DimensionField } from '@progress/kendo-pivotgrid-common';
|
|
21
|
+
import { FieldProps } from '@progress/kendo-react-form';
|
|
22
|
+
import { FilterDescriptor } from '@progress/kendo-data-query';
|
|
23
|
+
import { FormElementProps } from '@progress/kendo-react-form';
|
|
24
|
+
import { FormProps } from '@progress/kendo-react-form';
|
|
25
|
+
import { FormRenderProps } from '@progress/kendo-react-form';
|
|
26
|
+
import { HierarchyField } from '@progress/kendo-pivotgrid-common';
|
|
27
|
+
import { IconProps } from '@progress/kendo-react-common';
|
|
28
|
+
import { KendoMouse } from '@progress/kendo-react-common';
|
|
29
|
+
import { KendoMouseEvent } from '@progress/kendo-react-common';
|
|
30
|
+
import { KPIField } from '@progress/kendo-pivotgrid-common';
|
|
31
|
+
import { KPIMeasureField } from '@progress/kendo-pivotgrid-common';
|
|
32
|
+
import { LabelProps } from '@progress/kendo-react-labels';
|
|
33
|
+
import { LevelField } from '@progress/kendo-pivotgrid-common';
|
|
34
|
+
import { maxAggregate } from '@progress/kendo-pivotgrid-common';
|
|
35
|
+
import { Measure } from '@progress/kendo-pivotgrid-common';
|
|
36
|
+
import { MeasureField } from '@progress/kendo-pivotgrid-common';
|
|
37
|
+
import { Member } from '@progress/kendo-pivotgrid-common';
|
|
38
|
+
import { MemberField } from '@progress/kendo-pivotgrid-common';
|
|
39
|
+
import { minAggregate } from '@progress/kendo-pivotgrid-common';
|
|
40
|
+
import { PIVOT_CONFIGURATOR_ACTION } from '@progress/kendo-pivotgrid-common';
|
|
41
|
+
import { PivotDataItem } from '@progress/kendo-pivotgrid-common';
|
|
42
|
+
import { PivotGridAxis } from '@progress/kendo-pivotgrid-common';
|
|
43
|
+
import { PivotGridConfiguratorState } from '@progress/kendo-pivotgrid-common';
|
|
44
|
+
import { PivotGridField } from '@progress/kendo-pivotgrid-common';
|
|
45
|
+
import * as React_2 from 'react';
|
|
46
|
+
import { SortDescriptor } from '@progress/kendo-data-query';
|
|
47
|
+
import { sumAggregate } from '@progress/kendo-pivotgrid-common';
|
|
48
|
+
import { SvgIconProps } from '@progress/kendo-react-common';
|
|
49
|
+
import { TreeViewProps } from '@progress/kendo-react-treeview';
|
|
50
|
+
import { Tuple } from '@progress/kendo-pivotgrid-common';
|
|
51
|
+
|
|
52
|
+
export { Aggregate }
|
|
53
|
+
|
|
54
|
+
export { averageAggregate }
|
|
55
|
+
|
|
56
|
+
export { AxisDataItem }
|
|
57
|
+
|
|
58
|
+
export { AxisRow }
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Generates suitable data for Charting visualization.
|
|
62
|
+
*
|
|
63
|
+
* @param rows - The PivotGrid's rows prop.
|
|
64
|
+
* @param columns - The PivotGrid's columns prop.
|
|
65
|
+
* @param data - The PivotGrid's data prop.
|
|
66
|
+
* @returns - Suitable data for Charting visualization.
|
|
67
|
+
*/
|
|
68
|
+
export declare const dataCells: (rows?: Tuple[], columns?: Tuple[], data?: PivotDataItem[]) => {
|
|
69
|
+
row: string[];
|
|
70
|
+
cells: PivotDataItem[];
|
|
71
|
+
}[];
|
|
72
|
+
|
|
73
|
+
export { Dimension }
|
|
74
|
+
|
|
75
|
+
export { DimensionField }
|
|
76
|
+
|
|
77
|
+
declare enum EXTENDED_CONFIGURATOR_ACTION {
|
|
78
|
+
toggleExpansion = "PIVOT_CONFIGURATOR_ACTION_TOGGLE_EXPANSION"
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
export { HierarchyField }
|
|
82
|
+
|
|
83
|
+
export { KPIField }
|
|
84
|
+
|
|
85
|
+
export { KPIMeasureField }
|
|
86
|
+
|
|
87
|
+
export { LevelField }
|
|
88
|
+
|
|
89
|
+
export { maxAggregate }
|
|
90
|
+
|
|
91
|
+
export { Measure }
|
|
92
|
+
|
|
93
|
+
export { MeasureField }
|
|
94
|
+
|
|
95
|
+
export { Member }
|
|
96
|
+
|
|
97
|
+
export { MemberField }
|
|
98
|
+
|
|
99
|
+
export { minAggregate }
|
|
100
|
+
|
|
101
|
+
declare type PIVOT_CONFIGURATOR_ACTION_TYPE = PIVOT_CONFIGURATOR_ACTION | EXTENDED_CONFIGURATOR_ACTION;
|
|
102
|
+
|
|
103
|
+
export { PivotDataItem }
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* Represents the [KendoReact PivotGrid component]({% slug api_pivotgrid_pivotgridprops %}).
|
|
107
|
+
*/
|
|
108
|
+
export declare const PivotGrid: React_2.ForwardRefExoticComponent<PivotGridProps & React_2.RefAttributes<PivotGridHandle | null>>;
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* Represents the event arguments of the [`onColumnAxesChange`]({% slug api_pivotgrid_pivotgridprops %}#toc-oncolumnaxeschange) and [`onRowAxesChange`]({% slug api_pivotgrid_pivotgridprops %}#toc-onrowaxeschange) callbacks of the [`PivotGrid`]({% slug api_pivotgrid_pivotgrid %}) component.
|
|
112
|
+
*/
|
|
113
|
+
export declare interface PivotGridAxesChangeEvent {
|
|
114
|
+
value: PivotGridAxis[];
|
|
115
|
+
target: PivotGridHandle | null;
|
|
116
|
+
syntheticEvent: React.SyntheticEvent;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
/**
|
|
120
|
+
* Represents the [KendoReact PivotGridAxesEditor component]({% slug api_pivotgrid_pivotgridaxeseditorprops %}).
|
|
121
|
+
*/
|
|
122
|
+
export declare const PivotGridAxesEditor: React_2.ForwardRefExoticComponent<Omit<PivotGridAxesEditorProps, "ref"> & React_2.RefAttributes<PivotGridAxesEditorHandle | null>>;
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* Represents the object which is passed to the [`ref`](https://reactjs.org/docs/refs-and-the-dom.html) callback of the PivotGridAxesEditor component.
|
|
126
|
+
*/
|
|
127
|
+
export declare interface PivotGridAxesEditorHandle {
|
|
128
|
+
props: PivotGridAxesEditorProps;
|
|
129
|
+
element: HTMLDivElement | null;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* Represents the props of the [KendoReact PivotGridAxesEditor component]({% slug api_pivotgrid_pivotgridaxeseditor %}).
|
|
134
|
+
*/
|
|
135
|
+
export declare interface PivotGridAxesEditorProps extends FieldProps {
|
|
136
|
+
/**
|
|
137
|
+
* Represents the `value` of the AxesEditor.
|
|
138
|
+
*
|
|
139
|
+
* The `value` is an array of [PivotGridAxis]({% slug api_pivotgrid_pivotgridaxis %})
|
|
140
|
+
*/
|
|
141
|
+
value: PivotGridAxis[];
|
|
142
|
+
/**
|
|
143
|
+
* Indicates which of the three available axes are represented by the editor:
|
|
144
|
+
* - columnAxes
|
|
145
|
+
* - rowAxes
|
|
146
|
+
* - measureAxes
|
|
147
|
+
*/
|
|
148
|
+
field: string;
|
|
149
|
+
/**
|
|
150
|
+
* Overrides the default `chipList` component.
|
|
151
|
+
*
|
|
152
|
+
* The default component is: [KendoReactChipList]({% slug api_buttons_chiplist %}).
|
|
153
|
+
*/
|
|
154
|
+
chipList?: CustomComponent<ChipListProps>;
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
export { PivotGridAxis }
|
|
158
|
+
|
|
159
|
+
/**
|
|
160
|
+
* Represents the [KendoReact PivotGridAxisEditor component]({% slug api_pivotgrid_pivotgridaxiseditorprops %}).
|
|
161
|
+
*/
|
|
162
|
+
export declare const PivotGridAxisEditor: React_2.ForwardRefExoticComponent<PivotGridAxisEditorProps & React_2.RefAttributes<PivotGridAxisEditorHandle | null>>;
|
|
163
|
+
|
|
164
|
+
/**
|
|
165
|
+
* Represents the object which is passed to the [`ref`](https://reactjs.org/docs/refs-and-the-dom.html) callback of the PivotGridAxisEditor component.
|
|
166
|
+
*/
|
|
167
|
+
export declare interface PivotGridAxisEditorHandle {
|
|
168
|
+
props: PivotGridAxisEditorProps;
|
|
169
|
+
element: HTMLSpanElement | null;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* Represents the props of the [KendoReact PivotGridAxisEditor component]({% slug api_pivotgrid_pivotgridaxiseditor %}).
|
|
174
|
+
*/
|
|
175
|
+
export declare interface PivotGridAxisEditorProps extends ChipProps {
|
|
176
|
+
/**
|
|
177
|
+
* Represents the `dataItem` of the AxisEditor.
|
|
178
|
+
*
|
|
179
|
+
* The `dataItem` is a single [PivotGridAxis]({% slug api_pivotgrid_pivotgridaxis %}) object.
|
|
180
|
+
*/
|
|
181
|
+
dataItem: PivotGridAxis;
|
|
182
|
+
/**
|
|
183
|
+
* Overrides the default `chip` component.
|
|
184
|
+
*
|
|
185
|
+
* The default component is: [KendoReactChip]({% slug api_buttons_chip %}).
|
|
186
|
+
*/
|
|
187
|
+
chip?: CustomComponent<ChipProps>;
|
|
188
|
+
/**
|
|
189
|
+
* Overrides the default `dropClue` component.
|
|
190
|
+
*
|
|
191
|
+
* The default component is: `(props) => <div className="k-grouping-dropclue" style={{ position: 'relative', zIndex: 10000 }} {...props}/>`
|
|
192
|
+
*/
|
|
193
|
+
dropClue?: CustomComponent<any>;
|
|
194
|
+
/**
|
|
195
|
+
* Overrides the default `columnMenuTextColumn` component.
|
|
196
|
+
*
|
|
197
|
+
* The default component is: [KendoReactColumnMenuTextColumn]({% slug api_data-tools_columnmenutextcolumn %}).
|
|
198
|
+
*/
|
|
199
|
+
columnMenuTextColumn?: CustomComponent<ColumnMenuProps>;
|
|
200
|
+
/**
|
|
201
|
+
* Overrides the default `filterFieldsEditor` component.
|
|
202
|
+
*
|
|
203
|
+
* The default component is: [PivotGridAxisFilterFieldsEditor]({% slug api_pivotgrid_pivotgridaxisfilterfieldseditor%}).
|
|
204
|
+
*/
|
|
205
|
+
filterFieldsEditor?: CustomComponent<PivotGridAxisFilterFieldsEditorProps>;
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
/**
|
|
209
|
+
* Represents the event arguments of the `PivotGridAxisFilterField` expand event.
|
|
210
|
+
*/
|
|
211
|
+
export declare interface PivotGridAxisFilterFieldExpandEvent {
|
|
212
|
+
target: PivotGridAxisFilterFieldsEditorHandle;
|
|
213
|
+
value: PivotGridField;
|
|
214
|
+
syntheticEvent: React_2.SyntheticEvent;
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
/**
|
|
218
|
+
* Represents the [KendoReact PivotGridAxisFilterFieldsEditor component]({% slug api_pivotgrid_pivotgridaxisfilterfieldseditorprops %}).
|
|
219
|
+
*/
|
|
220
|
+
export declare const PivotGridAxisFilterFieldsEditor: React_2.ForwardRefExoticComponent<PivotGridAxisFilterFieldsEditorProps & React_2.RefAttributes<PivotGridAxisFilterFieldsEditorHandle | null>>;
|
|
221
|
+
|
|
222
|
+
/**
|
|
223
|
+
* Represents the object which is passed to the [`ref`](https://reactjs.org/docs/refs-and-the-dom.html) callback of the PivotGridAxisFilterFieldsEditor component.
|
|
224
|
+
*/
|
|
225
|
+
export declare interface PivotGridAxisFilterFieldsEditorHandle {
|
|
226
|
+
props: PivotGridAxisFilterFieldsEditorProps;
|
|
227
|
+
element: HTMLDivElement | null;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* Represents the props of the [KendoReact PivotGridAxisFilterFieldsEditor component]({% slug api_pivotgrid_pivotgridaxisfilterfieldseditor %}).
|
|
232
|
+
*/
|
|
233
|
+
export declare interface PivotGridAxisFilterFieldsEditorProps {
|
|
234
|
+
/**
|
|
235
|
+
* Sets the `className` property of the top-most element of the PivotGridAxisFilterFieldsEditor in addition to the default `k-columnmenu-item-wrapper` class.
|
|
236
|
+
*/
|
|
237
|
+
className?: string;
|
|
238
|
+
/**
|
|
239
|
+
* Sets the `id` property of the top-most element of the PivotGridAxisFilterFieldsEditor.
|
|
240
|
+
*/
|
|
241
|
+
id?: string;
|
|
242
|
+
/**
|
|
243
|
+
* Sets the `tabIndex` property of the top-most element of the PivotGridAxisFilterFieldsEditor.
|
|
244
|
+
*/
|
|
245
|
+
tabIndex?: number;
|
|
246
|
+
/**
|
|
247
|
+
* Sets the `style` property of the top-most element of the PivotGridAxisFilterFieldsEditor.
|
|
248
|
+
*/
|
|
249
|
+
style?: React_2.CSSProperties;
|
|
250
|
+
/**
|
|
251
|
+
* Sets the `data` of the PivotGridAxisFilterFieldsEditor.
|
|
252
|
+
*
|
|
253
|
+
* The `data` represents all fields available for filtering.
|
|
254
|
+
*/
|
|
255
|
+
data?: PivotGridField[];
|
|
256
|
+
/**
|
|
257
|
+
* Represents the `dataItem` of the AxisEditor.
|
|
258
|
+
*
|
|
259
|
+
* The `dataItem` is a single [PivotGridAxis]({% slug api_pivotgrid_pivotgridaxis %}) object.
|
|
260
|
+
*/
|
|
261
|
+
dataItem: PivotGridAxis;
|
|
262
|
+
/**
|
|
263
|
+
* Represents the initial filter value before additional operations are executed.
|
|
264
|
+
*/
|
|
265
|
+
defaultFilter?: FilterDescriptor;
|
|
266
|
+
/**
|
|
267
|
+
* Indicates which of the three available axes are represented by the editor:
|
|
268
|
+
* - columnAxes
|
|
269
|
+
* - rowAxes
|
|
270
|
+
* - measureAxes
|
|
271
|
+
*/
|
|
272
|
+
axes: string;
|
|
273
|
+
/**
|
|
274
|
+
* Overrides the default `columnMenuItem` component.
|
|
275
|
+
*
|
|
276
|
+
* The default component is: [KendoReactColumnMenuItem]({% slug api_data-tools_columnmenuitem %}).
|
|
277
|
+
*/
|
|
278
|
+
columnMenuItem?: CustomComponent<ColumnMenuItemProps>;
|
|
279
|
+
/**
|
|
280
|
+
* Overrides the default `columnMenuForm` component.
|
|
281
|
+
*
|
|
282
|
+
* The default component is: [KendoReactColumnMenuForm]({% slug api_data-tools_columnmenuform %}).
|
|
283
|
+
*/
|
|
284
|
+
columnMenuForm?: CustomComponent<ColumnMenuFormProps>;
|
|
285
|
+
/**
|
|
286
|
+
* Overrides the default `resetButton` component.
|
|
287
|
+
*
|
|
288
|
+
* The default component is: [KendoReactButton]({% slug api_buttons_button %}).
|
|
289
|
+
*/
|
|
290
|
+
resetButton?: CustomComponent<ButtonProps>;
|
|
291
|
+
/**
|
|
292
|
+
* Overrides the default `applyButton` component.
|
|
293
|
+
*
|
|
294
|
+
* The default component is: [KendoReactButton]({% slug api_buttons_button %}).
|
|
295
|
+
*/
|
|
296
|
+
applyButton?: CustomComponent<ButtonProps>;
|
|
297
|
+
/**
|
|
298
|
+
* Overrides the default `treeView` component.
|
|
299
|
+
*
|
|
300
|
+
* The default component is: [KendoReactTreeView]({% slug api_treeview_treeview %}).
|
|
301
|
+
*/
|
|
302
|
+
treeView?: CustomComponent<TreeViewProps>;
|
|
303
|
+
/**
|
|
304
|
+
* Overrides the default `treeView` component.
|
|
305
|
+
*
|
|
306
|
+
* The default component is: `() => <Skeleton shape={'rectangle'} style={{height: '20px', width:'calc(100% - 16px)', margin: 8}}/>`.
|
|
307
|
+
*/
|
|
308
|
+
noData?: CustomComponent<any>;
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* Represents the event arguments of the `PivotGridAxisFilterFields` expand-change event.
|
|
313
|
+
*/
|
|
314
|
+
export declare interface PivotGridAxisFilterFieldsExpandChangeEvent {
|
|
315
|
+
target: PivotGridAxisFilterFieldsEditorHandle;
|
|
316
|
+
value: boolean;
|
|
317
|
+
syntheticEvent: React_2.SyntheticEvent;
|
|
318
|
+
}
|
|
319
|
+
|
|
320
|
+
/**
|
|
321
|
+
* Represents the [KendoReact PivotGridCell component]({% slug api_pivotgrid_pivotgridcellprops %}).
|
|
322
|
+
*/
|
|
323
|
+
export declare const PivotGridCell: React_2.ForwardRefExoticComponent<PivotGridCellProps & React_2.RefAttributes<PivotGridCellHandle | null>>;
|
|
324
|
+
|
|
325
|
+
/**
|
|
326
|
+
* Represents the object which is passed to the [`ref`](https://reactjs.org/docs/refs-and-the-dom.html) callback of the PivotGridCell component.
|
|
327
|
+
*/
|
|
328
|
+
export declare interface PivotGridCellHandle {
|
|
329
|
+
props: PivotGridCellProps;
|
|
330
|
+
element: HTMLTableCellElement | null;
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
/**
|
|
334
|
+
* Represents the props of the [KendoReact PivotGridCell component]({% slug api_pivotgrid_pivotgridcell %}).
|
|
335
|
+
*/
|
|
336
|
+
export declare interface PivotGridCellProps extends KendoMouse<PivotGridCellHandle, HTMLTableCellElement> {
|
|
337
|
+
/**
|
|
338
|
+
* Represents the `dataItem` of the PivotGridCell.
|
|
339
|
+
*
|
|
340
|
+
* The `dataItem` is a single [PivotDataItem]({% slug api_pivotgrid_pivotdataitem %}) object.
|
|
341
|
+
*/
|
|
342
|
+
dataItem: PivotDataItem;
|
|
343
|
+
/**
|
|
344
|
+
* Sets the `id` property of the top-most element of the PivotGridCell.
|
|
345
|
+
*/
|
|
346
|
+
id?: string;
|
|
347
|
+
/**
|
|
348
|
+
* Sets the `className` property of the top-most element of the PivotGridCell in addition to the default `k-pivotgrid-cell` class.
|
|
349
|
+
*/
|
|
350
|
+
className?: string;
|
|
351
|
+
/**
|
|
352
|
+
* Sets the `tabIndex` property of the top-most element of the PivotGridCell.
|
|
353
|
+
*/
|
|
354
|
+
tabIndex?: number;
|
|
355
|
+
/**
|
|
356
|
+
* Sets the `children` property of the top-most element of the PivotGridCell.
|
|
357
|
+
*/
|
|
358
|
+
children?: React_2.ReactNode;
|
|
359
|
+
/**
|
|
360
|
+
* Sets the `style` property of the top-most element of the PivotGridCell.
|
|
361
|
+
*/
|
|
362
|
+
style?: React_2.CSSProperties;
|
|
363
|
+
/**
|
|
364
|
+
* Represents the columns `path` leading to the current cell.
|
|
365
|
+
*/
|
|
366
|
+
columnPath?: string[];
|
|
367
|
+
/**
|
|
368
|
+
* Represents the row `path` leading to the current cell.
|
|
369
|
+
*/
|
|
370
|
+
rowPath?: string[];
|
|
371
|
+
/**
|
|
372
|
+
* Indicates if the current cell represents a `total` value.
|
|
373
|
+
*/
|
|
374
|
+
total?: boolean;
|
|
375
|
+
/**
|
|
376
|
+
* Sets the `role` property of the top-most element of the PivotGridCell.
|
|
377
|
+
*/
|
|
378
|
+
role?: string;
|
|
379
|
+
/**
|
|
380
|
+
* Sets the `aria-describedby` property of the top-most element of the PivotGridCell.
|
|
381
|
+
*/
|
|
382
|
+
ariaDescribedby?: string;
|
|
383
|
+
}
|
|
384
|
+
|
|
385
|
+
/**
|
|
386
|
+
* Represents the [KendoReact PivotGridColumn component]({% slug api_pivotgrid_pivotgridcolumnprops %}).
|
|
387
|
+
*/
|
|
388
|
+
export declare const PivotGridColumn: React_2.ForwardRefExoticComponent<PivotGridColumnProps & React_2.RefAttributes<PivotGridColumnHandle | null>>;
|
|
389
|
+
|
|
390
|
+
/**
|
|
391
|
+
* Represents the object which is passed to the [`ref`](https://reactjs.org/docs/refs-and-the-dom.html) callback of the PivotGridColumn component.
|
|
392
|
+
*/
|
|
393
|
+
export declare interface PivotGridColumnHandle {
|
|
394
|
+
props: PivotGridColumnProps;
|
|
395
|
+
element: HTMLTableColElement | null;
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
/**
|
|
399
|
+
* Represents the props of the [KendoReact PivotGridColumn component]({% slug api_pivotgrid_pivotgridcolumn %}).
|
|
400
|
+
*/
|
|
401
|
+
export declare interface PivotGridColumnProps extends KendoMouse<PivotGridColumnHandle, HTMLTableColElement> {
|
|
402
|
+
/**
|
|
403
|
+
* Sets the `className` property of the top-most element of the PivotGridColumn in addition to the default `k-pivotgrid-row` class.
|
|
404
|
+
*/
|
|
405
|
+
className?: string;
|
|
406
|
+
/**
|
|
407
|
+
* Sets the `id` property of the top-most element of the PivotGridColumn.
|
|
408
|
+
*/
|
|
409
|
+
id?: string;
|
|
410
|
+
/**
|
|
411
|
+
* Sets the `children` property of the top-most element of the PivotGridColumn.
|
|
412
|
+
*/
|
|
413
|
+
children?: React_2.ReactNode;
|
|
414
|
+
/**
|
|
415
|
+
* Sets the `style` property of the top-most element of the PivotGridColumn.
|
|
416
|
+
*/
|
|
417
|
+
style?: React_2.CSSProperties;
|
|
418
|
+
/**
|
|
419
|
+
* Sets the `tabIndex` property of the top-most element of the PivotGridColumn.
|
|
420
|
+
*/
|
|
421
|
+
tabIndex?: number;
|
|
422
|
+
/**
|
|
423
|
+
* Represents the `path` leading to the current `column`.
|
|
424
|
+
*/
|
|
425
|
+
path?: string[];
|
|
426
|
+
}
|
|
427
|
+
|
|
428
|
+
/**
|
|
429
|
+
* Represents the [KendoReact PivotGridConfigurator component]({% slug api_pivotgrid_pivotgridconfiguratorprops %}).
|
|
430
|
+
*/
|
|
431
|
+
export declare const PivotGridConfigurator: React_2.ForwardRefExoticComponent<PivotGridConfiguratorProps & React_2.RefAttributes<PivotGridConfiguratorHandle | null>>;
|
|
432
|
+
|
|
433
|
+
/**
|
|
434
|
+
* Represents the available PivotGridConfigurator actions.
|
|
435
|
+
*
|
|
436
|
+
* Can be one of:
|
|
437
|
+
* - [PivotGridConfiguratorSelectionAction]({% slug api_pivotgrid_pivotgridconfiguratorselectionaction %})
|
|
438
|
+
* - [PivotGridConfiguratorMultipleSelectionAction]({% slug api_pivotgrid_pivotgridconfiguratormultipleselectionaction %})
|
|
439
|
+
* - [PivotGridConfiguratorRemoveAction]({% slug api_pivotgrid_pivotgridconfiguratorremoveaction %})
|
|
440
|
+
* - [PivotGridConfiguratorSortAction]({% slug api_pivotgrid_pivotgridconfiguratorsortaction %})
|
|
441
|
+
* - [PivotGridConfiguratorFilterAction]({% slug api_pivotgrid_pivotgridconfiguratorfilteraction %})
|
|
442
|
+
* - [PivotConfiguratorDragAction]({% slug api_pivotgrid_pivotconfiguratordragaction %})
|
|
443
|
+
* - [PivotConfiguratorDropAction]({% slug api_pivotgrid_pivotconfiguratordropaction %})
|
|
444
|
+
* - [PivotGridConfiguratorDropZoneAction]({% slug api_pivotgrid_pivotgridconfiguratordropzoneaction %})
|
|
445
|
+
* - [PivotGridConfiguratorDropTargetAction]({% slug api_pivotgrid_pivotgridconfiguratordroptargetaction %})
|
|
446
|
+
* - [PivotGridConfiguratorDropDirectionAction]({% slug api_pivotgrid_pivotgridconfiguratordropdirectionaction %})
|
|
447
|
+
* - [PivotGridConfiguratorExpandAction]({% slug api_pivotgrid_pivotgridconfiguratorexpandaction %})
|
|
448
|
+
*
|
|
449
|
+
* The following `falsy` values will be ignored:
|
|
450
|
+
* - `null`
|
|
451
|
+
* - `false`
|
|
452
|
+
* - `undefined`
|
|
453
|
+
*
|
|
454
|
+
* @hidden
|
|
455
|
+
*/
|
|
456
|
+
declare interface PivotGridConfiguratorAction {
|
|
457
|
+
type: PIVOT_CONFIGURATOR_ACTION_TYPE;
|
|
458
|
+
payload: any;
|
|
459
|
+
override?: PivotGridConfiguratorEditorState;
|
|
460
|
+
}
|
|
461
|
+
|
|
462
|
+
/**
|
|
463
|
+
* Represents the event arguments of the [`onColumnAxesChange`]({% slug api_pivotgrid_pivotgridconfiguratorprops %}#toc-oncolumnaxeschange), [`onRowAxesChange`]({% slug api_pivotgrid_pivotgridconfiguratorprops %}#toc-onrowaxeschange) and [`onMeasureAxesChange`]({% slug api_pivotgrid_pivotgridconfiguratorprops %}#toc-onmeasureaxeschange) callbacks of the [`PivotGridConfigurator`]({% slug api_pivotgrid_pivotgridconfigurator %}) component.
|
|
464
|
+
*/
|
|
465
|
+
export declare interface PivotGridConfiguratorAxesChangeEvent {
|
|
466
|
+
value: PivotGridAxis[];
|
|
467
|
+
target: PivotGridConfiguratorHandle | null;
|
|
468
|
+
syntheticEvent: React.SyntheticEvent;
|
|
469
|
+
}
|
|
470
|
+
|
|
471
|
+
/**
|
|
472
|
+
* Represents the [KendoReact PivotGridConfiguratorButton component]({% slug api_pivotgrid_pivotgridconfiguratorbuttonprops %}).
|
|
473
|
+
*/
|
|
474
|
+
export declare const PivotGridConfiguratorButton: React_2.ForwardRefExoticComponent<PivotGridConfiguratorButtonProps & React_2.RefAttributes<PivotGridConfiguratorButtonHandle | null>>;
|
|
475
|
+
|
|
476
|
+
/**
|
|
477
|
+
* Represents the object which is passed to the [`ref`](https://reactjs.org/docs/refs-and-the-dom.html) callback of the PivotGridConfiguratorButton component.
|
|
478
|
+
*/
|
|
479
|
+
export declare interface PivotGridConfiguratorButtonHandle {
|
|
480
|
+
props: PivotGridConfiguratorButtonProps;
|
|
481
|
+
element: HTMLDivElement | null;
|
|
482
|
+
}
|
|
483
|
+
|
|
484
|
+
/**
|
|
485
|
+
* Represents the props of the [KendoReact PivotGridConfiguratorButton component]({% slug api_pivotgrid_pivotgridconfiguratorbutton %}).
|
|
486
|
+
*/
|
|
487
|
+
export declare interface PivotGridConfiguratorButtonProps extends KendoMouse<PivotGridConfiguratorButtonHandle, HTMLDivElement> {
|
|
488
|
+
/**
|
|
489
|
+
* Sets the `className` property of the top-most element of the PivotGridConfiguratorButton in addition to the default `k-pivotgrid-configurator-button` class.
|
|
490
|
+
*/
|
|
491
|
+
className?: string;
|
|
492
|
+
/**
|
|
493
|
+
* Sets the `id` property of the top-most element of the PivotGridConfiguratorButton.
|
|
494
|
+
*/
|
|
495
|
+
id?: string;
|
|
496
|
+
/**
|
|
497
|
+
* Sets the `tabIndex` property of the top-most element of the PivotGridConfiguratorButton.
|
|
498
|
+
*/
|
|
499
|
+
tabIndex?: number;
|
|
500
|
+
/**
|
|
501
|
+
* Sets the `style` property of the top-most element of the PivotGridConfiguratorButton.
|
|
502
|
+
*/
|
|
503
|
+
style?: React_2.CSSProperties;
|
|
504
|
+
/**
|
|
505
|
+
* Overrides the default `icon` component.
|
|
506
|
+
*
|
|
507
|
+
* The default component is: [KendoReactIcon]({% slug api_common_icon %}).
|
|
508
|
+
*/
|
|
509
|
+
icon?: CustomComponent<IconProps & SvgIconProps>;
|
|
510
|
+
}
|
|
511
|
+
|
|
512
|
+
/**
|
|
513
|
+
* Represents the [KendoReact PivotGridConfiguratorEditor component]({% slug api_pivotgrid_pivotgridconfiguratoreditorprops %}).
|
|
514
|
+
*/
|
|
515
|
+
export declare const PivotGridConfiguratorEditor: React_2.ForwardRefExoticComponent<PivotGridConfiguratorEditorProps & React_2.RefAttributes<PivotGridConfiguratorEditorHandle>>;
|
|
516
|
+
|
|
517
|
+
/**
|
|
518
|
+
* Represents the object which is passed to the [`ref`](https://reactjs.org/docs/refs-and-the-dom.html) callback of the PivotGridConfiguratorEditor component.
|
|
519
|
+
*/
|
|
520
|
+
export declare interface PivotGridConfiguratorEditorHandle {
|
|
521
|
+
props: PivotGridConfiguratorEditorProps;
|
|
522
|
+
state: PivotGridConfiguratorState;
|
|
523
|
+
element: HTMLDivElement;
|
|
524
|
+
}
|
|
525
|
+
|
|
526
|
+
/**
|
|
527
|
+
* Represents the props of the [KendoReact PivotGridConfiguratorEditor component]({% slug api_pivotgrid_pivotgridconfiguratoreditor %}).
|
|
528
|
+
*/
|
|
529
|
+
export declare interface PivotGridConfiguratorEditorProps extends FormRenderProps {
|
|
530
|
+
/**
|
|
531
|
+
* Sets the `data` of the PivotGridConfiguratorEditor.
|
|
532
|
+
*
|
|
533
|
+
* The `data` represents all fields available in the configurator.
|
|
534
|
+
*/
|
|
535
|
+
data: PivotGridField[];
|
|
536
|
+
/**
|
|
537
|
+
* Renders the PivotGridConfiguratorEditor in `horizontal` orientation.
|
|
538
|
+
*/
|
|
539
|
+
horizontal?: boolean;
|
|
540
|
+
/**
|
|
541
|
+
* Overrides the default `fieldsLabel` component.
|
|
542
|
+
*
|
|
543
|
+
* The default component is: [KendoReactLabel]({% slug api_labels_label %}).
|
|
544
|
+
*/
|
|
545
|
+
fieldsLabel?: CustomComponent<FieldProps & LabelProps>;
|
|
546
|
+
/**
|
|
547
|
+
* Overrides the default `fieldsEditor` component.
|
|
548
|
+
*
|
|
549
|
+
* The default component is: [PivotGridFieldsEditor]({% slug api_pivotgrid_pivotgridfieldseditor %}).
|
|
550
|
+
*/
|
|
551
|
+
fieldsEditor?: CustomComponent<PivotGridFieldsEditorProps>;
|
|
552
|
+
/**
|
|
553
|
+
* Overrides the default `columnAxesLabel` component.
|
|
554
|
+
*
|
|
555
|
+
* The default component is: [KendoReactLabel]({% slug api_labels_label %}).
|
|
556
|
+
*/
|
|
557
|
+
columnAxesLabel?: CustomComponent<FieldProps & LabelProps>;
|
|
558
|
+
/**
|
|
559
|
+
* Overrides the default `columnAxesEditor` component.
|
|
560
|
+
*
|
|
561
|
+
* The default component is: [PivotGridAxesEditor]({% slug api_pivotgrid_pivotgridaxeseditor %}).
|
|
562
|
+
*/
|
|
563
|
+
columnAxesEditor?: CustomComponent<PivotGridAxesEditorProps>;
|
|
564
|
+
/**
|
|
565
|
+
* Overrides the default `rowAxesLabel` component.
|
|
566
|
+
*
|
|
567
|
+
* The default component is: [KendoReactLabel]({% slug api_labels_label %}).
|
|
568
|
+
*/
|
|
569
|
+
rowAxesLabel?: CustomComponent<FieldProps & LabelProps>;
|
|
570
|
+
/**
|
|
571
|
+
* Overrides the default `rowAxesEditor` component.
|
|
572
|
+
*
|
|
573
|
+
* The default component is: [PivotGridAxesEditor]({% slug api_pivotgrid_pivotgridaxeseditor %}).
|
|
574
|
+
*/
|
|
575
|
+
rowAxesEditor?: CustomComponent<PivotGridAxesEditorProps>;
|
|
576
|
+
/**
|
|
577
|
+
* Overrides the default `measureAxesLabel` component.
|
|
578
|
+
*
|
|
579
|
+
* The default component is: [KendoReactLabel]({% slug api_labels_label %}).
|
|
580
|
+
*/
|
|
581
|
+
measureAxesLabel?: CustomComponent<FieldProps & LabelProps>;
|
|
582
|
+
/**
|
|
583
|
+
* Overrides the default `measureAxesEditor` component.
|
|
584
|
+
*
|
|
585
|
+
* The default component is: [PivotGridAxesEditor]({% slug api_pivotgrid_pivotgridaxeseditor %}).
|
|
586
|
+
*/
|
|
587
|
+
measureAxesEditor?: CustomComponent<PivotGridAxesEditorProps>;
|
|
588
|
+
/**
|
|
589
|
+
* A callback, fired whenever a `FieldEditorField` is expanded.
|
|
590
|
+
*/
|
|
591
|
+
onFieldsEditorFieldExpand?: (event: PivotGridFieldsEditorFieldExpandEvent & {
|
|
592
|
+
currentTarget: PivotGridConfiguratorEditorHandle;
|
|
593
|
+
}) => void;
|
|
594
|
+
/**
|
|
595
|
+
* An action callback. Used to define the component behavior when a `FieldsEditorFieldExpand` is triggered.
|
|
596
|
+
*
|
|
597
|
+
* Internal state change will be triggered depending on the specific action types.
|
|
598
|
+
*
|
|
599
|
+
* @hidden
|
|
600
|
+
*/
|
|
601
|
+
onFieldsEditorFieldExpandAction?: (event: PivotGridFieldsEditorFieldCheckEvent & {
|
|
602
|
+
currentTarget: PivotGridConfiguratorEditorHandle;
|
|
603
|
+
}, props: PivotGridConfiguratorEditorProps, state: PivotGridConfiguratorEditorState) => PivotGridConfiguratorAction | PivotGridConfiguratorAction[];
|
|
604
|
+
/**
|
|
605
|
+
* A callback, fired whenever a `FieldEditorField` is checked.
|
|
606
|
+
*/
|
|
607
|
+
onFieldsEditorFieldCheck?: (event: PivotGridFieldsEditorFieldCheckEvent & {
|
|
608
|
+
currentTarget: PivotGridConfiguratorEditorHandle;
|
|
609
|
+
}) => void;
|
|
610
|
+
/**
|
|
611
|
+
* An action callback. Used to define the component behavior when a `FieldsEditorFieldCheck` is triggered.
|
|
612
|
+
*
|
|
613
|
+
* Internal state change will be triggered depending on the specific action types.
|
|
614
|
+
*
|
|
615
|
+
* @hidden
|
|
616
|
+
*/
|
|
617
|
+
onFieldsEditorFieldCheckAction?: (event: PivotGridFieldsEditorFieldCheckEvent & {
|
|
618
|
+
currentTarget: PivotGridConfiguratorEditorHandle;
|
|
619
|
+
}, props: PivotGridConfiguratorEditorProps, state: PivotGridConfiguratorEditorState) => PivotGridConfiguratorAction | PivotGridConfiguratorAction[];
|
|
620
|
+
/**
|
|
621
|
+
* A callback, fired whenever an `AxisFilterField` is expanded.
|
|
622
|
+
*/
|
|
623
|
+
onAxisFilterFieldExpand?: (event: PivotGridAxisFilterFieldExpandEvent & {
|
|
624
|
+
currentTarget: PivotGridConfiguratorEditorHandle;
|
|
625
|
+
}) => void;
|
|
626
|
+
/**
|
|
627
|
+
* A callback, fired whenever `expanded` state of the AxisFilterFields is changed.
|
|
628
|
+
*/
|
|
629
|
+
onAxisFilterFieldsExpandChange?: (event: PivotGridAxisFilterFieldsExpandChangeEvent) => void;
|
|
630
|
+
}
|
|
631
|
+
|
|
632
|
+
/**
|
|
633
|
+
* @hidden
|
|
634
|
+
*/
|
|
635
|
+
declare interface PivotGridConfiguratorEditorState extends PivotGridConfiguratorState {
|
|
636
|
+
expanded: PivotGridField[];
|
|
637
|
+
}
|
|
638
|
+
|
|
639
|
+
/**
|
|
640
|
+
* Represents the event arguments of the [`onFilterChange`]({% slug api_pivotgrid_pivotgridconfiguratorprops %}#toc-onfilterchange) callbacks of the [`PivotGridConfigurator`]({% slug api_pivotgrid_pivotgridconfigurator %}) component.
|
|
641
|
+
*/
|
|
642
|
+
export declare interface PivotGridConfiguratorFilterChangeEvent {
|
|
643
|
+
value: FilterDescriptor[];
|
|
644
|
+
target: PivotGridConfiguratorHandle | null;
|
|
645
|
+
syntheticEvent: React.SyntheticEvent;
|
|
646
|
+
}
|
|
647
|
+
|
|
648
|
+
/**
|
|
649
|
+
* Represents the object which is passed to the [`ref`](https://reactjs.org/docs/refs-and-the-dom.html) callback of the PivotGridConfigurator component.
|
|
650
|
+
*/
|
|
651
|
+
export declare interface PivotGridConfiguratorHandle {
|
|
652
|
+
props: PivotGridConfiguratorProps;
|
|
653
|
+
element: HTMLDivElement | null;
|
|
654
|
+
}
|
|
655
|
+
|
|
656
|
+
/**
|
|
657
|
+
* Represents the props of the [KendoReact PivotGridConfigurator component]({% slug api_pivotgrid_pivotgridconfigurator %}).
|
|
658
|
+
*/
|
|
659
|
+
export declare interface PivotGridConfiguratorProps {
|
|
660
|
+
/**
|
|
661
|
+
* Sets the `className` property of the top-most element of the PivotGridConfigurator in addition to the default `k-pivotgrid-configurator` class.
|
|
662
|
+
*/
|
|
663
|
+
className?: string;
|
|
664
|
+
/**
|
|
665
|
+
* Sets the `id` property of the top-most element of the PivotGridConfigurator.
|
|
666
|
+
*/
|
|
667
|
+
id?: string;
|
|
668
|
+
/**
|
|
669
|
+
* Sets the `tabIndex` property of the top-most element of the PivotGridConfigurator.
|
|
670
|
+
*/
|
|
671
|
+
tabIndex?: number;
|
|
672
|
+
/**
|
|
673
|
+
* Sets the `style` property of the top-most element of the PivotGridConfigurator.
|
|
674
|
+
*/
|
|
675
|
+
style?: React_2.CSSProperties;
|
|
676
|
+
/**
|
|
677
|
+
* Renders the PivotGridConfigurator in `horizontal` orientation.
|
|
678
|
+
*/
|
|
679
|
+
horizontal?: boolean;
|
|
680
|
+
/**
|
|
681
|
+
* Sets the `data` of the PivotGridConfigurator.
|
|
682
|
+
*
|
|
683
|
+
* The `data` represents all fields available in the configurator.
|
|
684
|
+
*/
|
|
685
|
+
data?: PivotGridField[];
|
|
686
|
+
/**
|
|
687
|
+
* The configuration of the `column` axes.
|
|
688
|
+
*/
|
|
689
|
+
columnAxes?: PivotGridAxis[];
|
|
690
|
+
/**
|
|
691
|
+
* A callback, fired whenever the `columnAxes` property should change.
|
|
692
|
+
*/
|
|
693
|
+
onColumnAxesChange?: (event: PivotGridConfiguratorAxesChangeEvent) => void;
|
|
694
|
+
/**
|
|
695
|
+
* The configuration of the `row` axes.
|
|
696
|
+
*/
|
|
697
|
+
rowAxes?: PivotGridAxis[];
|
|
698
|
+
/**
|
|
699
|
+
* A callback, fired whenever the `rowAxes` property should change.
|
|
700
|
+
*/
|
|
701
|
+
onRowAxesChange?: (event: PivotGridConfiguratorAxesChangeEvent) => void;
|
|
702
|
+
/**
|
|
703
|
+
* The configuration of the `measure` axes.
|
|
704
|
+
*/
|
|
705
|
+
measureAxes?: PivotGridAxis[];
|
|
706
|
+
/**
|
|
707
|
+
* A callback, fired whenever the `measureAxes` property should change.
|
|
708
|
+
*/
|
|
709
|
+
onMeasureAxesChange?: (event: PivotGridConfiguratorAxesChangeEvent) => void;
|
|
710
|
+
/**
|
|
711
|
+
* The descriptors by which the data is sorted.
|
|
712
|
+
*/
|
|
713
|
+
sort?: SortDescriptor[];
|
|
714
|
+
/**
|
|
715
|
+
* A callback, fired whenever the `sort` property should change.
|
|
716
|
+
*/
|
|
717
|
+
onSortChange?: (event: PivotGridConfiguratorSortChangeEvent) => void;
|
|
718
|
+
/**
|
|
719
|
+
* The descriptors by which the data is filtered.
|
|
720
|
+
*/
|
|
721
|
+
filter?: FilterDescriptor[];
|
|
722
|
+
/**
|
|
723
|
+
* A callback, fired whenever the `filter` property should change.
|
|
724
|
+
*/
|
|
725
|
+
onFilterChange?: (event: PivotGridConfiguratorFilterChangeEvent) => void;
|
|
726
|
+
/**
|
|
727
|
+
* A callback, fired whenever a `field` is expanded.
|
|
728
|
+
*/
|
|
729
|
+
onFieldsEditorFieldExpand?: (event: PivotGridFieldsEditorFieldExpandEvent) => void;
|
|
730
|
+
/**
|
|
731
|
+
* A callback, fired whenever a `field` is checked.
|
|
732
|
+
*/
|
|
733
|
+
onFieldsEditorFieldCheck?: (event: PivotGridFieldsEditorFieldCheckEvent) => void;
|
|
734
|
+
/**
|
|
735
|
+
* A callback, fired whenever an `AxisFilterField` is expanded.
|
|
736
|
+
*/
|
|
737
|
+
onAxisFilterFieldExpand?: (event?: PivotGridAxisFilterFieldExpandEvent) => void;
|
|
738
|
+
/**
|
|
739
|
+
* A callback, fired whenever the `expanded` state of the `AxisFilterFields` is changed.
|
|
740
|
+
*/
|
|
741
|
+
onAxisFilterFieldsExpandChange?: (event?: PivotGridAxisFilterFieldsExpandChangeEvent) => void;
|
|
742
|
+
/**
|
|
743
|
+
* Overrides the default `editor` component.
|
|
744
|
+
*
|
|
745
|
+
* The default component is: [PivotGridConfiguratorEditor]({% slug api_pivotgrid_pivotgridconfiguratoreditor %}).
|
|
746
|
+
*/
|
|
747
|
+
editor?: CustomComponent<PivotGridConfiguratorEditorProps>;
|
|
748
|
+
/**
|
|
749
|
+
* Overrides the default `form` component.
|
|
750
|
+
*
|
|
751
|
+
* The default component is: [KendoReactForm]({% slug api_form_form %}).
|
|
752
|
+
*/
|
|
753
|
+
form?: CustomComponent<FormProps>;
|
|
754
|
+
/**
|
|
755
|
+
* Overrides the default `formElement` component.
|
|
756
|
+
*
|
|
757
|
+
* The default component is: [KendoReactFormElement]({% slug api_form_formelement %}).
|
|
758
|
+
*/
|
|
759
|
+
formElement?: CustomComponent<FormElementProps>;
|
|
760
|
+
}
|
|
761
|
+
|
|
762
|
+
/**
|
|
763
|
+
* Represents the event arguments of the [`onSortChange`]({% slug api_pivotgrid_pivotgridconfiguratorprops %}#toc-onsortchange) callbacks of the [`PivotGridConfigurator`]({% slug api_pivotgrid_pivotgridconfigurator %}) component.
|
|
764
|
+
*/
|
|
765
|
+
export declare interface PivotGridConfiguratorSortChangeEvent {
|
|
766
|
+
value: SortDescriptor[];
|
|
767
|
+
target: PivotGridConfiguratorHandle | null;
|
|
768
|
+
syntheticEvent: React.SyntheticEvent;
|
|
769
|
+
}
|
|
770
|
+
|
|
771
|
+
/**
|
|
772
|
+
* Represents the [KendoReact PivotGridContainer component]({% slug api_pivotgrid_pivotgridcontainerprops %}).
|
|
773
|
+
*/
|
|
774
|
+
export declare const PivotGridContainer: React_2.ForwardRefExoticComponent<PivotGridContainerProps & React_2.RefAttributes<PivotGridContainerHandle | null>>;
|
|
775
|
+
|
|
776
|
+
/**
|
|
777
|
+
* Represents the object which is passed to the [`ref`](https://reactjs.org/docs/refs-and-the-dom.html) callback of the PivotGridContainer component.
|
|
778
|
+
*/
|
|
779
|
+
export declare interface PivotGridContainerHandle {
|
|
780
|
+
element: HTMLDivElement | null;
|
|
781
|
+
props: PivotGridContainerProps;
|
|
782
|
+
}
|
|
783
|
+
|
|
784
|
+
/**
|
|
785
|
+
* Represents the props of the [KendoReact PivotGridContainer component]({% slug api_pivotgrid_pivotgridcontainer %}).
|
|
786
|
+
*/
|
|
787
|
+
export declare interface PivotGridContainerProps {
|
|
788
|
+
/**
|
|
789
|
+
* Sets the `id` property of the top-most element of the PivotGridContainer.
|
|
790
|
+
*/
|
|
791
|
+
id?: string;
|
|
792
|
+
/**
|
|
793
|
+
* Sets the `tabIndex` property of the top-most element of the PivotGridContainer.
|
|
794
|
+
*/
|
|
795
|
+
tabIndex?: number;
|
|
796
|
+
/**
|
|
797
|
+
* Sets the `className` property of the top-most element of the PivotGridContainer in addition to the default `k-d-flex k-pos-relative` class.
|
|
798
|
+
*/
|
|
799
|
+
className?: string;
|
|
800
|
+
/**
|
|
801
|
+
* Sets the `children` property of the top-most element of the PivotGridContainer.
|
|
802
|
+
*/
|
|
803
|
+
children?: React_2.ReactNode;
|
|
804
|
+
/**
|
|
805
|
+
* Sets the `style` property of the top-most element of the PivotGridContainer.
|
|
806
|
+
*/
|
|
807
|
+
style?: React_2.CSSProperties;
|
|
808
|
+
/**
|
|
809
|
+
* Sets the configurator position in the container.
|
|
810
|
+
* The available values are:
|
|
811
|
+
* - top
|
|
812
|
+
* - left
|
|
813
|
+
* - right
|
|
814
|
+
* - bottom
|
|
815
|
+
*/
|
|
816
|
+
configuratorPosition?: 'top' | 'left' | 'right' | 'bottom';
|
|
817
|
+
}
|
|
818
|
+
|
|
819
|
+
/**
|
|
820
|
+
* Represents the [KendoReact PivotGridFieldsEditor component]({% slug api_pivotgrid_pivotgridfieldseditorprops %}).
|
|
821
|
+
*/
|
|
822
|
+
export declare const PivotGridFieldsEditor: React_2.ForwardRefExoticComponent<PivotGridFieldsEditorProps & React_2.RefAttributes<PivotGridFieldsEditorHandle | null>>;
|
|
823
|
+
|
|
824
|
+
/**
|
|
825
|
+
* @hidden
|
|
826
|
+
*/
|
|
827
|
+
export declare interface PivotGridFieldsEditorFieldCheckEvent {
|
|
828
|
+
target: PivotGridFieldsEditorHandle;
|
|
829
|
+
value: PivotGridField;
|
|
830
|
+
syntheticEvent: React_2.SyntheticEvent;
|
|
831
|
+
}
|
|
832
|
+
|
|
833
|
+
/**
|
|
834
|
+
* @hidden
|
|
835
|
+
*/
|
|
836
|
+
export declare interface PivotGridFieldsEditorFieldExpandEvent {
|
|
837
|
+
target: PivotGridFieldsEditorHandle;
|
|
838
|
+
value: PivotGridField;
|
|
839
|
+
syntheticEvent: React_2.SyntheticEvent;
|
|
840
|
+
}
|
|
841
|
+
|
|
842
|
+
/**
|
|
843
|
+
* Represents the object which is passed to the [`ref`](https://reactjs.org/docs/refs-and-the-dom.html) callback of the PivotGridFieldsEditor component.
|
|
844
|
+
*/
|
|
845
|
+
export declare interface PivotGridFieldsEditorHandle {
|
|
846
|
+
props: PivotGridFieldsEditorProps;
|
|
847
|
+
element: HTMLDivElement | null;
|
|
848
|
+
}
|
|
849
|
+
|
|
850
|
+
/**
|
|
851
|
+
* Represents the props of the [KendoReact PivotGridFieldsEditor component]({% slug api_pivotgrid_pivotgridfieldseditor %}).
|
|
852
|
+
*/
|
|
853
|
+
export declare interface PivotGridFieldsEditorProps {
|
|
854
|
+
/**
|
|
855
|
+
* Sets the `data` of the PivotGridConfiguratorEditor.
|
|
856
|
+
*
|
|
857
|
+
* The `data` represents all fields available in the configurator.
|
|
858
|
+
*/
|
|
859
|
+
data?: PivotGridField[];
|
|
860
|
+
/**
|
|
861
|
+
* The configuration of the `row` axes.
|
|
862
|
+
*/
|
|
863
|
+
rowAxes?: PivotGridAxis[];
|
|
864
|
+
/**
|
|
865
|
+
* The configuration of the `column` axes.
|
|
866
|
+
*/
|
|
867
|
+
columnAxes?: PivotGridAxis[];
|
|
868
|
+
/**
|
|
869
|
+
* The configuration of the `measure` axes.
|
|
870
|
+
*/
|
|
871
|
+
measureAxes?: PivotGridAxis[];
|
|
872
|
+
/**
|
|
873
|
+
* A callback, fired whenever an `expand` is triggered.
|
|
874
|
+
*/
|
|
875
|
+
onExpand?: (args: PivotGridFieldsEditorFieldExpandEvent) => void;
|
|
876
|
+
/**
|
|
877
|
+
* A callback, fired whenever a `check` is triggered.
|
|
878
|
+
*/
|
|
879
|
+
onCheck?: (args: PivotGridFieldsEditorFieldCheckEvent) => void;
|
|
880
|
+
/**
|
|
881
|
+
* Overrides the default `treeView` component.
|
|
882
|
+
*
|
|
883
|
+
* The default component is: [KendoReactTreeView]({% slug api_treeview_treeview %}).
|
|
884
|
+
*/
|
|
885
|
+
treeView?: CustomComponent<TreeViewProps>;
|
|
886
|
+
/**
|
|
887
|
+
* Overrides the default `noData` component.
|
|
888
|
+
*
|
|
889
|
+
* The default component is: `() => <div>NO DATA</div>`
|
|
890
|
+
*/
|
|
891
|
+
noData?: CustomComponent<any>;
|
|
892
|
+
}
|
|
893
|
+
|
|
894
|
+
/**
|
|
895
|
+
* Represents the object which is passed to the [`ref`](https://reactjs.org/docs/refs-and-the-dom.html) callback of the PivotGrid component.
|
|
896
|
+
*/
|
|
897
|
+
export declare interface PivotGridHandle {
|
|
898
|
+
element: HTMLDivElement | null;
|
|
899
|
+
props: PivotGridProps;
|
|
900
|
+
columnHeaderRows: AxisRow[];
|
|
901
|
+
rowHeaderRows: AxisRow[];
|
|
902
|
+
dataCells: {
|
|
903
|
+
row: string[];
|
|
904
|
+
cells: PivotDataItem[];
|
|
905
|
+
}[];
|
|
906
|
+
rowHeaderBreadth: number;
|
|
907
|
+
columnHeaderBreadth: number;
|
|
908
|
+
}
|
|
909
|
+
|
|
910
|
+
/**
|
|
911
|
+
* Represents the [KendoReact PivotGridHeaderCell component]({% slug api_pivotgrid_pivotgridheadercellprops %}).
|
|
912
|
+
*/
|
|
913
|
+
export declare const PivotGridHeaderCell: React_2.ForwardRefExoticComponent<PivotGridHeaderCellProps & React_2.RefAttributes<PivotGridHeaderCellHandle | null>>;
|
|
914
|
+
|
|
915
|
+
/**
|
|
916
|
+
* Represents the object which is passed to the [`ref`](https://reactjs.org/docs/refs-and-the-dom.html) callback of the PivotGridHeaderCell component.
|
|
917
|
+
*/
|
|
918
|
+
export declare interface PivotGridHeaderCellHandle {
|
|
919
|
+
props: PivotGridHeaderCellProps;
|
|
920
|
+
element: HTMLTableHeaderCellElement | null;
|
|
921
|
+
}
|
|
922
|
+
|
|
923
|
+
/**
|
|
924
|
+
* Represents the props of the [KendoReact PivotGridHeaderCell component]({% slug api_pivotgrid_pivotgridheadercell %}).
|
|
925
|
+
*/
|
|
926
|
+
export declare interface PivotGridHeaderCellProps extends KendoMouse<PivotGridHeaderCellHandle, HTMLTableHeaderCellElement> {
|
|
927
|
+
/**
|
|
928
|
+
* Represents the `dataItem` of the PivotGridHeaderCell.
|
|
929
|
+
*
|
|
930
|
+
* The `dataItem` is a single [AxisDataItem]({% slug api_pivotgrid_axisdataitem %}) object.
|
|
931
|
+
*/
|
|
932
|
+
dataItem: AxisDataItem;
|
|
933
|
+
/**
|
|
934
|
+
* Sets the `id` property of the top-most element of the PivotGridHeaderCell.
|
|
935
|
+
*/
|
|
936
|
+
id?: string;
|
|
937
|
+
/**
|
|
938
|
+
* Sets the `className` property of the top-most element of the PivotGridHeaderCell in addition to the default `k-pivotgrid-cell` class.
|
|
939
|
+
*/
|
|
940
|
+
className?: string;
|
|
941
|
+
/**
|
|
942
|
+
* Sets the `tabIndex` property of the top-most element of the PivotGridHeaderCell.
|
|
943
|
+
*/
|
|
944
|
+
tabIndex?: number;
|
|
945
|
+
/**
|
|
946
|
+
* Sets the `children` property of the top-most element of the PivotGridHeaderCell.
|
|
947
|
+
*/
|
|
948
|
+
children?: React_2.ReactNode;
|
|
949
|
+
/**
|
|
950
|
+
* Sets the `style` property of the top-most element of the PivotGridHeaderCell.
|
|
951
|
+
*/
|
|
952
|
+
style?: React_2.CSSProperties;
|
|
953
|
+
/**
|
|
954
|
+
* Represents the calculated `rowSpan` property of the cell.
|
|
955
|
+
*/
|
|
956
|
+
rowSpan?: number;
|
|
957
|
+
/**
|
|
958
|
+
* Represents the calculated `colSpan` property of the cell.
|
|
959
|
+
*/
|
|
960
|
+
colSpan?: number;
|
|
961
|
+
/**
|
|
962
|
+
* Represents the columns `path` leading to the current cell.
|
|
963
|
+
*/
|
|
964
|
+
columnPath?: string[];
|
|
965
|
+
/**
|
|
966
|
+
* Represents the row `path` leading to the current cell.
|
|
967
|
+
*/
|
|
968
|
+
rowPath?: string[];
|
|
969
|
+
/**
|
|
970
|
+
* Indicates if the current cell represents a `total` value.
|
|
971
|
+
*/
|
|
972
|
+
total?: boolean;
|
|
973
|
+
/**
|
|
974
|
+
* Indicates if the current cell represents the first level of a hierarchy.
|
|
975
|
+
*/
|
|
976
|
+
root?: boolean;
|
|
977
|
+
/**
|
|
978
|
+
* Indicates if the current cell can be expanded.
|
|
979
|
+
*/
|
|
980
|
+
expandable?: boolean;
|
|
981
|
+
/**
|
|
982
|
+
* Indicates if the current cell is expanded.
|
|
983
|
+
*/
|
|
984
|
+
expanded?: boolean;
|
|
985
|
+
/**
|
|
986
|
+
* @hidden
|
|
987
|
+
*/
|
|
988
|
+
first?: boolean;
|
|
989
|
+
/**
|
|
990
|
+
* Overrides the default `icon` component.
|
|
991
|
+
*
|
|
992
|
+
* The default component is: [KendoReactIcon]({% slug api_common_icon %}).
|
|
993
|
+
*/
|
|
994
|
+
icon?: CustomComponent<IconProps & SvgIconProps>;
|
|
995
|
+
/**
|
|
996
|
+
* A callback, fired whenever the `icon` is clicked.
|
|
997
|
+
*/
|
|
998
|
+
onIconClick?: (args: KendoMouseEvent<PivotGridHeaderCellHandle, HTMLSpanElement>) => void;
|
|
999
|
+
/**
|
|
1000
|
+
* Sets the `role` property of the top-most element of the PivotGridHeaderCell.
|
|
1001
|
+
*/
|
|
1002
|
+
role?: string;
|
|
1003
|
+
}
|
|
1004
|
+
|
|
1005
|
+
/**
|
|
1006
|
+
* Represents the props of the [KendoReact PivotGrid component]({% slug api_pivotgrid_pivotgrid %}).
|
|
1007
|
+
*/
|
|
1008
|
+
export declare interface PivotGridProps {
|
|
1009
|
+
/**
|
|
1010
|
+
* Sets the `style` property of the top-most element of the PivotGrid.
|
|
1011
|
+
*/
|
|
1012
|
+
style?: React_2.CSSProperties;
|
|
1013
|
+
/**
|
|
1014
|
+
* Sets the `className` property of the top-most element of the PivotGrid in addition to the default `k-pivotgrid` class.
|
|
1015
|
+
*/
|
|
1016
|
+
className?: string;
|
|
1017
|
+
/**
|
|
1018
|
+
* Sets the `id` property of the top-most element of the PivotGrid.
|
|
1019
|
+
*/
|
|
1020
|
+
id?: string;
|
|
1021
|
+
/**
|
|
1022
|
+
* Sets the `tabIndex` property of the top-most element of the PivotGrid.
|
|
1023
|
+
*/
|
|
1024
|
+
tabIndex?: number;
|
|
1025
|
+
/**
|
|
1026
|
+
* If set to `true`, the user can use dedicated shortcuts to interact with the PivotGrid.
|
|
1027
|
+
* By default, navigation is disabled.
|
|
1028
|
+
*/
|
|
1029
|
+
navigatable?: boolean;
|
|
1030
|
+
/**
|
|
1031
|
+
* Sets the `data` of the PivotGrid.
|
|
1032
|
+
*/
|
|
1033
|
+
data?: PivotDataItem[];
|
|
1034
|
+
/**
|
|
1035
|
+
* Sets the `columns` data of the PivotGrid.
|
|
1036
|
+
*/
|
|
1037
|
+
columns?: Tuple[];
|
|
1038
|
+
/**
|
|
1039
|
+
* Sets the `rows` data of the PivotGrid.
|
|
1040
|
+
*/
|
|
1041
|
+
rows?: Tuple[];
|
|
1042
|
+
/**
|
|
1043
|
+
* The configuration of the `column` axes.
|
|
1044
|
+
*/
|
|
1045
|
+
columnAxes?: PivotGridAxis[];
|
|
1046
|
+
/**
|
|
1047
|
+
* A callback, fired whenever the `columnAxes` property should change.
|
|
1048
|
+
*/
|
|
1049
|
+
onColumnAxesChange?: (event: PivotGridAxesChangeEvent) => void;
|
|
1050
|
+
/**
|
|
1051
|
+
* The configuration of the `row` axes.
|
|
1052
|
+
*/
|
|
1053
|
+
rowAxes?: PivotGridAxis[];
|
|
1054
|
+
/**
|
|
1055
|
+
* A callback, fired whenever the `rowAxes` property should change.
|
|
1056
|
+
*/
|
|
1057
|
+
onRowAxesChange?: (event: PivotGridAxesChangeEvent) => void;
|
|
1058
|
+
/**
|
|
1059
|
+
* Overrides the default `row` component.
|
|
1060
|
+
*
|
|
1061
|
+
* The default component is: [PivotGridRow]({% slug api_pivotgrid_pivotgridrow %}).
|
|
1062
|
+
*
|
|
1063
|
+
* For more information, refer to the [PivotGrid Customization]({% slug customization_pivotgrid %}) article.
|
|
1064
|
+
*/
|
|
1065
|
+
row?: CustomComponent<PivotGridRowProps>;
|
|
1066
|
+
/**
|
|
1067
|
+
* Overrides the default `column` component.
|
|
1068
|
+
*
|
|
1069
|
+
* The default component is: [PivotGridColumn]({% slug api_pivotgrid_pivotgridcolumn %}).
|
|
1070
|
+
*
|
|
1071
|
+
* For more information, refer to the [PivotGrid Customization]({% slug customization_pivotgrid %}) article.
|
|
1072
|
+
*/
|
|
1073
|
+
column?: CustomComponent<PivotGridColumnProps>;
|
|
1074
|
+
/**
|
|
1075
|
+
* Overrides the default `cell` component.
|
|
1076
|
+
*
|
|
1077
|
+
* The default component is: [PivotGridCell]({% slug api_pivotgrid_pivotgridcell %}).
|
|
1078
|
+
*
|
|
1079
|
+
* For more information, refer to the [PivotGrid Customization]({% slug customization_pivotgrid %}) article.
|
|
1080
|
+
*/
|
|
1081
|
+
cell?: CustomComponent<PivotGridCellProps>;
|
|
1082
|
+
/**
|
|
1083
|
+
* Overrides the default `headerCell` component.
|
|
1084
|
+
*
|
|
1085
|
+
* The default component is: [PivotGridHeaderCell]({% slug api_pivotgrid_pivotgridheadercell %}).
|
|
1086
|
+
*
|
|
1087
|
+
* For more information, refer to the [PivotGrid Customization]({% slug customization_pivotgrid %}) article.
|
|
1088
|
+
*/
|
|
1089
|
+
headerCell?: CustomComponent<PivotGridHeaderCellProps>;
|
|
1090
|
+
/**
|
|
1091
|
+
* Overrides the default column-headers `row` component.
|
|
1092
|
+
*
|
|
1093
|
+
* The default component is: [PivotGridRow]({% slug api_pivotgrid_pivotgridrow %}).
|
|
1094
|
+
*
|
|
1095
|
+
* For more information, refer to the [PivotGrid Customization]({% slug customization_pivotgrid %}) article.
|
|
1096
|
+
*/
|
|
1097
|
+
columnHeadersRow?: React_2.ComponentType<PivotGridRowProps>;
|
|
1098
|
+
/**
|
|
1099
|
+
* Overrides the default column-headers `column` component.
|
|
1100
|
+
*
|
|
1101
|
+
* The default component is: [PivotGridColumn]({% slug api_pivotgrid_pivotgridcolumn %}).
|
|
1102
|
+
*
|
|
1103
|
+
* For more information, refer to the [PivotGrid Customization]({% slug customization_pivotgrid %}) article.
|
|
1104
|
+
*/
|
|
1105
|
+
columnHeadersColumn?: React_2.ComponentType<PivotGridColumnProps>;
|
|
1106
|
+
/**
|
|
1107
|
+
* Overrides the default column-headers `headerCell` component.
|
|
1108
|
+
*
|
|
1109
|
+
* The default component is: [PivotGridHeaderCell]({% slug api_pivotgrid_pivotgridheadercell %}).
|
|
1110
|
+
*
|
|
1111
|
+
* For more information, refer to the [PivotGrid Customization]({% slug customization_pivotgrid %}) article.
|
|
1112
|
+
*/
|
|
1113
|
+
columnHeadersCell?: React_2.ComponentType<PivotGridHeaderCellProps>;
|
|
1114
|
+
/**
|
|
1115
|
+
* Overrides the default row-headers `row` component.
|
|
1116
|
+
*
|
|
1117
|
+
* The default component is: [PivotGridRow]({% slug api_pivotgrid_pivotgridrow %}).
|
|
1118
|
+
*
|
|
1119
|
+
* For more information, refer to the [PivotGrid Customization]({% slug customization_pivotgrid %}) article.
|
|
1120
|
+
*/
|
|
1121
|
+
rowHeadersRow?: React_2.ComponentType<PivotGridRowProps>;
|
|
1122
|
+
/**
|
|
1123
|
+
* Overrides the default row-headers `column` component.
|
|
1124
|
+
*
|
|
1125
|
+
* The default component is: [PivotGridColumn]({% slug api_pivotgrid_pivotgridcolumn %}).
|
|
1126
|
+
*
|
|
1127
|
+
* For more information, refer to the [PivotGrid Customization]({% slug customization_pivotgrid %}) article.
|
|
1128
|
+
*/
|
|
1129
|
+
rowHeadersColumn?: React_2.ComponentType<PivotGridColumnProps>;
|
|
1130
|
+
/**
|
|
1131
|
+
* Overrides the default row-headers `headerCell` component.
|
|
1132
|
+
*
|
|
1133
|
+
* The default component is: [PivotGridHeaderCell]({% slug api_pivotgrid_pivotgridheadercell %}).
|
|
1134
|
+
*
|
|
1135
|
+
* For more information, refer to the [PivotGrid Customization]({% slug customization_pivotgrid %}) article.
|
|
1136
|
+
*/
|
|
1137
|
+
rowHeadersCell?: React_2.ComponentType<PivotGridHeaderCellProps>;
|
|
1138
|
+
/**
|
|
1139
|
+
* Overrides the default data `row` component.
|
|
1140
|
+
*
|
|
1141
|
+
* The default component is: [PivotGridRow]({% slug api_pivotgrid_pivotgridrow %}).
|
|
1142
|
+
*
|
|
1143
|
+
* For more information, refer to the [PivotGrid Customization]({% slug customization_pivotgrid %}) article.
|
|
1144
|
+
*/
|
|
1145
|
+
dataRow?: React_2.ComponentType<PivotGridRowProps>;
|
|
1146
|
+
/**
|
|
1147
|
+
* Overrides the default data `column` component.
|
|
1148
|
+
*
|
|
1149
|
+
* The default component is: [PivotGridColumn]({% slug api_pivotgrid_pivotgridcolumn %}).
|
|
1150
|
+
*
|
|
1151
|
+
* For more information, refer to the [PivotGrid Customization]({% slug customization_pivotgrid %}) article.
|
|
1152
|
+
*/
|
|
1153
|
+
dataColumn?: React_2.ComponentType<PivotGridColumnProps>;
|
|
1154
|
+
}
|
|
1155
|
+
|
|
1156
|
+
/**
|
|
1157
|
+
* Represents the [KendoReact PivotGridRow component]({% slug api_pivotgrid_pivotgridrowprops %}).
|
|
1158
|
+
*/
|
|
1159
|
+
export declare const PivotGridRow: React_2.ForwardRefExoticComponent<PivotGridRowProps & React_2.RefAttributes<PivotGridRowHandle | null>>;
|
|
1160
|
+
|
|
1161
|
+
/**
|
|
1162
|
+
* Represents the object which is passed to the [`ref`](https://reactjs.org/docs/refs-and-the-dom.html) callback of the PivotGridRow component.
|
|
1163
|
+
*/
|
|
1164
|
+
export declare interface PivotGridRowHandle {
|
|
1165
|
+
props: PivotGridRowProps;
|
|
1166
|
+
element: HTMLTableRowElement | null;
|
|
1167
|
+
}
|
|
1168
|
+
|
|
1169
|
+
/**
|
|
1170
|
+
* Represents the props of the [KendoReact PivotGridRow component]({% slug api_pivotgrid_pivotgridrow %}).
|
|
1171
|
+
*/
|
|
1172
|
+
export declare interface PivotGridRowProps extends KendoMouse<PivotGridRowHandle, HTMLTableRowElement> {
|
|
1173
|
+
/**
|
|
1174
|
+
* Sets the `className` property of the top-most element of the PivotGridRow in addition to the default `k-pivotgrid-row` class.
|
|
1175
|
+
*/
|
|
1176
|
+
className?: string;
|
|
1177
|
+
/**
|
|
1178
|
+
* Sets the `id` property of the top-most element of the PivotGridRow.
|
|
1179
|
+
*/
|
|
1180
|
+
id?: string;
|
|
1181
|
+
/**
|
|
1182
|
+
* Sets the `children` property of the top-most element of the PivotGridRow.
|
|
1183
|
+
*/
|
|
1184
|
+
children?: React_2.ReactNode;
|
|
1185
|
+
/**
|
|
1186
|
+
* Sets the `style` property of the top-most element of the PivotGridRow.
|
|
1187
|
+
*/
|
|
1188
|
+
style?: React_2.CSSProperties;
|
|
1189
|
+
/**
|
|
1190
|
+
* Sets the `tabIndex` property of the top-most element of the PivotGridRow.
|
|
1191
|
+
*/
|
|
1192
|
+
tabIndex?: number;
|
|
1193
|
+
/**
|
|
1194
|
+
* Represents the `path` leading to the current `row`.
|
|
1195
|
+
*/
|
|
1196
|
+
path?: string[];
|
|
1197
|
+
/**
|
|
1198
|
+
* Sets the `role` property of the top-most element of the PivotGridRow.
|
|
1199
|
+
*/
|
|
1200
|
+
role?: string;
|
|
1201
|
+
/**
|
|
1202
|
+
* Sets the `aria-owns` property of the top-most element of the PivotGridRow.
|
|
1203
|
+
*/
|
|
1204
|
+
ariaOwns?: string;
|
|
1205
|
+
}
|
|
1206
|
+
|
|
1207
|
+
/**
|
|
1208
|
+
* represents the `data` structure of the [TreeView]({% slug api_treeview_treeview %}) component inside the `PivotGrid`.
|
|
1209
|
+
*/
|
|
1210
|
+
export declare interface PivotGridTreeViewData {
|
|
1211
|
+
checked?: boolean;
|
|
1212
|
+
value?: string;
|
|
1213
|
+
dataItem?: PivotGridField[];
|
|
1214
|
+
}
|
|
1215
|
+
|
|
1216
|
+
/**
|
|
1217
|
+
* A [React higher-order component](https://reactjs.org/docs/higher-order-components.html) which provides data-binding to local data.
|
|
1218
|
+
*/
|
|
1219
|
+
export declare const PivotLocalDataService: (props: PivotLocalDataServiceProps) => any;
|
|
1220
|
+
|
|
1221
|
+
/**
|
|
1222
|
+
* Represents the arguments of the [usePivotLocalDataService]({% slug api_pivotgrid_usepivotlocaldataservice %}) hook.
|
|
1223
|
+
*/
|
|
1224
|
+
export declare interface PivotLocalDataServiceArgs {
|
|
1225
|
+
/**
|
|
1226
|
+
* Represents the dimensions object of the [usePivotLocalDataService]({% slug api_pivotgrid_usepivotlocaldataservice %}) hook and the [PivotLocalDataService]({% slug api_pivotgrid_pivotlocaldataservice %}) component.
|
|
1227
|
+
*/
|
|
1228
|
+
dimensions: {
|
|
1229
|
+
[key: string]: Dimension;
|
|
1230
|
+
};
|
|
1231
|
+
/**
|
|
1232
|
+
* Represents the measures collection of the [usePivotLocalDataService]({% slug api_pivotgrid_usepivotlocaldataservice %}) hook and the [PivotLocalDataService]({% slug api_pivotgrid_pivotlocaldataservice %}) component.
|
|
1233
|
+
*/
|
|
1234
|
+
measures: Measure[];
|
|
1235
|
+
/**
|
|
1236
|
+
* Represents the local data of the [usePivotLocalDataService]({% slug api_pivotgrid_usepivotlocaldataservice %}) hook and the [PivotLocalDataService]({% slug api_pivotgrid_pivotlocaldataservice %}) component.
|
|
1237
|
+
*/
|
|
1238
|
+
data: any[];
|
|
1239
|
+
/**
|
|
1240
|
+
* Represents the default column axes configuration of the [usePivotLocalDataService]({% slug api_pivotgrid_usepivotlocaldataservice %}) hook and the [PivotLocalDataService]({% slug api_pivotgrid_pivotlocaldataservice %}) component.
|
|
1241
|
+
*/
|
|
1242
|
+
defaultColumnAxes: PivotGridAxis[];
|
|
1243
|
+
/**
|
|
1244
|
+
* Represents the default row axes configuration of the [usePivotLocalDataService]({% slug api_pivotgrid_usepivotlocaldataservice %}) hook and the [PivotLocalDataService]({% slug api_pivotgrid_pivotlocaldataservice %}) component.
|
|
1245
|
+
*/
|
|
1246
|
+
defaultRowAxes: PivotGridAxis[];
|
|
1247
|
+
/**
|
|
1248
|
+
* Represents the default measure axes configuration of the [usePivotLocalDataService]({% slug api_pivotgrid_usepivotlocaldataservice %}) hook and the [PivotLocalDataService]({% slug api_pivotgrid_pivotlocaldataservice %}) component.
|
|
1249
|
+
*/
|
|
1250
|
+
defaultMeasureAxes: PivotGridAxis[];
|
|
1251
|
+
/**
|
|
1252
|
+
* Represents the default sort descriptors of the [usePivotLocalDataService]({% slug api_pivotgrid_usepivotlocaldataservice %}) hook and the [PivotLocalDataService]({% slug api_pivotgrid_pivotlocaldataservice %}) component.
|
|
1253
|
+
*/
|
|
1254
|
+
defaultSort: SortDescriptor[];
|
|
1255
|
+
/**
|
|
1256
|
+
* Represents the default filter descriptors of the [usePivotLocalDataService]({% slug api_pivotgrid_usepivotlocaldataservice %}) hook and the [PivotLocalDataService]({% slug api_pivotgrid_pivotlocaldataservice %}) component.
|
|
1257
|
+
*/
|
|
1258
|
+
defaultFilter: FilterDescriptor[];
|
|
1259
|
+
}
|
|
1260
|
+
|
|
1261
|
+
/**
|
|
1262
|
+
* Represents the properties of the [PivotLocalDataService]({% slug api_pivotgrid_pivotlocaldataservice %}) component.
|
|
1263
|
+
*/
|
|
1264
|
+
export declare interface PivotLocalDataServiceProps extends PivotLocalDataServiceArgs {
|
|
1265
|
+
/**
|
|
1266
|
+
* Represents the children prop of the [PivotLocalDataService]({% slug api_pivotgrid_pivotlocaldataservice %}) component.
|
|
1267
|
+
*/
|
|
1268
|
+
children: (args: PivotLocalDataServiceState) => any;
|
|
1269
|
+
}
|
|
1270
|
+
|
|
1271
|
+
/**
|
|
1272
|
+
* Represents the `state` of the [usePivotLocalDataService]({% slug api_pivotgrid_usepivotlocaldataservice %}) hook and the [PivotLocalDataService]({% slug api_pivotgrid_pivotlocaldataservice %}) component.
|
|
1273
|
+
*/
|
|
1274
|
+
export declare interface PivotLocalDataServiceState {
|
|
1275
|
+
/**
|
|
1276
|
+
* Represents the `PivotGrid` component props.
|
|
1277
|
+
*/
|
|
1278
|
+
pivotProps: PivotGridProps;
|
|
1279
|
+
/**
|
|
1280
|
+
* Represents the `PivotGridConfigurator` component props.
|
|
1281
|
+
*/
|
|
1282
|
+
configuratorProps: PivotGridConfiguratorProps;
|
|
1283
|
+
/**
|
|
1284
|
+
* Represents an object containing additional state data.
|
|
1285
|
+
*/
|
|
1286
|
+
state: {
|
|
1287
|
+
loading: boolean;
|
|
1288
|
+
};
|
|
1289
|
+
}
|
|
1290
|
+
|
|
1291
|
+
/**
|
|
1292
|
+
* A [React higher-order component](https://reactjs.org/docs/higher-order-components.html) which provides data-binding to an OLAP service.
|
|
1293
|
+
*/
|
|
1294
|
+
export declare const PivotOLAPService: (props: PivotOLAPServiceProps) => any;
|
|
1295
|
+
|
|
1296
|
+
/**
|
|
1297
|
+
* Represents the arguments of the [usePivotOLAPService]({% slug api_pivotgrid_usepivotolapservice %}) hook.
|
|
1298
|
+
*/
|
|
1299
|
+
export declare interface PivotOLAPServiceArgs {
|
|
1300
|
+
url: string;
|
|
1301
|
+
cube: string;
|
|
1302
|
+
catalog: string;
|
|
1303
|
+
defaultColumnAxes?: PivotGridAxis[];
|
|
1304
|
+
defaultRowAxes?: PivotGridAxis[];
|
|
1305
|
+
defaultMeasureAxes?: PivotGridAxis[];
|
|
1306
|
+
defaultSort?: SortDescriptor[];
|
|
1307
|
+
defaultFilter?: FilterDescriptor[];
|
|
1308
|
+
}
|
|
1309
|
+
|
|
1310
|
+
/**
|
|
1311
|
+
* Represents the properties of the [PivotOLAPService]({% slug api_pivotgrid_pivotolapservice %}) component.
|
|
1312
|
+
*/
|
|
1313
|
+
export declare interface PivotOLAPServiceProps extends PivotOLAPServiceArgs {
|
|
1314
|
+
children: (args: PivotOLAPServiceState) => any;
|
|
1315
|
+
}
|
|
1316
|
+
|
|
1317
|
+
/**
|
|
1318
|
+
* Represents the `state` of the [usePivotOLAPService]({% slug api_pivotgrid_usepivotolapservice %}) hook and the [PivotOLAPService]({% slug api_pivotgrid_pivotolapservice %}) component.
|
|
1319
|
+
*/
|
|
1320
|
+
export declare interface PivotOLAPServiceState {
|
|
1321
|
+
pivotProps: PivotGridProps;
|
|
1322
|
+
configuratorProps: PivotGridConfiguratorProps;
|
|
1323
|
+
state: {
|
|
1324
|
+
loading: boolean;
|
|
1325
|
+
};
|
|
1326
|
+
}
|
|
1327
|
+
|
|
1328
|
+
export { sumAggregate }
|
|
1329
|
+
|
|
1330
|
+
export { Tuple }
|
|
1331
|
+
|
|
1332
|
+
/**
|
|
1333
|
+
* A [custom React hook](https://reactjs.org/docs/hooks-custom.html) which provides data-binding to local data.
|
|
1334
|
+
*/
|
|
1335
|
+
export declare const usePivotLocalDataService: (args: PivotLocalDataServiceArgs) => PivotLocalDataServiceState;
|
|
1336
|
+
|
|
1337
|
+
/**
|
|
1338
|
+
* A [custom React hook](https://reactjs.org/docs/hooks-custom.html) which provides data-binding to an OLAP service.
|
|
1339
|
+
*/
|
|
1340
|
+
export declare const usePivotOLAPService: (args: PivotOLAPServiceArgs) => PivotOLAPServiceState;
|
|
1341
|
+
|
|
1342
|
+
export { }
|