@progress/kendo-react-pivotgrid 13.3.0 → 13.4.0-develop.2
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.d.ts +303 -0
- package/components/AxesEditor.d.ts +57 -0
- package/components/AxisEditor.d.ts +65 -0
- package/components/AxisEditor.mjs +3 -3
- package/components/AxisFilterFieldsEditor.d.ts +145 -0
- package/components/Cell.d.ts +114 -0
- package/components/Column.d.ts +91 -0
- package/components/Configurator.d.ts +140 -0
- package/components/ConfiguratorButton.d.ts +89 -0
- package/components/ConfiguratorButton.mjs +4 -4
- package/components/ConfiguratorEditor.d.ts +144 -0
- package/components/ConfiguratorEditor.js +1 -1
- package/components/ConfiguratorEditor.mjs +1 -2
- package/components/Container.d.ts +64 -0
- package/components/EditorContext.d.ts +14 -0
- package/components/FieldsEditor.d.ts +87 -0
- package/components/FieldsEditor.mjs +3 -3
- package/components/HeaderCell.d.ts +144 -0
- package/components/HeaderCell.mjs +4 -4
- package/components/Row.d.ts +99 -0
- package/dist/cdn/js/kendo-react-pivotgrid.js +1 -1
- package/hooks/index.d.ts +9 -0
- package/hooks/useExpansion.d.ts +26 -0
- package/hooks/useHeaders.d.ts +18 -0
- package/hooks/useHorizontalScrollSync.d.ts +12 -0
- package/hooks/usePivotConfiguratorEditor.d.ts +90 -0
- package/hooks/usePivotLocalDataService.d.ts +86 -0
- package/hooks/usePivotOLAPService.d.ts +84 -0
- package/hooks/useVerticalScrollSync.d.ts +12 -0
- package/index.d.mts +18 -1827
- package/index.d.ts +18 -1827
- package/messages/index.d.ts +77 -0
- package/models/index.d.ts +96 -0
- package/package-metadata.d.ts +12 -0
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +10 -16
- package/package.json +10 -10
- package/shared/PivotGridConfiguratorEditorEventsContext.d.ts +20 -0
- package/shared/PivotGridConfiguratorEditorStateContext.d.ts +13 -0
- package/shared/index.d.ts +9 -0
- package/utils/index.d.ts +54 -0
package/index.d.ts
CHANGED
|
@@ -5,1830 +5,21 @@
|
|
|
5
5
|
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
import { FormProps } from '@progress/kendo-react-form';
|
|
27
|
-
import { FormRenderProps } from '@progress/kendo-react-form';
|
|
28
|
-
import { HierarchyField } from '@progress/kendo-pivotgrid-common';
|
|
29
|
-
import { IconProps } from '@progress/kendo-react-common';
|
|
30
|
-
import { KendoMouse } from '@progress/kendo-react-common';
|
|
31
|
-
import { KendoMouseEvent } from '@progress/kendo-react-common';
|
|
32
|
-
import { KPIField } from '@progress/kendo-pivotgrid-common';
|
|
33
|
-
import { KPIMeasureField } from '@progress/kendo-pivotgrid-common';
|
|
34
|
-
import { LabelProps } from '@progress/kendo-react-labels';
|
|
35
|
-
import { LevelField } from '@progress/kendo-pivotgrid-common';
|
|
36
|
-
import { maxAggregate } from '@progress/kendo-pivotgrid-common';
|
|
37
|
-
import { Measure } from '@progress/kendo-pivotgrid-common';
|
|
38
|
-
import { MeasureField } from '@progress/kendo-pivotgrid-common';
|
|
39
|
-
import { Member } from '@progress/kendo-pivotgrid-common';
|
|
40
|
-
import { MemberField } from '@progress/kendo-pivotgrid-common';
|
|
41
|
-
import { minAggregate } from '@progress/kendo-pivotgrid-common';
|
|
42
|
-
import { PIVOT_CONFIGURATOR_ACTION } from '@progress/kendo-pivotgrid-common';
|
|
43
|
-
import { PivotDataItem } from '@progress/kendo-pivotgrid-common';
|
|
44
|
-
import { PivotGridAxis } from '@progress/kendo-pivotgrid-common';
|
|
45
|
-
import { PivotGridConfiguratorState } from '@progress/kendo-pivotgrid-common';
|
|
46
|
-
import { PivotGridField } from '@progress/kendo-pivotgrid-common';
|
|
47
|
-
import * as React_2 from 'react';
|
|
48
|
-
import { SortDescriptor } from '@progress/kendo-data-query';
|
|
49
|
-
import { sumAggregate } from '@progress/kendo-pivotgrid-common';
|
|
50
|
-
import { SvgIconProps } from '@progress/kendo-react-common';
|
|
51
|
-
import { TreeViewProps } from '@progress/kendo-react-treeview';
|
|
52
|
-
import { Tuple } from '@progress/kendo-pivotgrid-common';
|
|
53
|
-
|
|
54
|
-
export { Aggregate }
|
|
55
|
-
|
|
56
|
-
export { AggregateType }
|
|
57
|
-
|
|
58
|
-
export { averageAggregate }
|
|
59
|
-
|
|
60
|
-
export { AxisDataItem }
|
|
61
|
-
|
|
62
|
-
export { AxisRow }
|
|
63
|
-
|
|
64
|
-
export { createAggregate }
|
|
65
|
-
|
|
66
|
-
/**
|
|
67
|
-
* Generates suitable data for Charting visualization.
|
|
68
|
-
*
|
|
69
|
-
* @param rows - The PivotGrid's rows prop.
|
|
70
|
-
* @param columns - The PivotGrid's columns prop.
|
|
71
|
-
* @param data - The PivotGrid's data prop.
|
|
72
|
-
* @returns - Suitable data for Charting visualization.
|
|
73
|
-
*/
|
|
74
|
-
export declare const dataCells: (rows?: Tuple[], columns?: Tuple[], data?: PivotDataItem[]) => {
|
|
75
|
-
row: string[];
|
|
76
|
-
cells: PivotDataItem[];
|
|
77
|
-
}[];
|
|
78
|
-
|
|
79
|
-
export { Dimension }
|
|
80
|
-
|
|
81
|
-
export { DimensionField }
|
|
82
|
-
|
|
83
|
-
declare enum EXTENDED_CONFIGURATOR_ACTION {
|
|
84
|
-
toggleExpansion = "PIVOT_CONFIGURATOR_ACTION_TOGGLE_EXPANSION"
|
|
85
|
-
}
|
|
86
|
-
|
|
87
|
-
export { HierarchyField }
|
|
88
|
-
|
|
89
|
-
export { KPIField }
|
|
90
|
-
|
|
91
|
-
export { KPIMeasureField }
|
|
92
|
-
|
|
93
|
-
export { LevelField }
|
|
94
|
-
|
|
95
|
-
export { maxAggregate }
|
|
96
|
-
|
|
97
|
-
export { Measure }
|
|
98
|
-
|
|
99
|
-
export { MeasureField }
|
|
100
|
-
|
|
101
|
-
export { Member }
|
|
102
|
-
|
|
103
|
-
export { MemberField }
|
|
104
|
-
|
|
105
|
-
export { minAggregate }
|
|
106
|
-
|
|
107
|
-
declare type PIVOT_CONFIGURATOR_ACTION_TYPE = PIVOT_CONFIGURATOR_ACTION | EXTENDED_CONFIGURATOR_ACTION;
|
|
108
|
-
|
|
109
|
-
export { PivotDataItem }
|
|
110
|
-
|
|
111
|
-
/**
|
|
112
|
-
* Represents the [KendoReact PivotGrid component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridprops).
|
|
113
|
-
*/
|
|
114
|
-
export declare const PivotGrid: React_2.ForwardRefExoticComponent<PivotGridProps & React_2.RefAttributes<PivotGridHandle | null>>;
|
|
115
|
-
|
|
116
|
-
/**
|
|
117
|
-
* Represents the event arguments of the [`onColumnAxesChange`](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridprops#toc-oncolumnaxeschange) and [`onRowAxesChange`](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridprops#toc-onrowaxeschange) callbacks of the [`PivotGrid`](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgrid) component.
|
|
118
|
-
*/
|
|
119
|
-
export declare interface PivotGridAxesChangeEvent {
|
|
120
|
-
/**
|
|
121
|
-
* The new axes configuration value.
|
|
122
|
-
*/
|
|
123
|
-
value: PivotGridAxis[];
|
|
124
|
-
/**
|
|
125
|
-
* The handle of the PivotGrid component.
|
|
126
|
-
*/
|
|
127
|
-
target: PivotGridHandle | null;
|
|
128
|
-
/**
|
|
129
|
-
* The DOM event that triggered the change.
|
|
130
|
-
*/
|
|
131
|
-
syntheticEvent: React.SyntheticEvent;
|
|
132
|
-
}
|
|
133
|
-
|
|
134
|
-
/**
|
|
135
|
-
* Represents the [KendoReact PivotGridAxesEditor component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridaxeseditorprops).
|
|
136
|
-
*/
|
|
137
|
-
export declare const PivotGridAxesEditor: React_2.ForwardRefExoticComponent<PivotGridAxesEditorProps & React_2.RefAttributes<PivotGridAxesEditorHandle>>;
|
|
138
|
-
|
|
139
|
-
/**
|
|
140
|
-
* Represents the object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the PivotGridAxesEditor component.
|
|
141
|
-
*/
|
|
142
|
-
export declare interface PivotGridAxesEditorHandle {
|
|
143
|
-
/**
|
|
144
|
-
* The properties passed to the PivotGridAxesEditor component.
|
|
145
|
-
*/
|
|
146
|
-
props: PivotGridAxesEditorProps;
|
|
147
|
-
/**
|
|
148
|
-
* The DOM element of the PivotGridAxesEditor component.
|
|
149
|
-
*/
|
|
150
|
-
element: HTMLDivElement | null;
|
|
151
|
-
}
|
|
152
|
-
|
|
153
|
-
/**
|
|
154
|
-
* Represents the props of the [KendoReact PivotGridAxesEditor component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridaxeseditor).
|
|
155
|
-
*/
|
|
156
|
-
export declare interface PivotGridAxesEditorProps extends FieldProps {
|
|
157
|
-
/**
|
|
158
|
-
* Represents the `value` of the AxesEditor.
|
|
159
|
-
*
|
|
160
|
-
* The `value` is an array of [PivotGridAxis](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridaxis)
|
|
161
|
-
*/
|
|
162
|
-
value: PivotGridAxis[];
|
|
163
|
-
/**
|
|
164
|
-
* Indicates which of the three available axes are represented by the editor:
|
|
165
|
-
* - columnAxes
|
|
166
|
-
* - rowAxes
|
|
167
|
-
* - measureAxes
|
|
168
|
-
*/
|
|
169
|
-
field: string;
|
|
170
|
-
/**
|
|
171
|
-
* Overrides the default `chipList` component.
|
|
172
|
-
*
|
|
173
|
-
* The default component is: [KendoReactChipList](https://www.telerik.com/kendo-react-ui/components/buttons/api/chiplist).
|
|
174
|
-
*/
|
|
175
|
-
chipList?: CustomComponent<ChipListProps>;
|
|
176
|
-
/**
|
|
177
|
-
* Sets the `className` props of the ClipList component.
|
|
178
|
-
*/
|
|
179
|
-
className?: string;
|
|
180
|
-
}
|
|
181
|
-
|
|
182
|
-
export { PivotGridAxis }
|
|
183
|
-
|
|
184
|
-
/**
|
|
185
|
-
* Represents the [KendoReact PivotGridAxisEditor component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridaxiseditorprops).
|
|
186
|
-
*/
|
|
187
|
-
export declare const PivotGridAxisEditor: React_2.ForwardRefExoticComponent<PivotGridAxisEditorProps & React_2.RefAttributes<PivotGridAxisEditorHandle | null>>;
|
|
188
|
-
|
|
189
|
-
/**
|
|
190
|
-
* Represents the object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the PivotGridAxisEditor component.
|
|
191
|
-
*/
|
|
192
|
-
export declare interface PivotGridAxisEditorHandle {
|
|
193
|
-
/**
|
|
194
|
-
* The properties passed to the PivotGridAxisEditor component.
|
|
195
|
-
*/
|
|
196
|
-
props: PivotGridAxisEditorProps;
|
|
197
|
-
/**
|
|
198
|
-
* The DOM element of the PivotGridAxisEditor component.
|
|
199
|
-
*/
|
|
200
|
-
element: HTMLSpanElement | null;
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
/**
|
|
204
|
-
* Represents the props of the [KendoReact PivotGridAxisEditor component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridaxiseditor).
|
|
205
|
-
*/
|
|
206
|
-
export declare interface PivotGridAxisEditorProps extends ChipProps {
|
|
207
|
-
/**
|
|
208
|
-
* Represents the `dataItem` of the AxisEditor.
|
|
209
|
-
*
|
|
210
|
-
* The `dataItem` is a single [PivotGridAxis](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridaxis) object.
|
|
211
|
-
*/
|
|
212
|
-
dataItem: PivotGridAxis;
|
|
213
|
-
/**
|
|
214
|
-
* Overrides the default `chip` component.
|
|
215
|
-
*
|
|
216
|
-
* The default component is: [KendoReactChip](https://www.telerik.com/kendo-react-ui/components/buttons/api/chip).
|
|
217
|
-
*/
|
|
218
|
-
chip?: CustomComponent<ChipProps>;
|
|
219
|
-
/**
|
|
220
|
-
* Overrides the default `dropClue` component.
|
|
221
|
-
*
|
|
222
|
-
* The default component is: `(props) => <div className="k-grouping-dropclue" style={{ position: 'relative', zIndex: 10000 }} {...props}/>`
|
|
223
|
-
*/
|
|
224
|
-
dropClue?: CustomComponent<any>;
|
|
225
|
-
/**
|
|
226
|
-
* Overrides the default `columnMenuTextColumn` component.
|
|
227
|
-
*
|
|
228
|
-
* The default component is: [KendoReactColumnMenuTextColumn](https://www.telerik.com/kendo-react-ui/components/datatools/api/columnmenutextcolumn).
|
|
229
|
-
*/
|
|
230
|
-
columnMenuTextColumn?: CustomComponent<ColumnMenuProps>;
|
|
231
|
-
/**
|
|
232
|
-
* Overrides the default `filterFieldsEditor` component.
|
|
233
|
-
*
|
|
234
|
-
* The default component is: [PivotGridAxisFilterFieldsEditor](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridaxisfilterfieldseditor).
|
|
235
|
-
*/
|
|
236
|
-
filterFieldsEditor?: CustomComponent<PivotGridAxisFilterFieldsEditorProps>;
|
|
237
|
-
}
|
|
238
|
-
|
|
239
|
-
/**
|
|
240
|
-
* Represents the event arguments of the `PivotGridAxisFilterField` expand event.
|
|
241
|
-
*/
|
|
242
|
-
export declare interface PivotGridAxisFilterFieldExpandEvent {
|
|
243
|
-
/**
|
|
244
|
-
* The handle of the component that triggered the event.
|
|
245
|
-
*/
|
|
246
|
-
target: PivotGridAxisFilterFieldsEditorHandle;
|
|
247
|
-
/**
|
|
248
|
-
* The field that was expanded.
|
|
249
|
-
*/
|
|
250
|
-
value: PivotGridField;
|
|
251
|
-
/**
|
|
252
|
-
* The DOM event that triggered the expand.
|
|
253
|
-
*/
|
|
254
|
-
syntheticEvent: React_2.SyntheticEvent;
|
|
255
|
-
}
|
|
256
|
-
|
|
257
|
-
/**
|
|
258
|
-
* Represents the [KendoReact PivotGridAxisFilterFieldsEditor component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridaxisfilterfieldseditorprops).
|
|
259
|
-
*/
|
|
260
|
-
export declare const PivotGridAxisFilterFieldsEditor: React_2.ForwardRefExoticComponent<PivotGridAxisFilterFieldsEditorProps & React_2.RefAttributes<PivotGridAxisFilterFieldsEditorHandle | null>>;
|
|
261
|
-
|
|
262
|
-
/**
|
|
263
|
-
* Represents the object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the PivotGridAxisFilterFieldsEditor component.
|
|
264
|
-
*/
|
|
265
|
-
export declare interface PivotGridAxisFilterFieldsEditorHandle {
|
|
266
|
-
/**
|
|
267
|
-
* The properties passed to the PivotGridAxisFilterFieldsEditor component.
|
|
268
|
-
*/
|
|
269
|
-
props: PivotGridAxisFilterFieldsEditorProps;
|
|
270
|
-
/**
|
|
271
|
-
* The DOM element of the PivotGridAxisFilterFieldsEditor component.
|
|
272
|
-
*/
|
|
273
|
-
element: HTMLDivElement | null;
|
|
274
|
-
}
|
|
275
|
-
|
|
276
|
-
/**
|
|
277
|
-
* Represents the props of the [KendoReact PivotGridAxisFilterFieldsEditor component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridaxisfilterfieldseditor).
|
|
278
|
-
*/
|
|
279
|
-
export declare interface PivotGridAxisFilterFieldsEditorProps {
|
|
280
|
-
/**
|
|
281
|
-
* Sets the `className` property of the top-most element of the PivotGridAxisFilterFieldsEditor in addition to the default `k-columnmenu-item-wrapper` class.
|
|
282
|
-
*/
|
|
283
|
-
className?: string;
|
|
284
|
-
/**
|
|
285
|
-
* Sets the `id` property of the top-most element of the PivotGridAxisFilterFieldsEditor.
|
|
286
|
-
*/
|
|
287
|
-
id?: string;
|
|
288
|
-
/**
|
|
289
|
-
* Sets the `tabIndex` property of the top-most element of the PivotGridAxisFilterFieldsEditor.
|
|
290
|
-
*/
|
|
291
|
-
tabIndex?: number;
|
|
292
|
-
/**
|
|
293
|
-
* Sets the `style` property of the top-most element of the PivotGridAxisFilterFieldsEditor.
|
|
294
|
-
*/
|
|
295
|
-
style?: React_2.CSSProperties;
|
|
296
|
-
/**
|
|
297
|
-
* Sets the `data` of the PivotGridAxisFilterFieldsEditor.
|
|
298
|
-
*
|
|
299
|
-
* The `data` represents all fields available for filtering.
|
|
300
|
-
*/
|
|
301
|
-
data?: PivotGridField[];
|
|
302
|
-
/**
|
|
303
|
-
* Represents the `dataItem` of the AxisEditor.
|
|
304
|
-
*
|
|
305
|
-
* The `dataItem` is a single [PivotGridAxis](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridaxis) object.
|
|
306
|
-
*/
|
|
307
|
-
dataItem: PivotGridAxis;
|
|
308
|
-
/**
|
|
309
|
-
* Represents the initial filter value before additional operations are executed.
|
|
310
|
-
*/
|
|
311
|
-
defaultFilter?: FilterDescriptor;
|
|
312
|
-
/**
|
|
313
|
-
* Indicates which of the three available axes are represented by the editor:
|
|
314
|
-
* - columnAxes
|
|
315
|
-
* - rowAxes
|
|
316
|
-
* - measureAxes
|
|
317
|
-
*/
|
|
318
|
-
axes: string;
|
|
319
|
-
/**
|
|
320
|
-
* Overrides the default `columnMenuItem` component.
|
|
321
|
-
*
|
|
322
|
-
* The default component is: [KendoReactColumnMenuItem](https://www.telerik.com/kendo-react-ui/components/datatools/api/columnmenuitem).
|
|
323
|
-
*/
|
|
324
|
-
columnMenuItem?: CustomComponent<ColumnMenuItemProps>;
|
|
325
|
-
/**
|
|
326
|
-
* Overrides the default `columnMenuForm` component.
|
|
327
|
-
*
|
|
328
|
-
* The default component is: [KendoReactColumnMenuForm](https://www.telerik.com/kendo-react-ui/components/datatools/api/columnmenuform).
|
|
329
|
-
*/
|
|
330
|
-
columnMenuForm?: CustomComponent<ColumnMenuFormProps>;
|
|
331
|
-
/**
|
|
332
|
-
* Overrides the default `resetButton` component.
|
|
333
|
-
*
|
|
334
|
-
* The default component is: [KendoReactButton](https://www.telerik.com/kendo-react-ui/components/buttons/api/button).
|
|
335
|
-
*/
|
|
336
|
-
resetButton?: CustomComponent<ButtonProps>;
|
|
337
|
-
/**
|
|
338
|
-
* Overrides the default `applyButton` component.
|
|
339
|
-
*
|
|
340
|
-
* The default component is: [KendoReactButton](https://www.telerik.com/kendo-react-ui/components/buttons/api/button).
|
|
341
|
-
*/
|
|
342
|
-
applyButton?: CustomComponent<ButtonProps>;
|
|
343
|
-
/**
|
|
344
|
-
* Overrides the default `treeView` component.
|
|
345
|
-
*
|
|
346
|
-
* The default component is: [KendoReactTreeView](https://www.telerik.com/kendo-react-ui/components/treeview/api/treeview).
|
|
347
|
-
*/
|
|
348
|
-
treeView?: CustomComponent<TreeViewProps>;
|
|
349
|
-
/**
|
|
350
|
-
* Overrides the default `treeView` component.
|
|
351
|
-
*
|
|
352
|
-
* The default component is: `() => <Skeleton shape={'rectangle'} style={{height: '20px', width:'calc(100% - 16px)', margin: 8}}/>`.
|
|
353
|
-
*/
|
|
354
|
-
noData?: CustomComponent<any>;
|
|
355
|
-
}
|
|
356
|
-
|
|
357
|
-
/**
|
|
358
|
-
* Represents the event arguments of the `PivotGridAxisFilterFields` expand-change event.
|
|
359
|
-
*/
|
|
360
|
-
export declare interface PivotGridAxisFilterFieldsExpandChangeEvent {
|
|
361
|
-
/**
|
|
362
|
-
* The handle of the component that triggered the event.
|
|
363
|
-
*/
|
|
364
|
-
target: PivotGridAxisFilterFieldsEditorHandle;
|
|
365
|
-
/**
|
|
366
|
-
* The expand state value.
|
|
367
|
-
*/
|
|
368
|
-
value: boolean;
|
|
369
|
-
/**
|
|
370
|
-
* The DOM event that triggered the change.
|
|
371
|
-
*/
|
|
372
|
-
syntheticEvent: React_2.SyntheticEvent;
|
|
373
|
-
}
|
|
374
|
-
|
|
375
|
-
/**
|
|
376
|
-
* Represents the [KendoReact PivotGridCell component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridcellprops).
|
|
377
|
-
*/
|
|
378
|
-
export declare const PivotGridCell: React_2.ForwardRefExoticComponent<PivotGridCellProps & React_2.RefAttributes<PivotGridCellHandle | null>>;
|
|
379
|
-
|
|
380
|
-
/**
|
|
381
|
-
* Represents the object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the PivotGridCell component.
|
|
382
|
-
*/
|
|
383
|
-
export declare interface PivotGridCellHandle {
|
|
384
|
-
/**
|
|
385
|
-
* The properties passed to the PivotGridCell component.
|
|
386
|
-
*/
|
|
387
|
-
props: PivotGridCellProps;
|
|
388
|
-
/**
|
|
389
|
-
* The DOM element of the PivotGridCell component.
|
|
390
|
-
*/
|
|
391
|
-
element: HTMLTableCellElement | null;
|
|
392
|
-
}
|
|
393
|
-
|
|
394
|
-
/**
|
|
395
|
-
* Represents the props of the [KendoReact PivotGridCell component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridcell).
|
|
396
|
-
*/
|
|
397
|
-
export declare interface PivotGridCellProps extends KendoMouse<PivotGridCellHandle, HTMLTableCellElement> {
|
|
398
|
-
/**
|
|
399
|
-
* Represents the `dataItem` of the PivotGridCell.
|
|
400
|
-
*
|
|
401
|
-
* The `dataItem` is a single [PivotDataItem](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotdataitem) object.
|
|
402
|
-
*/
|
|
403
|
-
dataItem: PivotDataItem;
|
|
404
|
-
/**
|
|
405
|
-
* Sets the `id` property of the top-most element of the PivotGridCell.
|
|
406
|
-
*/
|
|
407
|
-
id?: string;
|
|
408
|
-
/**
|
|
409
|
-
* Sets the `className` property of the top-most element of the PivotGridCell in addition to the default `k-pivotgrid-cell` class.
|
|
410
|
-
*/
|
|
411
|
-
className?: string;
|
|
412
|
-
/**
|
|
413
|
-
* Sets the `tabIndex` property of the top-most element of the PivotGridCell.
|
|
414
|
-
*/
|
|
415
|
-
tabIndex?: number;
|
|
416
|
-
/**
|
|
417
|
-
* Sets the `children` property of the top-most element of the PivotGridCell.
|
|
418
|
-
*/
|
|
419
|
-
children?: React_2.ReactNode;
|
|
420
|
-
/**
|
|
421
|
-
* Sets the `style` property of the top-most element of the PivotGridCell.
|
|
422
|
-
*/
|
|
423
|
-
style?: React_2.CSSProperties;
|
|
424
|
-
/**
|
|
425
|
-
* Represents the columns `path` leading to the current cell.
|
|
426
|
-
*/
|
|
427
|
-
columnPath?: string[];
|
|
428
|
-
/**
|
|
429
|
-
* Represents the row `path` leading to the current cell.
|
|
430
|
-
*/
|
|
431
|
-
rowPath?: string[];
|
|
432
|
-
/**
|
|
433
|
-
* Indicates if the current cell represents a `total` value.
|
|
434
|
-
*/
|
|
435
|
-
total?: boolean;
|
|
436
|
-
/**
|
|
437
|
-
* Sets the `role` property of the top-most element of the PivotGridCell.
|
|
438
|
-
*/
|
|
439
|
-
role?: string;
|
|
440
|
-
/**
|
|
441
|
-
* Sets the `aria-describedby` property of the top-most element of the PivotGridCell.
|
|
442
|
-
*/
|
|
443
|
-
ariaDescribedby?: string;
|
|
444
|
-
/**
|
|
445
|
-
* Fires when the user clicks the PivotGridCell.
|
|
446
|
-
*/
|
|
447
|
-
onClick?: (args: any) => void;
|
|
448
|
-
/**
|
|
449
|
-
* Fires when the user double-clicks the PivotGridCell.
|
|
450
|
-
*/
|
|
451
|
-
onDoubleClick?: (args: any) => void;
|
|
452
|
-
/**
|
|
453
|
-
* Fires when the user presses a mouse button while the cursor is over the PivotGridCell.
|
|
454
|
-
*/
|
|
455
|
-
onMouseDown?: (args: any) => void;
|
|
456
|
-
/**
|
|
457
|
-
* Fires when the cursor enters the PivotGridCell area.
|
|
458
|
-
*/
|
|
459
|
-
onMouseEnter?: (args: any) => void;
|
|
460
|
-
/**
|
|
461
|
-
* Fires when the cursor leaves the PivotGridCell area.
|
|
462
|
-
*/
|
|
463
|
-
onMouseLeave?: (args: any) => void;
|
|
464
|
-
/**
|
|
465
|
-
* Fires when the cursor moves within the PivotGridCell area.
|
|
466
|
-
*/
|
|
467
|
-
onMouseMove?: (args: any) => void;
|
|
468
|
-
/**
|
|
469
|
-
* Fires when the cursor moves outside the PivotGridCell area.
|
|
470
|
-
*/
|
|
471
|
-
onMouseOut?: (args: any) => void;
|
|
472
|
-
/**
|
|
473
|
-
* Fires when the cursor moves over the PivotGridCell area.
|
|
474
|
-
*/
|
|
475
|
-
onMouseOver?: (args: any) => void;
|
|
476
|
-
/**
|
|
477
|
-
* Fires when the user releases a mouse button while the cursor is over the PivotGridCell.
|
|
478
|
-
*/
|
|
479
|
-
onMouseUp?: (args: any) => void;
|
|
480
|
-
}
|
|
481
|
-
|
|
482
|
-
/**
|
|
483
|
-
* Represents the [KendoReact PivotGridColumn component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridcolumnprops).
|
|
484
|
-
*/
|
|
485
|
-
export declare const PivotGridColumn: React_2.ForwardRefExoticComponent<PivotGridColumnProps & React_2.RefAttributes<PivotGridColumnHandle | null>>;
|
|
486
|
-
|
|
487
|
-
/**
|
|
488
|
-
* Represents the object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the PivotGridColumn component.
|
|
489
|
-
*/
|
|
490
|
-
export declare interface PivotGridColumnHandle {
|
|
491
|
-
/**
|
|
492
|
-
* The properties passed to the PivotGridColumn component.
|
|
493
|
-
*/
|
|
494
|
-
props: PivotGridColumnProps;
|
|
495
|
-
/**
|
|
496
|
-
* The DOM element of the PivotGridColumn component.
|
|
497
|
-
*/
|
|
498
|
-
element: HTMLTableColElement | null;
|
|
499
|
-
}
|
|
500
|
-
|
|
501
|
-
/**
|
|
502
|
-
* Represents the props of the [KendoReact PivotGridColumn component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridcolumn).
|
|
503
|
-
*/
|
|
504
|
-
export declare interface PivotGridColumnProps extends KendoMouse<PivotGridColumnHandle, HTMLTableColElement> {
|
|
505
|
-
/**
|
|
506
|
-
* Sets the `className` property of the top-most element of the PivotGridColumn in addition to the default `k-pivotgrid-row` class.
|
|
507
|
-
*/
|
|
508
|
-
className?: string;
|
|
509
|
-
/**
|
|
510
|
-
* Sets the `id` property of the top-most element of the PivotGridColumn.
|
|
511
|
-
*/
|
|
512
|
-
id?: string;
|
|
513
|
-
/**
|
|
514
|
-
* Sets the `children` property of the top-most element of the PivotGridColumn.
|
|
515
|
-
*/
|
|
516
|
-
children?: React_2.ReactNode;
|
|
517
|
-
/**
|
|
518
|
-
* Sets the `style` property of the top-most element of the PivotGridColumn.
|
|
519
|
-
*/
|
|
520
|
-
style?: React_2.CSSProperties;
|
|
521
|
-
/**
|
|
522
|
-
* Sets the `tabIndex` property of the top-most element of the PivotGridColumn.
|
|
523
|
-
*/
|
|
524
|
-
tabIndex?: number;
|
|
525
|
-
/**
|
|
526
|
-
* Represents the `path` leading to the current `column`.
|
|
527
|
-
*/
|
|
528
|
-
path?: string[];
|
|
529
|
-
/**
|
|
530
|
-
* Fires when the user clicks the PivotGridColumn.
|
|
531
|
-
*/
|
|
532
|
-
onClick?: (args: any) => void;
|
|
533
|
-
/**
|
|
534
|
-
* Fires when the user double-clicks the PivotGridColumn.
|
|
535
|
-
*/
|
|
536
|
-
onDoubleClick?: (args: any) => void;
|
|
537
|
-
/**
|
|
538
|
-
* Fires when the user presses a mouse button while the cursor is over the PivotGridColumn.
|
|
539
|
-
*/
|
|
540
|
-
onMouseDown?: (args: any) => void;
|
|
541
|
-
/**
|
|
542
|
-
* Fires when the cursor enters the PivotGridColumn area.
|
|
543
|
-
*/
|
|
544
|
-
onMouseEnter?: (args: any) => void;
|
|
545
|
-
/**
|
|
546
|
-
* Fires when the cursor leaves the PivotGridColumn area.
|
|
547
|
-
*/
|
|
548
|
-
onMouseLeave?: (args: any) => void;
|
|
549
|
-
/**
|
|
550
|
-
* Fires when the cursor moves within the PivotGridColumn area.
|
|
551
|
-
*/
|
|
552
|
-
onMouseMove?: (args: any) => void;
|
|
553
|
-
/**
|
|
554
|
-
* Fires when the cursor moves outside the PivotGridColumn area.
|
|
555
|
-
*/
|
|
556
|
-
onMouseOut?: (args: any) => void;
|
|
557
|
-
/**
|
|
558
|
-
* Fires when the cursor moves over the PivotGridColumn area.
|
|
559
|
-
*/
|
|
560
|
-
onMouseOver?: (args: any) => void;
|
|
561
|
-
/**
|
|
562
|
-
* Fires when the user releases a mouse button while the cursor is over the PivotGridColumn.
|
|
563
|
-
*/
|
|
564
|
-
onMouseUp?: (args: any) => void;
|
|
565
|
-
}
|
|
566
|
-
|
|
567
|
-
/**
|
|
568
|
-
* Represents the [KendoReact PivotGridConfigurator component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfiguratorprops).
|
|
569
|
-
*/
|
|
570
|
-
export declare const PivotGridConfigurator: React_2.ForwardRefExoticComponent<PivotGridConfiguratorProps & React_2.RefAttributes<PivotGridConfiguratorHandle | null>>;
|
|
571
|
-
|
|
572
|
-
/**
|
|
573
|
-
* Represents the available PivotGridConfigurator actions.
|
|
574
|
-
*
|
|
575
|
-
* Can be one of:
|
|
576
|
-
* - [PivotGridConfiguratorSelectionAction](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfigurator)
|
|
577
|
-
* - [PivotGridConfiguratorMultipleSelectionAction](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfigurator)
|
|
578
|
-
* - [PivotGridConfiguratorRemoveAction](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfigurator)
|
|
579
|
-
* - [PivotGridConfiguratorSortAction](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfigurator)
|
|
580
|
-
* - [PivotGridConfiguratorFilterAction](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfigurator)
|
|
581
|
-
* - [PivotConfiguratorDragAction](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfigurator)
|
|
582
|
-
* - [PivotConfiguratorDropAction](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfigurator)
|
|
583
|
-
* - [PivotGridConfiguratorDropZoneAction](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfigurator)
|
|
584
|
-
* - [PivotGridConfiguratorDropTargetAction](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfigurator)
|
|
585
|
-
* - [PivotGridConfiguratorDropDirectionAction](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfigurator)
|
|
586
|
-
* - [PivotGridConfiguratorExpandAction](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfigurator)
|
|
587
|
-
*
|
|
588
|
-
* The following `falsy` values will be ignored:
|
|
589
|
-
* - `null`
|
|
590
|
-
* - `false`
|
|
591
|
-
* - `undefined`
|
|
592
|
-
*
|
|
593
|
-
* @hidden
|
|
594
|
-
*/
|
|
595
|
-
declare interface PivotGridConfiguratorAction {
|
|
596
|
-
type: PIVOT_CONFIGURATOR_ACTION_TYPE;
|
|
597
|
-
payload: any;
|
|
598
|
-
override?: PivotGridConfiguratorEditorState;
|
|
599
|
-
}
|
|
600
|
-
|
|
601
|
-
/**
|
|
602
|
-
* Represents the event arguments of the [`onColumnAxesChange`](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfiguratorprops#toc-oncolumnaxeschange), [`onRowAxesChange`](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfiguratorprops#toc-onrowaxeschange) and [`onMeasureAxesChange`](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfiguratorprops#toc-onmeasureaxeschange) callbacks of the [`PivotGridConfigurator`](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfigurator) component.
|
|
603
|
-
*/
|
|
604
|
-
export declare interface PivotGridConfiguratorAxesChangeEvent {
|
|
605
|
-
/**
|
|
606
|
-
* The new axes configuration value.
|
|
607
|
-
*/
|
|
608
|
-
value: PivotGridAxis[];
|
|
609
|
-
/**
|
|
610
|
-
* The handle of the PivotGridConfigurator component.
|
|
611
|
-
*/
|
|
612
|
-
target: PivotGridConfiguratorHandle | null;
|
|
613
|
-
/**
|
|
614
|
-
* The DOM event that triggered the change.
|
|
615
|
-
*/
|
|
616
|
-
syntheticEvent: React.SyntheticEvent;
|
|
617
|
-
}
|
|
618
|
-
|
|
619
|
-
/**
|
|
620
|
-
* Represents the [KendoReact PivotGridConfiguratorButton component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfiguratorbuttonprops).
|
|
621
|
-
*/
|
|
622
|
-
export declare const PivotGridConfiguratorButton: React_2.ForwardRefExoticComponent<PivotGridConfiguratorButtonProps & React_2.RefAttributes<PivotGridConfiguratorButtonHandle | null>>;
|
|
623
|
-
|
|
624
|
-
/**
|
|
625
|
-
* Represents the object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the PivotGridConfiguratorButton component.
|
|
626
|
-
*/
|
|
627
|
-
export declare interface PivotGridConfiguratorButtonHandle {
|
|
628
|
-
/**
|
|
629
|
-
* The properties passed to the PivotGridConfiguratorButton component.
|
|
630
|
-
*/
|
|
631
|
-
props: PivotGridConfiguratorButtonProps;
|
|
632
|
-
/**
|
|
633
|
-
* The DOM element of the PivotGridConfiguratorButton component.
|
|
634
|
-
*/
|
|
635
|
-
element: HTMLDivElement | null;
|
|
636
|
-
}
|
|
637
|
-
|
|
638
|
-
/**
|
|
639
|
-
* Represents the props of the [KendoReact PivotGridConfiguratorButton component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfiguratorbutton).
|
|
640
|
-
*/
|
|
641
|
-
export declare interface PivotGridConfiguratorButtonProps extends KendoMouse<PivotGridConfiguratorButtonHandle, HTMLDivElement> {
|
|
642
|
-
/**
|
|
643
|
-
* Sets the `className` property of the top-most element of the PivotGridConfiguratorButton in addition to the default `k-pivotgrid-configurator-button` class.
|
|
644
|
-
*/
|
|
645
|
-
className?: string;
|
|
646
|
-
/**
|
|
647
|
-
* Sets the `id` property of the top-most element of the PivotGridConfiguratorButton.
|
|
648
|
-
*/
|
|
649
|
-
id?: string;
|
|
650
|
-
/**
|
|
651
|
-
* Sets the `tabIndex` property of the top-most element of the PivotGridConfiguratorButton.
|
|
652
|
-
*/
|
|
653
|
-
tabIndex?: number;
|
|
654
|
-
/**
|
|
655
|
-
* Sets the `style` property of the top-most element of the PivotGridConfiguratorButton.
|
|
656
|
-
*/
|
|
657
|
-
style?: React_2.CSSProperties;
|
|
658
|
-
/**
|
|
659
|
-
* Overrides the default `icon` component.
|
|
660
|
-
*
|
|
661
|
-
* The default component is: [KendoReactIcon](https://www.telerik.com/kendo-react-ui/components/common/api/icon).
|
|
662
|
-
*/
|
|
663
|
-
icon?: CustomComponent<IconProps & SvgIconProps>;
|
|
664
|
-
/**
|
|
665
|
-
* Fires when the user clicks the PivotGridConfiguratorButton.
|
|
666
|
-
*/
|
|
667
|
-
onClick?: (args: any) => void;
|
|
668
|
-
/**
|
|
669
|
-
* Fires when the user double-clicks the PivotGridConfiguratorButton.
|
|
670
|
-
*/
|
|
671
|
-
onDoubleClick?: (args: any) => void;
|
|
672
|
-
/**
|
|
673
|
-
* Fires when the user presses a mouse button while the cursor is over the PivotGridConfiguratorButton.
|
|
674
|
-
*/
|
|
675
|
-
onMouseDown?: (args: any) => void;
|
|
676
|
-
/**
|
|
677
|
-
* Fires when the cursor enters the PivotGridConfiguratorButton area.
|
|
678
|
-
*/
|
|
679
|
-
onMouseEnter?: (args: any) => void;
|
|
680
|
-
/**
|
|
681
|
-
* Fires when the cursor leaves the PivotGridConfiguratorButton area.
|
|
682
|
-
*/
|
|
683
|
-
onMouseLeave?: (args: any) => void;
|
|
684
|
-
/**
|
|
685
|
-
* Fires when the cursor moves within the PivotGridConfiguratorButton area.
|
|
686
|
-
*/
|
|
687
|
-
onMouseMove?: (args: any) => void;
|
|
688
|
-
/**
|
|
689
|
-
* Fires when the cursor moves outside the PivotGridConfiguratorButton area.
|
|
690
|
-
*/
|
|
691
|
-
onMouseOut?: (args: any) => void;
|
|
692
|
-
/**
|
|
693
|
-
* Fires when the cursor moves over the PivotGridConfiguratorButton area.
|
|
694
|
-
*/
|
|
695
|
-
onMouseOver?: (args: any) => void;
|
|
696
|
-
/**
|
|
697
|
-
* Fires when the user releases a mouse button while the cursor is over the PivotGridConfiguratorButton.
|
|
698
|
-
*/
|
|
699
|
-
onMouseUp?: (args: any) => void;
|
|
700
|
-
}
|
|
701
|
-
|
|
702
|
-
/**
|
|
703
|
-
* Represents the [KendoReact PivotGridConfiguratorEditor component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfiguratoreditorprops).
|
|
704
|
-
*/
|
|
705
|
-
export declare const PivotGridConfiguratorEditor: React_2.ForwardRefExoticComponent<PivotGridConfiguratorEditorProps & React_2.RefAttributes<PivotGridConfiguratorEditorHandle>>;
|
|
706
|
-
|
|
707
|
-
/**
|
|
708
|
-
* Represents the object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the PivotGridConfiguratorEditor component.
|
|
709
|
-
*/
|
|
710
|
-
export declare interface PivotGridConfiguratorEditorHandle {
|
|
711
|
-
/**
|
|
712
|
-
* The properties passed to the PivotGridConfiguratorEditor component.
|
|
713
|
-
*/
|
|
714
|
-
props: PivotGridConfiguratorEditorProps;
|
|
715
|
-
/**
|
|
716
|
-
* The current state of the PivotGridConfiguratorEditor component.
|
|
717
|
-
*/
|
|
718
|
-
state: PivotGridConfiguratorState;
|
|
719
|
-
/**
|
|
720
|
-
* The DOM element of the PivotGridConfiguratorEditor component.
|
|
721
|
-
*/
|
|
722
|
-
element: HTMLDivElement;
|
|
723
|
-
}
|
|
724
|
-
|
|
725
|
-
/**
|
|
726
|
-
* Represents the props of the [KendoReact PivotGridConfiguratorEditor component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfiguratoreditor).
|
|
727
|
-
*/
|
|
728
|
-
export declare interface PivotGridConfiguratorEditorProps extends FormRenderProps {
|
|
729
|
-
/**
|
|
730
|
-
* Sets the `data` of the PivotGridConfiguratorEditor.
|
|
731
|
-
*
|
|
732
|
-
* The `data` represents all fields available in the configurator.
|
|
733
|
-
*/
|
|
734
|
-
data: PivotGridField[];
|
|
735
|
-
/**
|
|
736
|
-
* Renders the PivotGridConfiguratorEditor in `horizontal` orientation.
|
|
737
|
-
*
|
|
738
|
-
* @default false
|
|
739
|
-
*/
|
|
740
|
-
horizontal?: boolean;
|
|
741
|
-
/**
|
|
742
|
-
* Overrides the default `fieldsLabel` component.
|
|
743
|
-
*
|
|
744
|
-
* The default component is: [KendoReactLabel](https://www.telerik.com/kendo-react-ui/components/labels/api/label).
|
|
745
|
-
*/
|
|
746
|
-
fieldsLabel?: CustomComponent<FieldProps & LabelProps>;
|
|
747
|
-
/**
|
|
748
|
-
* Overrides the default `fieldsEditor` component.
|
|
749
|
-
*
|
|
750
|
-
* The default component is: [PivotGridFieldsEditor](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridfieldseditor).
|
|
751
|
-
*/
|
|
752
|
-
fieldsEditor?: CustomComponent<PivotGridFieldsEditorProps>;
|
|
753
|
-
/**
|
|
754
|
-
* Overrides the default `columnAxesLabel` component.
|
|
755
|
-
*
|
|
756
|
-
* The default component is: [KendoReactLabel](https://www.telerik.com/kendo-react-ui/components/labels/api/label).
|
|
757
|
-
*/
|
|
758
|
-
columnAxesLabel?: CustomComponent<FieldProps & LabelProps>;
|
|
759
|
-
/**
|
|
760
|
-
* Overrides the default `columnAxesEditor` component.
|
|
761
|
-
*
|
|
762
|
-
* The default component is: [PivotGridAxesEditor](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridaxeseditor).
|
|
763
|
-
*/
|
|
764
|
-
columnAxesEditor?: CustomComponent<PivotGridAxesEditorProps>;
|
|
765
|
-
/**
|
|
766
|
-
* Overrides the default `rowAxesLabel` component.
|
|
767
|
-
*
|
|
768
|
-
* The default component is: [KendoReactLabel](https://www.telerik.com/kendo-react-ui/components/labels/api/label).
|
|
769
|
-
*/
|
|
770
|
-
rowAxesLabel?: CustomComponent<FieldProps & LabelProps>;
|
|
771
|
-
/**
|
|
772
|
-
* Overrides the default `rowAxesEditor` component.
|
|
773
|
-
*
|
|
774
|
-
* The default component is: [PivotGridAxesEditor](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridaxeseditor).
|
|
775
|
-
*/
|
|
776
|
-
rowAxesEditor?: CustomComponent<PivotGridAxesEditorProps>;
|
|
777
|
-
/**
|
|
778
|
-
* Overrides the default `measureAxesLabel` component.
|
|
779
|
-
*
|
|
780
|
-
* The default component is: [KendoReactLabel](https://www.telerik.com/kendo-react-ui/components/labels/api/label).
|
|
781
|
-
*/
|
|
782
|
-
measureAxesLabel?: CustomComponent<FieldProps & LabelProps>;
|
|
783
|
-
/**
|
|
784
|
-
* Overrides the default `measureAxesEditor` component.
|
|
785
|
-
*
|
|
786
|
-
* The default component is: [PivotGridAxesEditor](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridaxeseditor).
|
|
787
|
-
*/
|
|
788
|
-
measureAxesEditor?: CustomComponent<PivotGridAxesEditorProps>;
|
|
789
|
-
/**
|
|
790
|
-
* A callback, fired whenever a `FieldEditorField` is expanded.
|
|
791
|
-
*/
|
|
792
|
-
onFieldsEditorFieldExpand?: (event: PivotGridFieldsEditorFieldExpandEvent & {
|
|
793
|
-
currentTarget: PivotGridConfiguratorEditorHandle;
|
|
794
|
-
}) => void;
|
|
795
|
-
/**
|
|
796
|
-
* An action callback. Used to define the component behavior when a `FieldsEditorFieldExpand` is triggered.
|
|
797
|
-
*
|
|
798
|
-
* Internal state change will be triggered depending on the specific action types.
|
|
799
|
-
*
|
|
800
|
-
* @hidden
|
|
801
|
-
*/
|
|
802
|
-
onFieldsEditorFieldExpandAction?: (event: PivotGridFieldsEditorFieldCheckEvent & {
|
|
803
|
-
currentTarget: PivotGridConfiguratorEditorHandle;
|
|
804
|
-
}, props: PivotGridConfiguratorEditorProps, state: PivotGridConfiguratorEditorState) => PivotGridConfiguratorAction | PivotGridConfiguratorAction[];
|
|
805
|
-
/**
|
|
806
|
-
* A callback, fired whenever a `FieldEditorField` is checked.
|
|
807
|
-
*/
|
|
808
|
-
onFieldsEditorFieldCheck?: (event: PivotGridFieldsEditorFieldCheckEvent & {
|
|
809
|
-
currentTarget: PivotGridConfiguratorEditorHandle;
|
|
810
|
-
}) => void;
|
|
811
|
-
/**
|
|
812
|
-
* An action callback. Used to define the component behavior when a `FieldsEditorFieldCheck` is triggered.
|
|
813
|
-
*
|
|
814
|
-
* Internal state change will be triggered depending on the specific action types.
|
|
815
|
-
*
|
|
816
|
-
* @hidden
|
|
817
|
-
*/
|
|
818
|
-
onFieldsEditorFieldCheckAction?: (event: PivotGridFieldsEditorFieldCheckEvent & {
|
|
819
|
-
currentTarget: PivotGridConfiguratorEditorHandle;
|
|
820
|
-
}, props: PivotGridConfiguratorEditorProps, state: PivotGridConfiguratorEditorState) => PivotGridConfiguratorAction | PivotGridConfiguratorAction[];
|
|
821
|
-
/**
|
|
822
|
-
* A callback, fired whenever an `AxisFilterField` is expanded.
|
|
823
|
-
*/
|
|
824
|
-
onAxisFilterFieldExpand?: (event: PivotGridAxisFilterFieldExpandEvent & {
|
|
825
|
-
currentTarget: PivotGridConfiguratorEditorHandle;
|
|
826
|
-
}) => void;
|
|
827
|
-
/**
|
|
828
|
-
* A callback, fired whenever `expanded` state of the AxisFilterFields is changed.
|
|
829
|
-
*/
|
|
830
|
-
onAxisFilterFieldsExpandChange?: (event: PivotGridAxisFilterFieldsExpandChangeEvent) => void;
|
|
831
|
-
}
|
|
832
|
-
|
|
833
|
-
/**
|
|
834
|
-
* @hidden
|
|
835
|
-
*/
|
|
836
|
-
declare interface PivotGridConfiguratorEditorState extends PivotGridConfiguratorState {
|
|
837
|
-
expanded: PivotGridField[];
|
|
838
|
-
}
|
|
839
|
-
|
|
840
|
-
/**
|
|
841
|
-
* Represents the event arguments of the [`onFilterChange`](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfiguratorprops#toc-onfilterchange) callbacks of the [`PivotGridConfigurator`](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfigurator) component.
|
|
842
|
-
*/
|
|
843
|
-
export declare interface PivotGridConfiguratorFilterChangeEvent {
|
|
844
|
-
/**
|
|
845
|
-
* The new filter descriptors value.
|
|
846
|
-
*/
|
|
847
|
-
value: FilterDescriptor[];
|
|
848
|
-
/**
|
|
849
|
-
* The handle of the PivotGridConfigurator component.
|
|
850
|
-
*/
|
|
851
|
-
target: PivotGridConfiguratorHandle | null;
|
|
852
|
-
/**
|
|
853
|
-
* The DOM event that triggered the change.
|
|
854
|
-
*/
|
|
855
|
-
syntheticEvent: React.SyntheticEvent;
|
|
856
|
-
}
|
|
857
|
-
|
|
858
|
-
/**
|
|
859
|
-
* Represents the object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the PivotGridConfigurator component.
|
|
860
|
-
*/
|
|
861
|
-
export declare interface PivotGridConfiguratorHandle {
|
|
862
|
-
/**
|
|
863
|
-
* The properties passed to the PivotGridConfigurator component.
|
|
864
|
-
*/
|
|
865
|
-
props: PivotGridConfiguratorProps;
|
|
866
|
-
/**
|
|
867
|
-
* The DOM element of the PivotGridConfigurator component.
|
|
868
|
-
*/
|
|
869
|
-
element: HTMLDivElement | null;
|
|
870
|
-
}
|
|
871
|
-
|
|
872
|
-
/**
|
|
873
|
-
* Represents the props of the [KendoReact PivotGridConfigurator component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfigurator).
|
|
874
|
-
*/
|
|
875
|
-
export declare interface PivotGridConfiguratorProps {
|
|
876
|
-
/**
|
|
877
|
-
* Sets the `className` property of the top-most element of the PivotGridConfigurator in addition to the default `k-pivotgrid-configurator` class.
|
|
878
|
-
*/
|
|
879
|
-
className?: string;
|
|
880
|
-
/**
|
|
881
|
-
* Sets the `id` property of the top-most element of the PivotGridConfigurator.
|
|
882
|
-
*/
|
|
883
|
-
id?: string;
|
|
884
|
-
/**
|
|
885
|
-
* Sets the `tabIndex` property of the top-most element of the PivotGridConfigurator.
|
|
886
|
-
*/
|
|
887
|
-
tabIndex?: number;
|
|
888
|
-
/**
|
|
889
|
-
* Sets the `style` property of the top-most element of the PivotGridConfigurator.
|
|
890
|
-
*/
|
|
891
|
-
style?: React_2.CSSProperties;
|
|
892
|
-
/**
|
|
893
|
-
* Renders the PivotGridConfigurator in `horizontal` orientation.
|
|
894
|
-
*
|
|
895
|
-
* @default false
|
|
896
|
-
*/
|
|
897
|
-
horizontal?: boolean;
|
|
898
|
-
/**
|
|
899
|
-
* Sets the `data` of the PivotGridConfigurator.
|
|
900
|
-
*
|
|
901
|
-
* The `data` represents all fields available in the configurator.
|
|
902
|
-
*/
|
|
903
|
-
data?: PivotGridField[];
|
|
904
|
-
/**
|
|
905
|
-
* The configuration of the `column` axes.
|
|
906
|
-
*/
|
|
907
|
-
columnAxes?: PivotGridAxis[];
|
|
908
|
-
/**
|
|
909
|
-
* A callback, fired whenever the `columnAxes` property should change.
|
|
910
|
-
*/
|
|
911
|
-
onColumnAxesChange?: (event: PivotGridConfiguratorAxesChangeEvent) => void;
|
|
912
|
-
/**
|
|
913
|
-
* The configuration of the `row` axes.
|
|
914
|
-
*/
|
|
915
|
-
rowAxes?: PivotGridAxis[];
|
|
916
|
-
/**
|
|
917
|
-
* A callback, fired whenever the `rowAxes` property should change.
|
|
918
|
-
*/
|
|
919
|
-
onRowAxesChange?: (event: PivotGridConfiguratorAxesChangeEvent) => void;
|
|
920
|
-
/**
|
|
921
|
-
* The configuration of the `measure` axes.
|
|
922
|
-
*/
|
|
923
|
-
measureAxes?: PivotGridAxis[];
|
|
924
|
-
/**
|
|
925
|
-
* A callback, fired whenever the `measureAxes` property should change.
|
|
926
|
-
*/
|
|
927
|
-
onMeasureAxesChange?: (event: PivotGridConfiguratorAxesChangeEvent) => void;
|
|
928
|
-
/**
|
|
929
|
-
* The descriptors by which the data is sorted.
|
|
930
|
-
*/
|
|
931
|
-
sort?: SortDescriptor[];
|
|
932
|
-
/**
|
|
933
|
-
* A callback, fired whenever the `sort` property should change.
|
|
934
|
-
*/
|
|
935
|
-
onSortChange?: (event: PivotGridConfiguratorSortChangeEvent) => void;
|
|
936
|
-
/**
|
|
937
|
-
* The descriptors by which the data is filtered.
|
|
938
|
-
*/
|
|
939
|
-
filter?: FilterDescriptor[];
|
|
940
|
-
/**
|
|
941
|
-
* A callback, fired whenever the `filter` property should change.
|
|
942
|
-
*/
|
|
943
|
-
onFilterChange?: (event: PivotGridConfiguratorFilterChangeEvent) => void;
|
|
944
|
-
/**
|
|
945
|
-
* A callback, fired whenever a `field` is expanded.
|
|
946
|
-
*/
|
|
947
|
-
onFieldsEditorFieldExpand?: (event: PivotGridFieldsEditorFieldExpandEvent) => void;
|
|
948
|
-
/**
|
|
949
|
-
* A callback, fired whenever a `field` is checked.
|
|
950
|
-
*/
|
|
951
|
-
onFieldsEditorFieldCheck?: (event: PivotGridFieldsEditorFieldCheckEvent) => void;
|
|
952
|
-
/**
|
|
953
|
-
* A callback, fired whenever an `AxisFilterField` is expanded.
|
|
954
|
-
*/
|
|
955
|
-
onAxisFilterFieldExpand?: (event?: PivotGridAxisFilterFieldExpandEvent) => void;
|
|
956
|
-
/**
|
|
957
|
-
* A callback, fired whenever the `expanded` state of the `AxisFilterFields` is changed.
|
|
958
|
-
*/
|
|
959
|
-
onAxisFilterFieldsExpandChange?: (event?: PivotGridAxisFilterFieldsExpandChangeEvent) => void;
|
|
960
|
-
/**
|
|
961
|
-
* Overrides the default `editor` component.
|
|
962
|
-
*
|
|
963
|
-
* The default component is: [PivotGridConfiguratorEditor](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfiguratoreditor).
|
|
964
|
-
*/
|
|
965
|
-
editor?: CustomComponent<PivotGridConfiguratorEditorProps>;
|
|
966
|
-
/**
|
|
967
|
-
* Overrides the default `form` component.
|
|
968
|
-
*
|
|
969
|
-
* The default component is: [KendoReactForm](https://www.telerik.com/kendo-react-ui/components/form/api/form).
|
|
970
|
-
*/
|
|
971
|
-
form?: CustomComponent<FormProps>;
|
|
972
|
-
/**
|
|
973
|
-
* Overrides the default `formElement` component.
|
|
974
|
-
*
|
|
975
|
-
* The default component is: [KendoReactFormElement](https://www.telerik.com/kendo-react-ui/components/form/api/formelement).
|
|
976
|
-
*/
|
|
977
|
-
formElement?: CustomComponent<FormElementProps>;
|
|
978
|
-
}
|
|
979
|
-
|
|
980
|
-
/**
|
|
981
|
-
* Represents the event arguments of the [`onSortChange`](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfiguratorprops#toc-onsortchange) callbacks of the [`PivotGridConfigurator`](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridconfigurator) component.
|
|
982
|
-
*/
|
|
983
|
-
export declare interface PivotGridConfiguratorSortChangeEvent {
|
|
984
|
-
/**
|
|
985
|
-
* The new sort descriptors value.
|
|
986
|
-
*/
|
|
987
|
-
value: SortDescriptor[];
|
|
988
|
-
/**
|
|
989
|
-
* The handle of the PivotGridConfigurator component.
|
|
990
|
-
*/
|
|
991
|
-
target: PivotGridConfiguratorHandle | null;
|
|
992
|
-
/**
|
|
993
|
-
* The DOM event that triggered the change.
|
|
994
|
-
*/
|
|
995
|
-
syntheticEvent: React.SyntheticEvent;
|
|
996
|
-
}
|
|
997
|
-
|
|
998
|
-
/**
|
|
999
|
-
* Represents the [KendoReact PivotGridContainer component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridcontainerprops).
|
|
1000
|
-
*
|
|
1001
|
-
* @remarks
|
|
1002
|
-
* Supported children components are: {@link PivotGrid}, {@link PivotGridConfigurator}, {@link PivotGridConfiguratorButton}, {@link Loader}.
|
|
1003
|
-
*/
|
|
1004
|
-
export declare const PivotGridContainer: React_2.ForwardRefExoticComponent<PivotGridContainerProps & React_2.RefAttributes<PivotGridContainerHandle | null>>;
|
|
1005
|
-
|
|
1006
|
-
/**
|
|
1007
|
-
* Represents the object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the PivotGridContainer component.
|
|
1008
|
-
*/
|
|
1009
|
-
export declare interface PivotGridContainerHandle {
|
|
1010
|
-
/**
|
|
1011
|
-
* The DOM element of the PivotGridContainer component.
|
|
1012
|
-
*/
|
|
1013
|
-
element: HTMLDivElement | null;
|
|
1014
|
-
/**
|
|
1015
|
-
* The properties passed to the PivotGridContainer component.
|
|
1016
|
-
*/
|
|
1017
|
-
props: PivotGridContainerProps;
|
|
1018
|
-
}
|
|
1019
|
-
|
|
1020
|
-
/**
|
|
1021
|
-
* Represents the props of the [KendoReact PivotGridContainer component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridcontainer).
|
|
1022
|
-
*/
|
|
1023
|
-
export declare interface PivotGridContainerProps {
|
|
1024
|
-
/**
|
|
1025
|
-
* Sets the `id` property of the top-most element of the PivotGridContainer.
|
|
1026
|
-
*/
|
|
1027
|
-
id?: string;
|
|
1028
|
-
/**
|
|
1029
|
-
* Sets the `tabIndex` property of the top-most element of the PivotGridContainer.
|
|
1030
|
-
*/
|
|
1031
|
-
tabIndex?: number;
|
|
1032
|
-
/**
|
|
1033
|
-
* Sets the `className` property of the top-most element of the PivotGridContainer in addition to the default `k-d-flex k-pos-relative` class.
|
|
1034
|
-
*/
|
|
1035
|
-
className?: string;
|
|
1036
|
-
/**
|
|
1037
|
-
* Sets the `children` property of the top-most element of the PivotGridContainer.
|
|
1038
|
-
*/
|
|
1039
|
-
children?: React_2.ReactNode;
|
|
1040
|
-
/**
|
|
1041
|
-
* Sets the `style` property of the top-most element of the PivotGridContainer.
|
|
1042
|
-
*/
|
|
1043
|
-
style?: React_2.CSSProperties;
|
|
1044
|
-
/**
|
|
1045
|
-
* Sets the configurator position in the container.
|
|
1046
|
-
* The available values are:
|
|
1047
|
-
* - top
|
|
1048
|
-
* - left
|
|
1049
|
-
* - right
|
|
1050
|
-
* - bottom
|
|
1051
|
-
*
|
|
1052
|
-
* @default 'right'
|
|
1053
|
-
*/
|
|
1054
|
-
configuratorPosition?: 'top' | 'left' | 'right' | 'bottom';
|
|
1055
|
-
}
|
|
1056
|
-
|
|
1057
|
-
/**
|
|
1058
|
-
* Represents the [KendoReact PivotGridFieldsEditor component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridfieldseditorprops).
|
|
1059
|
-
*/
|
|
1060
|
-
export declare const PivotGridFieldsEditor: React_2.ForwardRefExoticComponent<PivotGridFieldsEditorProps & React_2.RefAttributes<PivotGridFieldsEditorHandle | null>>;
|
|
1061
|
-
|
|
1062
|
-
/**
|
|
1063
|
-
* @hidden
|
|
1064
|
-
*/
|
|
1065
|
-
export declare interface PivotGridFieldsEditorFieldCheckEvent {
|
|
1066
|
-
target: PivotGridFieldsEditorHandle;
|
|
1067
|
-
value: PivotGridField;
|
|
1068
|
-
syntheticEvent: React_2.SyntheticEvent;
|
|
1069
|
-
}
|
|
1070
|
-
|
|
1071
|
-
/**
|
|
1072
|
-
* @hidden
|
|
1073
|
-
*/
|
|
1074
|
-
export declare interface PivotGridFieldsEditorFieldExpandEvent {
|
|
1075
|
-
target: PivotGridFieldsEditorHandle;
|
|
1076
|
-
value: PivotGridField;
|
|
1077
|
-
syntheticEvent: React_2.SyntheticEvent;
|
|
1078
|
-
}
|
|
1079
|
-
|
|
1080
|
-
/**
|
|
1081
|
-
* Represents the object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the PivotGridFieldsEditor component.
|
|
1082
|
-
*/
|
|
1083
|
-
export declare interface PivotGridFieldsEditorHandle {
|
|
1084
|
-
/**
|
|
1085
|
-
* The properties passed to the PivotGridFieldsEditor component.
|
|
1086
|
-
*/
|
|
1087
|
-
props: PivotGridFieldsEditorProps;
|
|
1088
|
-
/**
|
|
1089
|
-
* The DOM element of the PivotGridFieldsEditor component.
|
|
1090
|
-
*/
|
|
1091
|
-
element: HTMLDivElement | null;
|
|
1092
|
-
}
|
|
1093
|
-
|
|
1094
|
-
/**
|
|
1095
|
-
* Represents the props of the [KendoReact PivotGridFieldsEditor component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridfieldseditor).
|
|
1096
|
-
*/
|
|
1097
|
-
export declare interface PivotGridFieldsEditorProps {
|
|
1098
|
-
/**
|
|
1099
|
-
* Sets the `data` of the PivotGridConfiguratorEditor.
|
|
1100
|
-
*
|
|
1101
|
-
* The `data` represents all fields available in the configurator.
|
|
1102
|
-
*/
|
|
1103
|
-
data?: PivotGridField[];
|
|
1104
|
-
/**
|
|
1105
|
-
* The configuration of the `row` axes.
|
|
1106
|
-
*/
|
|
1107
|
-
rowAxes?: PivotGridAxis[];
|
|
1108
|
-
/**
|
|
1109
|
-
* The configuration of the `column` axes.
|
|
1110
|
-
*/
|
|
1111
|
-
columnAxes?: PivotGridAxis[];
|
|
1112
|
-
/**
|
|
1113
|
-
* The configuration of the `measure` axes.
|
|
1114
|
-
*/
|
|
1115
|
-
measureAxes?: PivotGridAxis[];
|
|
1116
|
-
/**
|
|
1117
|
-
* A callback, fired whenever an `expand` is triggered.
|
|
1118
|
-
*/
|
|
1119
|
-
onExpand?: (args: PivotGridFieldsEditorFieldExpandEvent) => void;
|
|
1120
|
-
/**
|
|
1121
|
-
* A callback, fired whenever a `check` is triggered.
|
|
1122
|
-
*/
|
|
1123
|
-
onCheck?: (args: PivotGridFieldsEditorFieldCheckEvent) => void;
|
|
1124
|
-
/**
|
|
1125
|
-
* Overrides the default `treeView` component.
|
|
1126
|
-
*
|
|
1127
|
-
* The default component is: [KendoReactTreeView](https://www.telerik.com/kendo-react-ui/components/treeview/api/treeview).
|
|
1128
|
-
*/
|
|
1129
|
-
treeView?: CustomComponent<TreeViewProps>;
|
|
1130
|
-
/**
|
|
1131
|
-
* Overrides the default `noData` component.
|
|
1132
|
-
*
|
|
1133
|
-
* The default component is: `() => <div>NO DATA</div>`
|
|
1134
|
-
*/
|
|
1135
|
-
noData?: CustomComponent<any>;
|
|
1136
|
-
}
|
|
1137
|
-
|
|
1138
|
-
/**
|
|
1139
|
-
* Represents the object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the PivotGrid component.
|
|
1140
|
-
*/
|
|
1141
|
-
export declare interface PivotGridHandle {
|
|
1142
|
-
/**
|
|
1143
|
-
* The DOM element of the PivotGrid component.
|
|
1144
|
-
*/
|
|
1145
|
-
element: HTMLDivElement | null;
|
|
1146
|
-
/**
|
|
1147
|
-
* The current properties of the PivotGrid component.
|
|
1148
|
-
*/
|
|
1149
|
-
props: PivotGridProps;
|
|
1150
|
-
/**
|
|
1151
|
-
* The rows that make up the column headers.
|
|
1152
|
-
*/
|
|
1153
|
-
columnHeaderRows: AxisRow[];
|
|
1154
|
-
/**
|
|
1155
|
-
* The rows that make up the row headers.
|
|
1156
|
-
*/
|
|
1157
|
-
rowHeaderRows: AxisRow[];
|
|
1158
|
-
/**
|
|
1159
|
-
* The data cells organized by row and column.
|
|
1160
|
-
*/
|
|
1161
|
-
dataCells: {
|
|
1162
|
-
row: string[];
|
|
1163
|
-
cells: PivotDataItem[];
|
|
1164
|
-
}[];
|
|
1165
|
-
/**
|
|
1166
|
-
* The width of the row header area in pixels.
|
|
1167
|
-
*/
|
|
1168
|
-
rowHeaderBreadth: number;
|
|
1169
|
-
/**
|
|
1170
|
-
* The height of the column header area in pixels.
|
|
1171
|
-
*/
|
|
1172
|
-
columnHeaderBreadth: number;
|
|
1173
|
-
}
|
|
1174
|
-
|
|
1175
|
-
/**
|
|
1176
|
-
* Represents the [KendoReact PivotGridHeaderCell component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridheadercellprops).
|
|
1177
|
-
*/
|
|
1178
|
-
export declare const PivotGridHeaderCell: React_2.ForwardRefExoticComponent<PivotGridHeaderCellProps & React_2.RefAttributes<PivotGridHeaderCellHandle | null>>;
|
|
1179
|
-
|
|
1180
|
-
/**
|
|
1181
|
-
* Represents the object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the PivotGridHeaderCell component.
|
|
1182
|
-
*/
|
|
1183
|
-
export declare interface PivotGridHeaderCellHandle {
|
|
1184
|
-
/**
|
|
1185
|
-
* The properties passed to the PivotGridHeaderCell component.
|
|
1186
|
-
*/
|
|
1187
|
-
props: PivotGridHeaderCellProps;
|
|
1188
|
-
/**
|
|
1189
|
-
* The DOM element of the PivotGridHeaderCell component.
|
|
1190
|
-
*/
|
|
1191
|
-
element: HTMLTableHeaderCellElement | null;
|
|
1192
|
-
}
|
|
1193
|
-
|
|
1194
|
-
/**
|
|
1195
|
-
* Represents the props of the [KendoReact PivotGridHeaderCell component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridheadercell).
|
|
1196
|
-
*/
|
|
1197
|
-
export declare interface PivotGridHeaderCellProps extends KendoMouse<PivotGridHeaderCellHandle, HTMLTableHeaderCellElement> {
|
|
1198
|
-
/**
|
|
1199
|
-
* Represents the `dataItem` of the PivotGridHeaderCell.
|
|
1200
|
-
*
|
|
1201
|
-
* The `dataItem` is a single [AxisDataItem](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/axisdataitem) object.
|
|
1202
|
-
*/
|
|
1203
|
-
dataItem: AxisDataItem;
|
|
1204
|
-
/**
|
|
1205
|
-
* Sets the `id` property of the top-most element of the PivotGridHeaderCell.
|
|
1206
|
-
*/
|
|
1207
|
-
id?: string;
|
|
1208
|
-
/**
|
|
1209
|
-
* Sets the `className` property of the top-most element of the PivotGridHeaderCell in addition to the default `k-pivotgrid-cell` class.
|
|
1210
|
-
*/
|
|
1211
|
-
className?: string;
|
|
1212
|
-
/**
|
|
1213
|
-
* Sets the `tabIndex` property of the top-most element of the PivotGridHeaderCell.
|
|
1214
|
-
*/
|
|
1215
|
-
tabIndex?: number;
|
|
1216
|
-
/**
|
|
1217
|
-
* Sets the `children` property of the top-most element of the PivotGridHeaderCell.
|
|
1218
|
-
*/
|
|
1219
|
-
children?: React_2.ReactNode;
|
|
1220
|
-
/**
|
|
1221
|
-
* Sets the `style` property of the top-most element of the PivotGridHeaderCell.
|
|
1222
|
-
*/
|
|
1223
|
-
style?: React_2.CSSProperties;
|
|
1224
|
-
/**
|
|
1225
|
-
* Represents the calculated `rowSpan` property of the cell.
|
|
1226
|
-
*/
|
|
1227
|
-
rowSpan?: number;
|
|
1228
|
-
/**
|
|
1229
|
-
* Represents the calculated `colSpan` property of the cell.
|
|
1230
|
-
*/
|
|
1231
|
-
colSpan?: number;
|
|
1232
|
-
/**
|
|
1233
|
-
* Represents the columns `path` leading to the current cell.
|
|
1234
|
-
*/
|
|
1235
|
-
columnPath?: string[];
|
|
1236
|
-
/**
|
|
1237
|
-
* Represents the row `path` leading to the current cell.
|
|
1238
|
-
*/
|
|
1239
|
-
rowPath?: string[];
|
|
1240
|
-
/**
|
|
1241
|
-
* Indicates if the current cell represents a `total` value.
|
|
1242
|
-
*/
|
|
1243
|
-
total?: boolean;
|
|
1244
|
-
/**
|
|
1245
|
-
* Indicates if the current cell represents the first level of a hierarchy.
|
|
1246
|
-
*/
|
|
1247
|
-
root?: boolean;
|
|
1248
|
-
/**
|
|
1249
|
-
* Indicates if the current cell can be expanded.
|
|
1250
|
-
*/
|
|
1251
|
-
expandable?: boolean;
|
|
1252
|
-
/**
|
|
1253
|
-
* Indicates if the current cell is expanded.
|
|
1254
|
-
*/
|
|
1255
|
-
expanded?: boolean;
|
|
1256
|
-
/**
|
|
1257
|
-
* @hidden
|
|
1258
|
-
*/
|
|
1259
|
-
first?: boolean;
|
|
1260
|
-
/**
|
|
1261
|
-
* Overrides the default `icon` component.
|
|
1262
|
-
*
|
|
1263
|
-
* The default component is: [KendoReactIcon](https://www.telerik.com/kendo-react-ui/components/common/api/icon).
|
|
1264
|
-
*/
|
|
1265
|
-
icon?: CustomComponent<IconProps & SvgIconProps>;
|
|
1266
|
-
/**
|
|
1267
|
-
* A callback, fired whenever the `icon` is clicked.
|
|
1268
|
-
*/
|
|
1269
|
-
onIconClick?: (args: KendoMouseEvent<PivotGridHeaderCellHandle, HTMLSpanElement>) => void;
|
|
1270
|
-
/**
|
|
1271
|
-
* Sets the `role` property of the top-most element of the PivotGridHeaderCell.
|
|
1272
|
-
*/
|
|
1273
|
-
role?: string;
|
|
1274
|
-
/**
|
|
1275
|
-
* Fires when the user clicks the PivotGridHeaderCell.
|
|
1276
|
-
*/
|
|
1277
|
-
onClick?: (args: any) => void;
|
|
1278
|
-
/**
|
|
1279
|
-
* Fires when the user double-clicks the PivotGridHeaderCell.
|
|
1280
|
-
*/
|
|
1281
|
-
onDoubleClick?: (args: any) => void;
|
|
1282
|
-
/**
|
|
1283
|
-
* Fires when the user presses a mouse button while the cursor is over the PivotGridHeaderCell.
|
|
1284
|
-
*/
|
|
1285
|
-
onMouseDown?: (args: any) => void;
|
|
1286
|
-
/**
|
|
1287
|
-
* Fires when the cursor enters the PivotGridHeaderCell area.
|
|
1288
|
-
*/
|
|
1289
|
-
onMouseEnter?: (args: any) => void;
|
|
1290
|
-
/**
|
|
1291
|
-
* Fires when the cursor leaves the PivotGridHeaderCell area.
|
|
1292
|
-
*/
|
|
1293
|
-
onMouseLeave?: (args: any) => void;
|
|
1294
|
-
/**
|
|
1295
|
-
* Fires when the cursor moves within the PivotGridHeaderCell area.
|
|
1296
|
-
*/
|
|
1297
|
-
onMouseMove?: (args: any) => void;
|
|
1298
|
-
/**
|
|
1299
|
-
* Fires when the cursor moves outside the PivotGridHeaderCell area.
|
|
1300
|
-
*/
|
|
1301
|
-
onMouseOut?: (args: any) => void;
|
|
1302
|
-
/**
|
|
1303
|
-
* Fires when the cursor moves over the PivotGridHeaderCell area.
|
|
1304
|
-
*/
|
|
1305
|
-
onMouseOver?: (args: any) => void;
|
|
1306
|
-
/**
|
|
1307
|
-
* Fires when the user releases a mouse button while the cursor is over the PivotGridHeaderCell.
|
|
1308
|
-
*/
|
|
1309
|
-
onMouseUp?: (args: any) => void;
|
|
1310
|
-
}
|
|
1311
|
-
|
|
1312
|
-
/**
|
|
1313
|
-
* Represents the props of the [KendoReact PivotGrid component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgrid).
|
|
1314
|
-
*/
|
|
1315
|
-
export declare interface PivotGridProps {
|
|
1316
|
-
/**
|
|
1317
|
-
* Sets the `style` property of the top-most element of the PivotGrid.
|
|
1318
|
-
*
|
|
1319
|
-
* @example
|
|
1320
|
-
* ```jsx
|
|
1321
|
-
* <PivotGrid style={{ height: '500px' }} />
|
|
1322
|
-
* ```
|
|
1323
|
-
*/
|
|
1324
|
-
style?: React_2.CSSProperties;
|
|
1325
|
-
/**
|
|
1326
|
-
* Sets the `className` property of the top-most element of the PivotGrid in addition to the default `k-pivotgrid` class.
|
|
1327
|
-
*
|
|
1328
|
-
* @example
|
|
1329
|
-
* ```jsx
|
|
1330
|
-
* <PivotGrid className="custom-class" />
|
|
1331
|
-
* ```
|
|
1332
|
-
*/
|
|
1333
|
-
className?: string;
|
|
1334
|
-
/**
|
|
1335
|
-
* Sets the `id` property of the top-most element of the PivotGrid.
|
|
1336
|
-
*
|
|
1337
|
-
* @example
|
|
1338
|
-
* ```jsx
|
|
1339
|
-
* <PivotGrid id="pivotgrid-id" />
|
|
1340
|
-
* ```
|
|
1341
|
-
*/
|
|
1342
|
-
id?: string;
|
|
1343
|
-
/**
|
|
1344
|
-
* Sets the `tabIndex` property of the top-most element of the PivotGrid.
|
|
1345
|
-
*
|
|
1346
|
-
* @example
|
|
1347
|
-
* ```jsx
|
|
1348
|
-
* <PivotGrid tabIndex={0} />
|
|
1349
|
-
* ```
|
|
1350
|
-
*/
|
|
1351
|
-
tabIndex?: number;
|
|
1352
|
-
/**
|
|
1353
|
-
* If set to `true`, the user can use dedicated shortcuts to interact with the PivotGrid.
|
|
1354
|
-
* By default, navigation is disabled.
|
|
1355
|
-
*
|
|
1356
|
-
* @default false
|
|
1357
|
-
*
|
|
1358
|
-
* @example
|
|
1359
|
-
* ```jsx
|
|
1360
|
-
* <PivotGrid navigatable={true} />
|
|
1361
|
-
* ```
|
|
1362
|
-
*/
|
|
1363
|
-
navigatable?: boolean;
|
|
1364
|
-
/**
|
|
1365
|
-
* Sets the `data` of the PivotGrid.
|
|
1366
|
-
*
|
|
1367
|
-
* @example
|
|
1368
|
-
* ```jsx
|
|
1369
|
-
* <PivotGrid data={[{ field: 'value', data: 100 }]} />
|
|
1370
|
-
* ```
|
|
1371
|
-
*/
|
|
1372
|
-
data?: PivotDataItem[];
|
|
1373
|
-
/**
|
|
1374
|
-
* Sets the `columns` data of the PivotGrid.
|
|
1375
|
-
*
|
|
1376
|
-
* @example
|
|
1377
|
-
* ```jsx
|
|
1378
|
-
* <PivotGrid columns={[['Category', 'Subcategory']]} />
|
|
1379
|
-
* ```
|
|
1380
|
-
*/
|
|
1381
|
-
columns?: Tuple[];
|
|
1382
|
-
/**
|
|
1383
|
-
* Sets the `rows` data of the PivotGrid.
|
|
1384
|
-
*
|
|
1385
|
-
* @example
|
|
1386
|
-
* ```jsx
|
|
1387
|
-
* <PivotGrid rows={[['Region', 'Country']]} />
|
|
1388
|
-
* ```
|
|
1389
|
-
*/
|
|
1390
|
-
rows?: Tuple[];
|
|
1391
|
-
/**
|
|
1392
|
-
* The configuration of the `column` axes.
|
|
1393
|
-
*
|
|
1394
|
-
* @example
|
|
1395
|
-
* ```jsx
|
|
1396
|
-
* <PivotGrid columnAxes={[{ name: 'Category', expand: true }]} />
|
|
1397
|
-
* ```
|
|
1398
|
-
*/
|
|
1399
|
-
columnAxes?: PivotGridAxis[];
|
|
1400
|
-
/**
|
|
1401
|
-
* A callback, fired whenever the `columnAxes` property should change.
|
|
1402
|
-
*
|
|
1403
|
-
* @example
|
|
1404
|
-
* ```jsx
|
|
1405
|
-
* <PivotGrid onColumnAxesChange={(event) => console.log(event.value)} />
|
|
1406
|
-
* ```
|
|
1407
|
-
*/
|
|
1408
|
-
onColumnAxesChange?: (event: PivotGridAxesChangeEvent) => void;
|
|
1409
|
-
/**
|
|
1410
|
-
* The configuration of the `row` axes.
|
|
1411
|
-
*
|
|
1412
|
-
* @example
|
|
1413
|
-
* ```jsx
|
|
1414
|
-
* <PivotGrid rowAxes={[{ name: 'Region', expand: true }]} />
|
|
1415
|
-
* ```
|
|
1416
|
-
*/
|
|
1417
|
-
rowAxes?: PivotGridAxis[];
|
|
1418
|
-
/**
|
|
1419
|
-
* A callback, fired whenever the `rowAxes` property should change.
|
|
1420
|
-
*
|
|
1421
|
-
* @example
|
|
1422
|
-
* ```jsx
|
|
1423
|
-
* <PivotGrid onRowAxesChange={(event) => console.log(event.value)} />
|
|
1424
|
-
* ```
|
|
1425
|
-
*/
|
|
1426
|
-
onRowAxesChange?: (event: PivotGridAxesChangeEvent) => void;
|
|
1427
|
-
/**
|
|
1428
|
-
* Overrides the default `row` component.
|
|
1429
|
-
*
|
|
1430
|
-
* The default component is: [PivotGridRow](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridrow).
|
|
1431
|
-
*
|
|
1432
|
-
* @example
|
|
1433
|
-
* ```jsx
|
|
1434
|
-
* <PivotGrid row={(props) => <CustomRow {...props} />} />
|
|
1435
|
-
* ```
|
|
1436
|
-
*/
|
|
1437
|
-
row?: CustomComponent<PivotGridRowProps>;
|
|
1438
|
-
/**
|
|
1439
|
-
* Overrides the default `column` component.
|
|
1440
|
-
*
|
|
1441
|
-
* The default component is: [PivotGridColumn](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridcolumn).
|
|
1442
|
-
*
|
|
1443
|
-
* @example
|
|
1444
|
-
* ```jsx
|
|
1445
|
-
* <PivotGrid column={(props) => <CustomColumn {...props} />} />
|
|
1446
|
-
* ```
|
|
1447
|
-
*/
|
|
1448
|
-
column?: CustomComponent<PivotGridColumnProps>;
|
|
1449
|
-
/**
|
|
1450
|
-
* Overrides the default `cell` component.
|
|
1451
|
-
*
|
|
1452
|
-
* The default component is: [PivotGridCell](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridcell).
|
|
1453
|
-
*
|
|
1454
|
-
* @example
|
|
1455
|
-
* ```jsx
|
|
1456
|
-
* <PivotGrid cell={(props) => <CustomCell {...props} />} />
|
|
1457
|
-
* ```
|
|
1458
|
-
*/
|
|
1459
|
-
cell?: CustomComponent<PivotGridCellProps>;
|
|
1460
|
-
/**
|
|
1461
|
-
* Overrides the default `headerCell` component.
|
|
1462
|
-
*
|
|
1463
|
-
* The default component is: [PivotGridHeaderCell](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridheadercell).
|
|
1464
|
-
*
|
|
1465
|
-
* @example
|
|
1466
|
-
* ```jsx
|
|
1467
|
-
* <PivotGrid headerCell={(props) => <CustomHeaderCell {...props} />} />
|
|
1468
|
-
* ```
|
|
1469
|
-
*/
|
|
1470
|
-
headerCell?: CustomComponent<PivotGridHeaderCellProps>;
|
|
1471
|
-
/**
|
|
1472
|
-
* Overrides the default column-headers `row` component.
|
|
1473
|
-
*
|
|
1474
|
-
* The default component is: [PivotGridRow](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridrow).
|
|
1475
|
-
*
|
|
1476
|
-
* @example
|
|
1477
|
-
* ```jsx
|
|
1478
|
-
* <PivotGrid columnHeadersRow={(props) => <CustomRow {...props} />} />
|
|
1479
|
-
* ```
|
|
1480
|
-
*/
|
|
1481
|
-
columnHeadersRow?: React_2.ComponentType<PivotGridRowProps>;
|
|
1482
|
-
/**
|
|
1483
|
-
* Overrides the default column-headers `column` component.
|
|
1484
|
-
*
|
|
1485
|
-
* The default component is: [PivotGridColumn](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridcolumn).
|
|
1486
|
-
*
|
|
1487
|
-
* @example
|
|
1488
|
-
* ```jsx
|
|
1489
|
-
* <PivotGrid columnHeadersColumn={(props) => <CustomColumn {...props} />} />
|
|
1490
|
-
* ```
|
|
1491
|
-
*/
|
|
1492
|
-
columnHeadersColumn?: React_2.ComponentType<PivotGridColumnProps>;
|
|
1493
|
-
/**
|
|
1494
|
-
* Overrides the default column-headers `headerCell` component.
|
|
1495
|
-
*
|
|
1496
|
-
* The default component is: [PivotGridHeaderCell](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridheadercell).
|
|
1497
|
-
*
|
|
1498
|
-
* @example
|
|
1499
|
-
* ```jsx
|
|
1500
|
-
* <PivotGrid columnHeadersCell={(props) => <CustomHeaderCell {...props} />} />
|
|
1501
|
-
* ```
|
|
1502
|
-
*/
|
|
1503
|
-
columnHeadersCell?: React_2.ComponentType<PivotGridHeaderCellProps>;
|
|
1504
|
-
/**
|
|
1505
|
-
* Overrides the default row-headers `row` component.
|
|
1506
|
-
*
|
|
1507
|
-
* The default component is: [PivotGridRow](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridrow).
|
|
1508
|
-
*
|
|
1509
|
-
* @example
|
|
1510
|
-
* ```jsx
|
|
1511
|
-
* <PivotGrid rowHeadersRow={(props) => <CustomRow {...props} />} />
|
|
1512
|
-
* ```
|
|
1513
|
-
*/
|
|
1514
|
-
rowHeadersRow?: React_2.ComponentType<PivotGridRowProps>;
|
|
1515
|
-
/**
|
|
1516
|
-
* Overrides the default row-headers `column` component.
|
|
1517
|
-
*
|
|
1518
|
-
* The default component is: [PivotGridColumn](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridcolumn).
|
|
1519
|
-
*
|
|
1520
|
-
* @example
|
|
1521
|
-
* ```jsx
|
|
1522
|
-
* <PivotGrid rowHeadersColumn={(props) => <CustomColumn {...props} />} />
|
|
1523
|
-
* ```
|
|
1524
|
-
*/
|
|
1525
|
-
rowHeadersColumn?: React_2.ComponentType<PivotGridColumnProps>;
|
|
1526
|
-
/**
|
|
1527
|
-
* Overrides the default row-headers `headerCell` component.
|
|
1528
|
-
*
|
|
1529
|
-
* The default component is: [PivotGridHeaderCell](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridheadercell).
|
|
1530
|
-
*
|
|
1531
|
-
* @example
|
|
1532
|
-
* ```jsx
|
|
1533
|
-
* <PivotGrid rowHeadersCell={(props) => <CustomHeaderCell {...props} />} />
|
|
1534
|
-
* ```
|
|
1535
|
-
*/
|
|
1536
|
-
rowHeadersCell?: React_2.ComponentType<PivotGridHeaderCellProps>;
|
|
1537
|
-
/**
|
|
1538
|
-
* Overrides the default data `row` component.
|
|
1539
|
-
*
|
|
1540
|
-
* The default component is: [PivotGridRow](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridrow).
|
|
1541
|
-
*
|
|
1542
|
-
* @example
|
|
1543
|
-
* ```jsx
|
|
1544
|
-
* <PivotGrid dataRow={(props) => <CustomRow {...props} />} />
|
|
1545
|
-
* ```
|
|
1546
|
-
*/
|
|
1547
|
-
dataRow?: React_2.ComponentType<PivotGridRowProps>;
|
|
1548
|
-
/**
|
|
1549
|
-
* Overrides the default data `column` component.
|
|
1550
|
-
*
|
|
1551
|
-
* The default component is: [PivotGridColumn](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridcolumn).
|
|
1552
|
-
*
|
|
1553
|
-
* @example
|
|
1554
|
-
* ```jsx
|
|
1555
|
-
* <PivotGrid dataColumn={(props) => <CustomColumn {...props} />} />
|
|
1556
|
-
* ```
|
|
1557
|
-
*/
|
|
1558
|
-
dataColumn?: React_2.ComponentType<PivotGridColumnProps>;
|
|
1559
|
-
}
|
|
1560
|
-
|
|
1561
|
-
/**
|
|
1562
|
-
* Represents the [KendoReact PivotGridRow component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridrowprops).
|
|
1563
|
-
*/
|
|
1564
|
-
export declare const PivotGridRow: React_2.ForwardRefExoticComponent<PivotGridRowProps & React_2.RefAttributes<PivotGridRowHandle | null>>;
|
|
1565
|
-
|
|
1566
|
-
/**
|
|
1567
|
-
* Represents the object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the PivotGridRow component.
|
|
1568
|
-
*/
|
|
1569
|
-
export declare interface PivotGridRowHandle {
|
|
1570
|
-
/**
|
|
1571
|
-
* The properties passed to the PivotGridRow component.
|
|
1572
|
-
*/
|
|
1573
|
-
props: PivotGridRowProps;
|
|
1574
|
-
/**
|
|
1575
|
-
* The DOM element of the PivotGridRow component.
|
|
1576
|
-
*/
|
|
1577
|
-
element: HTMLTableRowElement | null;
|
|
1578
|
-
}
|
|
1579
|
-
|
|
1580
|
-
/**
|
|
1581
|
-
* Represents the props of the [KendoReact PivotGridRow component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridrow).
|
|
1582
|
-
*/
|
|
1583
|
-
export declare interface PivotGridRowProps extends KendoMouse<PivotGridRowHandle, HTMLTableRowElement> {
|
|
1584
|
-
/**
|
|
1585
|
-
* Sets the `className` property of the top-most element of the PivotGridRow in addition to the default `k-pivotgrid-row` class.
|
|
1586
|
-
*/
|
|
1587
|
-
className?: string;
|
|
1588
|
-
/**
|
|
1589
|
-
* Sets the `id` property of the top-most element of the PivotGridRow.
|
|
1590
|
-
*/
|
|
1591
|
-
id?: string;
|
|
1592
|
-
/**
|
|
1593
|
-
* Sets the `children` property of the top-most element of the PivotGridRow.
|
|
1594
|
-
*/
|
|
1595
|
-
children?: React_2.ReactNode;
|
|
1596
|
-
/**
|
|
1597
|
-
* Sets the `style` property of the top-most element of the PivotGridRow.
|
|
1598
|
-
*/
|
|
1599
|
-
style?: React_2.CSSProperties;
|
|
1600
|
-
/**
|
|
1601
|
-
* Sets the `tabIndex` property of the top-most element of the PivotGridRow.
|
|
1602
|
-
*/
|
|
1603
|
-
tabIndex?: number;
|
|
1604
|
-
/**
|
|
1605
|
-
* Represents the `path` leading to the current `row`.
|
|
1606
|
-
*/
|
|
1607
|
-
path?: string[];
|
|
1608
|
-
/**
|
|
1609
|
-
* Sets the `role` property of the top-most element of the PivotGridRow.
|
|
1610
|
-
*/
|
|
1611
|
-
role?: string;
|
|
1612
|
-
/**
|
|
1613
|
-
* Sets the `aria-owns` property of the top-most element of the PivotGridRow.
|
|
1614
|
-
*/
|
|
1615
|
-
ariaOwns?: string;
|
|
1616
|
-
/**
|
|
1617
|
-
* Fires when the user clicks the PivotGridRow.
|
|
1618
|
-
*/
|
|
1619
|
-
onClick?: (args: any) => void;
|
|
1620
|
-
/**
|
|
1621
|
-
* Fires when the user double-clicks the PivotGridRow.
|
|
1622
|
-
*/
|
|
1623
|
-
onDoubleClick?: (args: any) => void;
|
|
1624
|
-
/**
|
|
1625
|
-
* Fires when the user presses a mouse button while the cursor is over the PivotGridRow.
|
|
1626
|
-
*/
|
|
1627
|
-
onMouseDown?: (args: any) => void;
|
|
1628
|
-
/**
|
|
1629
|
-
* Fires when the cursor enters the PivotGridRow area.
|
|
1630
|
-
*/
|
|
1631
|
-
onMouseEnter?: (args: any) => void;
|
|
1632
|
-
/**
|
|
1633
|
-
* Fires when the cursor leaves the PivotGridRow area.
|
|
1634
|
-
*/
|
|
1635
|
-
onMouseLeave?: (args: any) => void;
|
|
1636
|
-
/**
|
|
1637
|
-
* Fires when the cursor moves within the PivotGridRow area.
|
|
1638
|
-
*/
|
|
1639
|
-
onMouseMove?: (args: any) => void;
|
|
1640
|
-
/**
|
|
1641
|
-
* Fires when the cursor moves outside the PivotGridRow area.
|
|
1642
|
-
*/
|
|
1643
|
-
onMouseOut?: (args: any) => void;
|
|
1644
|
-
/**
|
|
1645
|
-
* Fires when the cursor moves over the PivotGridRow area.
|
|
1646
|
-
*/
|
|
1647
|
-
onMouseOver?: (args: any) => void;
|
|
1648
|
-
/**
|
|
1649
|
-
* Fires when the user releases a mouse button while the cursor is over the PivotGridRow.
|
|
1650
|
-
*/
|
|
1651
|
-
onMouseUp?: (args: any) => void;
|
|
1652
|
-
}
|
|
1653
|
-
|
|
1654
|
-
/**
|
|
1655
|
-
* represents the `data` structure of the [TreeView](https://www.telerik.com/kendo-react-ui/components/treeview/api/treeview) component inside the `PivotGrid`.
|
|
1656
|
-
*/
|
|
1657
|
-
export declare interface PivotGridTreeViewData {
|
|
1658
|
-
/**
|
|
1659
|
-
* Indicates whether the item is checked.
|
|
1660
|
-
*/
|
|
1661
|
-
checked?: boolean;
|
|
1662
|
-
/**
|
|
1663
|
-
* The string value of the item.
|
|
1664
|
-
*/
|
|
1665
|
-
value?: string;
|
|
1666
|
-
/**
|
|
1667
|
-
* The data item associated with the tree view node.
|
|
1668
|
-
*/
|
|
1669
|
-
dataItem?: PivotGridField[];
|
|
1670
|
-
}
|
|
1671
|
-
|
|
1672
|
-
/**
|
|
1673
|
-
* A [React higher-order component](https://reactjs.org/docs/higher-order-components.html) which provides data-binding to local data.
|
|
1674
|
-
*/
|
|
1675
|
-
export declare const PivotLocalDataService: (props: PivotLocalDataServiceProps) => any;
|
|
1676
|
-
|
|
1677
|
-
/**
|
|
1678
|
-
* Represents the arguments of the [usePivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/usepivotlocaldataservice) hook.
|
|
1679
|
-
*/
|
|
1680
|
-
export declare interface PivotLocalDataServiceArgs {
|
|
1681
|
-
/**
|
|
1682
|
-
* Represents the dimensions object of the [usePivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/usepivotlocaldataservice) hook and the [PivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotlocaldataservice) component.
|
|
1683
|
-
*/
|
|
1684
|
-
dimensions: {
|
|
1685
|
-
[key: string]: Dimension;
|
|
1686
|
-
};
|
|
1687
|
-
/**
|
|
1688
|
-
* Represents the measures collection of the [usePivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/usepivotlocaldataservice) hook and the [PivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotlocaldataservice) component.
|
|
1689
|
-
*/
|
|
1690
|
-
measures: Measure[];
|
|
1691
|
-
/**
|
|
1692
|
-
* Represents the local data of the [usePivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/usepivotlocaldataservice) hook and the [PivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotlocaldataservice) component.
|
|
1693
|
-
*/
|
|
1694
|
-
data: any[];
|
|
1695
|
-
/**
|
|
1696
|
-
* Represents the default column axes configuration of the [usePivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/usepivotlocaldataservice) hook and the [PivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotlocaldataservice) component.
|
|
1697
|
-
*/
|
|
1698
|
-
defaultColumnAxes: PivotGridAxis[];
|
|
1699
|
-
/**
|
|
1700
|
-
* Represents the default row axes configuration of the [usePivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/usepivotlocaldataservice) hook and the [PivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotlocaldataservice) component.
|
|
1701
|
-
*/
|
|
1702
|
-
defaultRowAxes: PivotGridAxis[];
|
|
1703
|
-
/**
|
|
1704
|
-
* Represents the default measure axes configuration of the [usePivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/usepivotlocaldataservice) hook and the [PivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotlocaldataservice) component.
|
|
1705
|
-
*/
|
|
1706
|
-
defaultMeasureAxes: PivotGridAxis[];
|
|
1707
|
-
/**
|
|
1708
|
-
* Represents the default sort descriptors of the [usePivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/usepivotlocaldataservice) hook and the [PivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotlocaldataservice) component.
|
|
1709
|
-
*/
|
|
1710
|
-
defaultSort: SortDescriptor[];
|
|
1711
|
-
/**
|
|
1712
|
-
* Represents the default filter descriptors of the [usePivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/usepivotlocaldataservice) hook and the [PivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotlocaldataservice) component.
|
|
1713
|
-
*/
|
|
1714
|
-
defaultFilter: FilterDescriptor[];
|
|
1715
|
-
}
|
|
1716
|
-
|
|
1717
|
-
/**
|
|
1718
|
-
* Represents the properties of the [PivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotlocaldataservice) component.
|
|
1719
|
-
*/
|
|
1720
|
-
export declare interface PivotLocalDataServiceProps extends PivotLocalDataServiceArgs {
|
|
1721
|
-
/**
|
|
1722
|
-
* Represents the children prop of the [PivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotlocaldataservice) component.
|
|
1723
|
-
*/
|
|
1724
|
-
children: (args: PivotLocalDataServiceState) => any;
|
|
1725
|
-
}
|
|
1726
|
-
|
|
1727
|
-
/**
|
|
1728
|
-
* Represents the `state` of the [usePivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/usepivotlocaldataservice) hook and the [PivotLocalDataService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotlocaldataservice) component.
|
|
1729
|
-
*/
|
|
1730
|
-
export declare interface PivotLocalDataServiceState {
|
|
1731
|
-
/**
|
|
1732
|
-
* Represents the `PivotGrid` component props.
|
|
1733
|
-
*/
|
|
1734
|
-
pivotProps: PivotGridProps;
|
|
1735
|
-
/**
|
|
1736
|
-
* Represents the `PivotGridConfigurator` component props.
|
|
1737
|
-
*/
|
|
1738
|
-
configuratorProps: PivotGridConfiguratorProps;
|
|
1739
|
-
/**
|
|
1740
|
-
* Represents an object containing additional state data.
|
|
1741
|
-
*/
|
|
1742
|
-
state: {
|
|
1743
|
-
loading: boolean;
|
|
1744
|
-
};
|
|
1745
|
-
}
|
|
1746
|
-
|
|
1747
|
-
/**
|
|
1748
|
-
* A [React higher-order component](https://reactjs.org/docs/higher-order-components.html) which provides data-binding to an OLAP service.
|
|
1749
|
-
*/
|
|
1750
|
-
export declare const PivotOLAPService: (props: PivotOLAPServiceProps) => any;
|
|
1751
|
-
|
|
1752
|
-
/**
|
|
1753
|
-
* Represents the arguments of the [usePivotOLAPService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/usepivotolapservice) hook.
|
|
1754
|
-
*/
|
|
1755
|
-
export declare interface PivotOLAPServiceArgs {
|
|
1756
|
-
/**
|
|
1757
|
-
* The URL of the OLAP service endpoint.
|
|
1758
|
-
*/
|
|
1759
|
-
url: string;
|
|
1760
|
-
/**
|
|
1761
|
-
* The name of the cube to connect to.
|
|
1762
|
-
*/
|
|
1763
|
-
cube: string;
|
|
1764
|
-
/**
|
|
1765
|
-
* The name of the catalog containing the cube.
|
|
1766
|
-
*/
|
|
1767
|
-
catalog: string;
|
|
1768
|
-
/**
|
|
1769
|
-
* The default configuration of the column axes.
|
|
1770
|
-
*/
|
|
1771
|
-
defaultColumnAxes?: PivotGridAxis[];
|
|
1772
|
-
/**
|
|
1773
|
-
* The default configuration of the row axes.
|
|
1774
|
-
*/
|
|
1775
|
-
defaultRowAxes?: PivotGridAxis[];
|
|
1776
|
-
/**
|
|
1777
|
-
* The default configuration of the measure axes.
|
|
1778
|
-
*/
|
|
1779
|
-
defaultMeasureAxes?: PivotGridAxis[];
|
|
1780
|
-
/**
|
|
1781
|
-
* The default sort descriptors.
|
|
1782
|
-
*/
|
|
1783
|
-
defaultSort?: SortDescriptor[];
|
|
1784
|
-
/**
|
|
1785
|
-
* The default filter descriptors.
|
|
1786
|
-
*/
|
|
1787
|
-
defaultFilter?: FilterDescriptor[];
|
|
1788
|
-
}
|
|
1789
|
-
|
|
1790
|
-
/**
|
|
1791
|
-
* Represents the properties of the [PivotOLAPService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotolapservice) component.
|
|
1792
|
-
*/
|
|
1793
|
-
export declare interface PivotOLAPServiceProps extends PivotOLAPServiceArgs {
|
|
1794
|
-
/**
|
|
1795
|
-
* A render prop function that receives the service state and returns JSX elements.
|
|
1796
|
-
*/
|
|
1797
|
-
children: (args: PivotOLAPServiceState) => any;
|
|
1798
|
-
}
|
|
1799
|
-
|
|
1800
|
-
/**
|
|
1801
|
-
* Represents the `state` of the [usePivotOLAPService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/usepivotolapservice) hook and the [PivotOLAPService](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotolapservice) component.
|
|
1802
|
-
*/
|
|
1803
|
-
export declare interface PivotOLAPServiceState {
|
|
1804
|
-
/**
|
|
1805
|
-
* Properties to pass to the `PivotGrid` component.
|
|
1806
|
-
*/
|
|
1807
|
-
pivotProps: PivotGridProps;
|
|
1808
|
-
/**
|
|
1809
|
-
* Properties to pass to the `PivotGridConfigurator` component.
|
|
1810
|
-
*/
|
|
1811
|
-
configuratorProps: PivotGridConfiguratorProps;
|
|
1812
|
-
/**
|
|
1813
|
-
* The loading state and other status information.
|
|
1814
|
-
*/
|
|
1815
|
-
state: {
|
|
1816
|
-
loading: boolean;
|
|
1817
|
-
};
|
|
1818
|
-
}
|
|
1819
|
-
|
|
1820
|
-
export { sumAggregate }
|
|
1821
|
-
|
|
1822
|
-
export { Tuple }
|
|
1823
|
-
|
|
1824
|
-
/**
|
|
1825
|
-
* A [custom React hook](https://https://react.dev/learn/reusing-logic-with-custom-hooks) which provides data-binding to local data.
|
|
1826
|
-
*/
|
|
1827
|
-
export declare const usePivotLocalDataService: (args: PivotLocalDataServiceArgs) => PivotLocalDataServiceState;
|
|
1828
|
-
|
|
1829
|
-
/**
|
|
1830
|
-
* A [custom React hook](https://https://react.dev/learn/reusing-logic-with-custom-hooks) which provides data-binding to an OLAP service.
|
|
1831
|
-
*/
|
|
1832
|
-
export declare const usePivotOLAPService: (args: PivotOLAPServiceArgs) => PivotOLAPServiceState;
|
|
1833
|
-
|
|
1834
|
-
export { }
|
|
8
|
+
export { PivotGrid, type PivotGridProps, type PivotGridHandle } from './PivotGrid.js';
|
|
9
|
+
export { PivotGridColumn, type PivotGridColumnProps, type PivotGridColumnHandle } from './components/Column.js';
|
|
10
|
+
export { PivotGridRow, type PivotGridRowProps, type PivotGridRowHandle } from './components/Row.js';
|
|
11
|
+
export { PivotGridCell, type PivotGridCellProps, type PivotGridCellHandle } from './components/Cell.js';
|
|
12
|
+
export { PivotGridHeaderCell, type PivotGridHeaderCellProps, type PivotGridHeaderCellHandle } from './components/HeaderCell.js';
|
|
13
|
+
export { PivotGridContainer, type PivotGridContainerProps, type PivotGridContainerHandle } from './components/Container.js';
|
|
14
|
+
export { PivotGridConfigurator, type PivotGridConfiguratorProps, type PivotGridConfiguratorHandle } from './components/Configurator.js';
|
|
15
|
+
export { PivotGridConfiguratorEditor, type PivotGridConfiguratorEditorProps, type PivotGridConfiguratorEditorHandle } from './components/ConfiguratorEditor.js';
|
|
16
|
+
export { PivotGridConfiguratorButton, type PivotGridConfiguratorButtonProps, type PivotGridConfiguratorButtonHandle } from './components/ConfiguratorButton.js';
|
|
17
|
+
export { PivotGridFieldsEditor, type PivotGridFieldsEditorProps, type PivotGridFieldsEditorHandle, type PivotGridFieldsEditorFieldCheckEvent, type PivotGridFieldsEditorFieldExpandEvent } from './components/FieldsEditor.js';
|
|
18
|
+
export { PivotGridAxesEditor, type PivotGridAxesEditorProps, type PivotGridAxesEditorHandle } from './components/AxesEditor.js';
|
|
19
|
+
export { PivotGridAxisEditor, type PivotGridAxisEditorProps, type PivotGridAxisEditorHandle } from './components/AxisEditor.js';
|
|
20
|
+
export { PivotGridAxisFilterFieldsEditor, type PivotGridAxisFilterFieldsEditorProps, type PivotGridAxisFilterFieldsEditorHandle, type PivotGridAxisFilterFieldExpandEvent, type PivotGridAxisFilterFieldsExpandChangeEvent } from './components/AxisFilterFieldsEditor.js';
|
|
21
|
+
export { PivotOLAPService, usePivotOLAPService, type PivotOLAPServiceArgs, type PivotOLAPServiceProps, type PivotOLAPServiceState } from './hooks/usePivotOLAPService.js';
|
|
22
|
+
export { usePivotLocalDataService, PivotLocalDataService, type PivotLocalDataServiceArgs, type PivotLocalDataServiceProps, type PivotLocalDataServiceState } from './hooks/usePivotLocalDataService.js';
|
|
23
|
+
export { type PivotGridTreeViewData, type PivotGridAxesChangeEvent, type PivotGridConfiguratorAxesChangeEvent, type PivotGridConfiguratorSortChangeEvent, type PivotGridConfiguratorFilterChangeEvent } from './models/index.js';
|
|
24
|
+
export { dataCells } from './utils/index.js';
|
|
25
|
+
export { type PivotGridAxis, type AxisDataItem, type AxisRow, type DimensionField, type HierarchyField, type KPIField, type KPIMeasureField, type LevelField, type MeasureField, type Member, type MemberField, type PivotDataItem, type Tuple, sumAggregate, averageAggregate, minAggregate, maxAggregate, createAggregate, AggregateType, type Aggregate, type Dimension, type Measure } from '@progress/kendo-pivotgrid-common';
|