@progress/kendo-react-pivotgrid 13.3.0-develop.9 → 13.4.0-develop.1

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.
Files changed (41) hide show
  1. package/PivotGrid.d.ts +303 -0
  2. package/components/AxesEditor.d.ts +57 -0
  3. package/components/AxisEditor.d.ts +65 -0
  4. package/components/AxisEditor.mjs +3 -3
  5. package/components/AxisFilterFieldsEditor.d.ts +145 -0
  6. package/components/Cell.d.ts +114 -0
  7. package/components/Column.d.ts +91 -0
  8. package/components/Configurator.d.ts +140 -0
  9. package/components/ConfiguratorButton.d.ts +89 -0
  10. package/components/ConfiguratorButton.mjs +4 -4
  11. package/components/ConfiguratorEditor.d.ts +144 -0
  12. package/components/ConfiguratorEditor.js +1 -1
  13. package/components/ConfiguratorEditor.mjs +1 -2
  14. package/components/Container.d.ts +64 -0
  15. package/components/EditorContext.d.ts +14 -0
  16. package/components/FieldsEditor.d.ts +87 -0
  17. package/components/FieldsEditor.mjs +3 -3
  18. package/components/HeaderCell.d.ts +144 -0
  19. package/components/HeaderCell.mjs +4 -4
  20. package/components/Row.d.ts +99 -0
  21. package/dist/cdn/js/kendo-react-pivotgrid.js +1 -1
  22. package/hooks/index.d.ts +9 -0
  23. package/hooks/useExpansion.d.ts +26 -0
  24. package/hooks/useHeaders.d.ts +18 -0
  25. package/hooks/useHorizontalScrollSync.d.ts +12 -0
  26. package/hooks/usePivotConfiguratorEditor.d.ts +90 -0
  27. package/hooks/usePivotLocalDataService.d.ts +86 -0
  28. package/hooks/usePivotOLAPService.d.ts +84 -0
  29. package/hooks/useVerticalScrollSync.d.ts +12 -0
  30. package/index.d.mts +18 -1827
  31. package/index.d.ts +18 -1827
  32. package/messages/index.d.ts +77 -0
  33. package/models/index.d.ts +96 -0
  34. package/package-metadata.d.ts +12 -0
  35. package/package-metadata.js +1 -1
  36. package/package-metadata.mjs +10 -16
  37. package/package.json +10 -10
  38. package/shared/PivotGridConfiguratorEditorEventsContext.d.ts +20 -0
  39. package/shared/PivotGridConfiguratorEditorStateContext.d.ts +13 -0
  40. package/shared/index.d.ts +9 -0
  41. package/utils/index.d.ts +54 -0
@@ -0,0 +1,64 @@
1
+ /**
2
+ * @license
3
+ *-------------------------------------------------------------------------------------------
4
+ * Copyright © 2026 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 * as React from 'react';
9
+ /**
10
+ * Represents the props of the [KendoReact PivotGridContainer component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridcontainer).
11
+ */
12
+ export interface PivotGridContainerProps {
13
+ /**
14
+ * Sets the `id` property of the top-most element of the PivotGridContainer.
15
+ */
16
+ id?: string;
17
+ /**
18
+ * Sets the `tabIndex` property of the top-most element of the PivotGridContainer.
19
+ */
20
+ tabIndex?: number;
21
+ /**
22
+ * Sets the `className` property of the top-most element of the PivotGridContainer in addition to the default `k-d-flex k-pos-relative` class.
23
+ */
24
+ className?: string;
25
+ /**
26
+ * Sets the `children` property of the top-most element of the PivotGridContainer.
27
+ */
28
+ children?: React.ReactNode;
29
+ /**
30
+ * Sets the `style` property of the top-most element of the PivotGridContainer.
31
+ */
32
+ style?: React.CSSProperties;
33
+ /**
34
+ * Sets the configurator position in the container.
35
+ * The available values are:
36
+ * - top
37
+ * - left
38
+ * - right
39
+ * - bottom
40
+ *
41
+ * @default 'right'
42
+ */
43
+ configuratorPosition?: 'top' | 'left' | 'right' | 'bottom';
44
+ }
45
+ /**
46
+ * 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.
47
+ */
48
+ export interface PivotGridContainerHandle {
49
+ /**
50
+ * The DOM element of the PivotGridContainer component.
51
+ */
52
+ element: HTMLDivElement | null;
53
+ /**
54
+ * The properties passed to the PivotGridContainer component.
55
+ */
56
+ props: PivotGridContainerProps;
57
+ }
58
+ /**
59
+ * Represents the [KendoReact PivotGridContainer component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridcontainerprops).
60
+ *
61
+ * @remarks
62
+ * Supported children components are: {@link PivotGrid}, {@link PivotGridConfigurator}, {@link PivotGridConfiguratorButton}, {@link Loader}.
63
+ */
64
+ export declare const PivotGridContainer: React.ForwardRefExoticComponent<PivotGridContainerProps & React.RefAttributes<PivotGridContainerHandle | null>>;
@@ -0,0 +1,14 @@
1
+ /**
2
+ * @license
3
+ *-------------------------------------------------------------------------------------------
4
+ * Copyright © 2026 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 * as React from 'react';
9
+ /**
10
+ * @hidden
11
+ */
12
+ export declare const PivotGridConfiguratorEditorAxesContext: React.Context<{
13
+ axes: string | null;
14
+ }>;
@@ -0,0 +1,87 @@
1
+ /**
2
+ * @license
3
+ *-------------------------------------------------------------------------------------------
4
+ * Copyright © 2026 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 { TreeViewProps as KendoReactTreeViewProps } from '@progress/kendo-react-treeview';
9
+ import { PivotGridField, PivotGridAxis } from '@progress/kendo-pivotgrid-common';
10
+ import { CustomComponent } from '@progress/kendo-react-common';
11
+ import * as React from 'react';
12
+ /**
13
+ * @hidden
14
+ */
15
+ export interface PivotGridFieldsEditorFieldExpandEvent {
16
+ target: PivotGridFieldsEditorHandle;
17
+ value: PivotGridField;
18
+ syntheticEvent: React.SyntheticEvent;
19
+ }
20
+ /**
21
+ * @hidden
22
+ */
23
+ export interface PivotGridFieldsEditorFieldCheckEvent {
24
+ target: PivotGridFieldsEditorHandle;
25
+ value: PivotGridField;
26
+ syntheticEvent: React.SyntheticEvent;
27
+ }
28
+ /**
29
+ * Represents the props of the [KendoReact PivotGridFieldsEditor component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridfieldseditor).
30
+ */
31
+ export interface PivotGridFieldsEditorProps {
32
+ /**
33
+ * Sets the `data` of the PivotGridConfiguratorEditor.
34
+ *
35
+ * The `data` represents all fields available in the configurator.
36
+ */
37
+ data?: PivotGridField[];
38
+ /**
39
+ * The configuration of the `row` axes.
40
+ */
41
+ rowAxes?: PivotGridAxis[];
42
+ /**
43
+ * The configuration of the `column` axes.
44
+ */
45
+ columnAxes?: PivotGridAxis[];
46
+ /**
47
+ * The configuration of the `measure` axes.
48
+ */
49
+ measureAxes?: PivotGridAxis[];
50
+ /**
51
+ * A callback, fired whenever an `expand` is triggered.
52
+ */
53
+ onExpand?: (args: PivotGridFieldsEditorFieldExpandEvent) => void;
54
+ /**
55
+ * A callback, fired whenever a `check` is triggered.
56
+ */
57
+ onCheck?: (args: PivotGridFieldsEditorFieldCheckEvent) => void;
58
+ /**
59
+ * Overrides the default `treeView` component.
60
+ *
61
+ * The default component is: [KendoReactTreeView](https://www.telerik.com/kendo-react-ui/components/treeview/api/treeview).
62
+ */
63
+ treeView?: CustomComponent<KendoReactTreeViewProps>;
64
+ /**
65
+ * Overrides the default `noData` component.
66
+ *
67
+ * The default component is: `() => <div>NO DATA</div>`
68
+ */
69
+ noData?: CustomComponent<any>;
70
+ }
71
+ /**
72
+ * 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.
73
+ */
74
+ export interface PivotGridFieldsEditorHandle {
75
+ /**
76
+ * The properties passed to the PivotGridFieldsEditor component.
77
+ */
78
+ props: PivotGridFieldsEditorProps;
79
+ /**
80
+ * The DOM element of the PivotGridFieldsEditor component.
81
+ */
82
+ element: HTMLDivElement | null;
83
+ }
84
+ /**
85
+ * Represents the [KendoReact PivotGridFieldsEditor component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridfieldseditorprops).
86
+ */
87
+ export declare const PivotGridFieldsEditor: React.ForwardRefExoticComponent<PivotGridFieldsEditorProps & React.RefAttributes<PivotGridFieldsEditorHandle | null>>;
@@ -6,7 +6,7 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  import * as t from "react";
9
- import { TreeViewItemPropsContext as A, TreeView as V } from "@progress/kendo-react-treeview";
9
+ import { TreeView as A, TreeViewItemPropsContext as V } from "@progress/kendo-react-treeview";
10
10
  import { useCustomComponent as h, canUseRef as D } from "@progress/kendo-react-common";
11
11
  import { extractDefaultFields as d, flatMap as R, recursiveMap as f } from "../utils/index.mjs";
12
12
  import { PivotGridConfiguratorEditorStateContext as T } from "../shared/PivotGridConfiguratorEditorStateContext.mjs";
@@ -47,7 +47,7 @@ const b = t.forwardRef(
47
47
  syntheticEvent: e.syntheticEvent
48
48
  });
49
49
  }, c = f(r.data, u);
50
- return /* @__PURE__ */ t.createElement(A.Provider, { value: (e) => ({ ...e, checkboxes: e.item.selectable }) }, c && c.length ? /* @__PURE__ */ t.createElement(
50
+ return /* @__PURE__ */ t.createElement(V.Provider, { value: (e) => ({ ...e, checkboxes: e.item.selectable }) }, c && c.length ? /* @__PURE__ */ t.createElement(
51
51
  l,
52
52
  {
53
53
  ref: D(l) ? i : void 0,
@@ -69,7 +69,7 @@ const b = t.forwardRef(
69
69
  rowAxes: [],
70
70
  columnAxes: [],
71
71
  measureAxes: [],
72
- treeView: V,
72
+ treeView: A,
73
73
  noData: () => /* @__PURE__ */ t.createElement("div", null, "NO DATA")
74
74
  };
75
75
  b.displayName = "KendoReactPivotGridFieldsEditor";
@@ -0,0 +1,144 @@
1
+ /**
2
+ * @license
3
+ *-------------------------------------------------------------------------------------------
4
+ * Copyright © 2026 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 { KendoMouse, KendoMouseEvent, SvgIconProps, IconProps as KendoIconProps, CustomComponent } from '@progress/kendo-react-common';
9
+ import { AxisDataItem } from '@progress/kendo-pivotgrid-common';
10
+ import * as React from 'react';
11
+ /**
12
+ * 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.
13
+ */
14
+ export interface PivotGridHeaderCellHandle {
15
+ /**
16
+ * The properties passed to the PivotGridHeaderCell component.
17
+ */
18
+ props: PivotGridHeaderCellProps;
19
+ /**
20
+ * The DOM element of the PivotGridHeaderCell component.
21
+ */
22
+ element: HTMLTableHeaderCellElement | null;
23
+ }
24
+ /**
25
+ * Represents the props of the [KendoReact PivotGridHeaderCell component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridheadercell).
26
+ */
27
+ export interface PivotGridHeaderCellProps extends KendoMouse<PivotGridHeaderCellHandle, HTMLTableHeaderCellElement> {
28
+ /**
29
+ * Represents the `dataItem` of the PivotGridHeaderCell.
30
+ *
31
+ * The `dataItem` is a single [AxisDataItem](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/axisdataitem) object.
32
+ */
33
+ dataItem: AxisDataItem;
34
+ /**
35
+ * Sets the `id` property of the top-most element of the PivotGridHeaderCell.
36
+ */
37
+ id?: string;
38
+ /**
39
+ * Sets the `className` property of the top-most element of the PivotGridHeaderCell in addition to the default `k-pivotgrid-cell` class.
40
+ */
41
+ className?: string;
42
+ /**
43
+ * Sets the `tabIndex` property of the top-most element of the PivotGridHeaderCell.
44
+ */
45
+ tabIndex?: number;
46
+ /**
47
+ * Sets the `children` property of the top-most element of the PivotGridHeaderCell.
48
+ */
49
+ children?: React.ReactNode;
50
+ /**
51
+ * Sets the `style` property of the top-most element of the PivotGridHeaderCell.
52
+ */
53
+ style?: React.CSSProperties;
54
+ /**
55
+ * Represents the calculated `rowSpan` property of the cell.
56
+ */
57
+ rowSpan?: number;
58
+ /**
59
+ * Represents the calculated `colSpan` property of the cell.
60
+ */
61
+ colSpan?: number;
62
+ /**
63
+ * Represents the columns `path` leading to the current cell.
64
+ */
65
+ columnPath?: string[];
66
+ /**
67
+ * Represents the row `path` leading to the current cell.
68
+ */
69
+ rowPath?: string[];
70
+ /**
71
+ * Indicates if the current cell represents a `total` value.
72
+ */
73
+ total?: boolean;
74
+ /**
75
+ * Indicates if the current cell represents the first level of a hierarchy.
76
+ */
77
+ root?: boolean;
78
+ /**
79
+ * Indicates if the current cell can be expanded.
80
+ */
81
+ expandable?: boolean;
82
+ /**
83
+ * Indicates if the current cell is expanded.
84
+ */
85
+ expanded?: boolean;
86
+ /**
87
+ * @hidden
88
+ */
89
+ first?: boolean;
90
+ /**
91
+ * Overrides the default `icon` component.
92
+ *
93
+ * The default component is: [KendoReactIcon](https://www.telerik.com/kendo-react-ui/components/common/api/icon).
94
+ */
95
+ icon?: CustomComponent<KendoIconProps & SvgIconProps>;
96
+ /**
97
+ * A callback, fired whenever the `icon` is clicked.
98
+ */
99
+ onIconClick?: (args: KendoMouseEvent<PivotGridHeaderCellHandle, HTMLSpanElement>) => void;
100
+ /**
101
+ * Sets the `role` property of the top-most element of the PivotGridHeaderCell.
102
+ */
103
+ role?: string;
104
+ /**
105
+ * Fires when the user clicks the PivotGridHeaderCell.
106
+ */
107
+ onClick?: (args: any) => void;
108
+ /**
109
+ * Fires when the user double-clicks the PivotGridHeaderCell.
110
+ */
111
+ onDoubleClick?: (args: any) => void;
112
+ /**
113
+ * Fires when the user presses a mouse button while the cursor is over the PivotGridHeaderCell.
114
+ */
115
+ onMouseDown?: (args: any) => void;
116
+ /**
117
+ * Fires when the cursor enters the PivotGridHeaderCell area.
118
+ */
119
+ onMouseEnter?: (args: any) => void;
120
+ /**
121
+ * Fires when the cursor leaves the PivotGridHeaderCell area.
122
+ */
123
+ onMouseLeave?: (args: any) => void;
124
+ /**
125
+ * Fires when the cursor moves within the PivotGridHeaderCell area.
126
+ */
127
+ onMouseMove?: (args: any) => void;
128
+ /**
129
+ * Fires when the cursor moves outside the PivotGridHeaderCell area.
130
+ */
131
+ onMouseOut?: (args: any) => void;
132
+ /**
133
+ * Fires when the cursor moves over the PivotGridHeaderCell area.
134
+ */
135
+ onMouseOver?: (args: any) => void;
136
+ /**
137
+ * Fires when the user releases a mouse button while the cursor is over the PivotGridHeaderCell.
138
+ */
139
+ onMouseUp?: (args: any) => void;
140
+ }
141
+ /**
142
+ * Represents the [KendoReact PivotGridHeaderCell component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridheadercellprops).
143
+ */
144
+ export declare const PivotGridHeaderCell: React.ForwardRefExoticComponent<PivotGridHeaderCellProps & React.RefAttributes<PivotGridHeaderCellHandle | null>>;
@@ -6,7 +6,7 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  import * as n from "react";
9
- import { useCustomComponent as m, useMouse as u, classNames as s, IconWrap as v } from "@progress/kendo-react-common";
9
+ import { useCustomComponent as m, IconWrap as u, useMouse as s, classNames as v } from "@progress/kendo-react-common";
10
10
  import { chevronUpIcon as f, chevronDownIcon as I } from "@progress/kendo-svg-icons";
11
11
  const h = n.forwardRef(
12
12
  (e, o) => {
@@ -18,7 +18,7 @@ const h = n.forwardRef(
18
18
  o,
19
19
  () => t.current
20
20
  );
21
- const [c, d] = m(e.icon || x.icon), l = u(
21
+ const [c, d] = m(e.icon || x.icon), l = s(
22
22
  e,
23
23
  t
24
24
  ), i = (r) => {
@@ -39,7 +39,7 @@ const h = n.forwardRef(
39
39
  tabIndex: e.tabIndex,
40
40
  role: e.role,
41
41
  ...e.expandable ? { "aria-expanded": e.expanded } : {},
42
- className: s(
42
+ className: v(
43
43
  "k-pivotgrid-cell",
44
44
  {
45
45
  "k-pivotgrid-header-total": e.total,
@@ -65,7 +65,7 @@ const h = n.forwardRef(
65
65
  );
66
66
  }
67
67
  ), x = {
68
- icon: v
68
+ icon: u
69
69
  };
70
70
  h.displayName = "KendoReactPivotGridHeaderCell";
71
71
  export {
@@ -0,0 +1,99 @@
1
+ /**
2
+ * @license
3
+ *-------------------------------------------------------------------------------------------
4
+ * Copyright © 2026 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 { KendoMouse } from '@progress/kendo-react-common';
9
+ import * as React from 'react';
10
+ /**
11
+ * 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.
12
+ */
13
+ export interface PivotGridRowHandle {
14
+ /**
15
+ * The properties passed to the PivotGridRow component.
16
+ */
17
+ props: PivotGridRowProps;
18
+ /**
19
+ * The DOM element of the PivotGridRow component.
20
+ */
21
+ element: HTMLTableRowElement | null;
22
+ }
23
+ /**
24
+ * Represents the props of the [KendoReact PivotGridRow component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridrow).
25
+ */
26
+ export interface PivotGridRowProps extends KendoMouse<PivotGridRowHandle, HTMLTableRowElement> {
27
+ /**
28
+ * Sets the `className` property of the top-most element of the PivotGridRow in addition to the default `k-pivotgrid-row` class.
29
+ */
30
+ className?: string;
31
+ /**
32
+ * Sets the `id` property of the top-most element of the PivotGridRow.
33
+ */
34
+ id?: string;
35
+ /**
36
+ * Sets the `children` property of the top-most element of the PivotGridRow.
37
+ */
38
+ children?: React.ReactNode;
39
+ /**
40
+ * Sets the `style` property of the top-most element of the PivotGridRow.
41
+ */
42
+ style?: React.CSSProperties;
43
+ /**
44
+ * Sets the `tabIndex` property of the top-most element of the PivotGridRow.
45
+ */
46
+ tabIndex?: number;
47
+ /**
48
+ * Represents the `path` leading to the current `row`.
49
+ */
50
+ path?: string[];
51
+ /**
52
+ * Sets the `role` property of the top-most element of the PivotGridRow.
53
+ */
54
+ role?: string;
55
+ /**
56
+ * Sets the `aria-owns` property of the top-most element of the PivotGridRow.
57
+ */
58
+ ariaOwns?: string;
59
+ /**
60
+ * Fires when the user clicks the PivotGridRow.
61
+ */
62
+ onClick?: (args: any) => void;
63
+ /**
64
+ * Fires when the user double-clicks the PivotGridRow.
65
+ */
66
+ onDoubleClick?: (args: any) => void;
67
+ /**
68
+ * Fires when the user presses a mouse button while the cursor is over the PivotGridRow.
69
+ */
70
+ onMouseDown?: (args: any) => void;
71
+ /**
72
+ * Fires when the cursor enters the PivotGridRow area.
73
+ */
74
+ onMouseEnter?: (args: any) => void;
75
+ /**
76
+ * Fires when the cursor leaves the PivotGridRow area.
77
+ */
78
+ onMouseLeave?: (args: any) => void;
79
+ /**
80
+ * Fires when the cursor moves within the PivotGridRow area.
81
+ */
82
+ onMouseMove?: (args: any) => void;
83
+ /**
84
+ * Fires when the cursor moves outside the PivotGridRow area.
85
+ */
86
+ onMouseOut?: (args: any) => void;
87
+ /**
88
+ * Fires when the cursor moves over the PivotGridRow area.
89
+ */
90
+ onMouseOver?: (args: any) => void;
91
+ /**
92
+ * Fires when the user releases a mouse button while the cursor is over the PivotGridRow.
93
+ */
94
+ onMouseUp?: (args: any) => void;
95
+ }
96
+ /**
97
+ * Represents the [KendoReact PivotGridRow component](https://www.telerik.com/kendo-react-ui/components/pivotgrid/api/pivotgridrowprops).
98
+ */
99
+ export declare const PivotGridRow: React.ForwardRefExoticComponent<PivotGridRowProps & React.RefAttributes<PivotGridRowHandle | null>>;