@progress/kendo-react-pivotgrid 12.0.2-develop.1 → 12.0.2-develop.2

package/index.d.mts

@@ -117,8 +117,17 @@ export declare const PivotGrid: React_2.ForwardRefExoticComponent<PivotGridProps
  * Represents the event arguments of the [`onColumnAxesChange`]({% slug api_pivotgrid_pivotgridprops %}#toc-oncolumnaxeschange) and [`onRowAxesChange`]({% slug api_pivotgrid_pivotgridprops %}#toc-onrowaxeschange) callbacks of the [`PivotGrid`]({% slug api_pivotgrid_pivotgrid %}) component.
  */
 export declare interface PivotGridAxesChangeEvent {
+    /**
+     * The new axes configuration value.
+     */
     value: PivotGridAxis[];
+    /**
+     * The handle of the PivotGrid component.
+     */
     target: PivotGridHandle | null;
+    /**
+     * The DOM event that triggered the change.
+     */
     syntheticEvent: React.SyntheticEvent;
 }
 
@@ -131,7 +140,13 @@ export declare const PivotGridAxesEditor: React_2.ForwardRefExoticComponent<Pivo
  * 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.
  */
 export declare interface PivotGridAxesEditorHandle {
+    /**
+     * The properties passed to the PivotGridAxesEditor component.
+     */
     props: PivotGridAxesEditorProps;
+    /**
+     * The DOM element of the PivotGridAxesEditor component.
+     */
     element: HTMLDivElement | null;
 }
 
@@ -175,7 +190,13 @@ export declare const PivotGridAxisEditor: React_2.ForwardRefExoticComponent<Pivo
  * 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.
  */
 export declare interface PivotGridAxisEditorHandle {
+    /**
+     * The properties passed to the PivotGridAxisEditor component.
+     */
     props: PivotGridAxisEditorProps;
+    /**
+     * The DOM element of the PivotGridAxisEditor component.
+     */
     element: HTMLSpanElement | null;
 }
 
@@ -219,8 +240,17 @@ export declare interface PivotGridAxisEditorProps extends ChipProps {
  * Represents the event arguments of the `PivotGridAxisFilterField` expand event.
  */
 export declare interface PivotGridAxisFilterFieldExpandEvent {
+    /**
+     * The handle of the component that triggered the event.
+     */
     target: PivotGridAxisFilterFieldsEditorHandle;
+    /**
+     * The field that was expanded.
+     */
     value: PivotGridField;
+    /**
+     * The DOM event that triggered the expand.
+     */
     syntheticEvent: React_2.SyntheticEvent;
 }
 
@@ -233,7 +263,13 @@ export declare const PivotGridAxisFilterFieldsEditor: React_2.ForwardRefExoticCo
  * 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.
  */
 export declare interface PivotGridAxisFilterFieldsEditorHandle {
+    /**
+     * The properties passed to the PivotGridAxisFilterFieldsEditor component.
+     */
     props: PivotGridAxisFilterFieldsEditorProps;
+    /**
+     * The DOM element of the PivotGridAxisFilterFieldsEditor component.
+     */
     element: HTMLDivElement | null;
 }
 
@@ -322,8 +358,17 @@ export declare interface PivotGridAxisFilterFieldsEditorProps {
  * Represents the event arguments of the `PivotGridAxisFilterFields` expand-change event.
  */
 export declare interface PivotGridAxisFilterFieldsExpandChangeEvent {
+    /**
+     * The handle of the component that triggered the event.
+     */
     target: PivotGridAxisFilterFieldsEditorHandle;
+    /**
+     * The expand state value.
+     */
     value: boolean;
+    /**
+     * The DOM event that triggered the change.
+     */
     syntheticEvent: React_2.SyntheticEvent;
 }
 
@@ -336,7 +381,13 @@ export declare const PivotGridCell: React_2.ForwardRefExoticComponent<PivotGridC
  * 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.
  */
 export declare interface PivotGridCellHandle {
+    /**
+     * The properties passed to the PivotGridCell component.
+     */
     props: PivotGridCellProps;
+    /**
+     * The DOM element of the PivotGridCell component.
+     */
     element: HTMLTableCellElement | null;
 }
 
@@ -390,6 +441,42 @@ export declare interface PivotGridCellProps extends KendoMouse<PivotGridCellHand
      * Sets the `aria-describedby` property of the top-most element of the PivotGridCell.
      */
     ariaDescribedby?: string;
+    /**
+     * Fires when the user clicks the PivotGridCell.
+     */
+    onClick?: (args: any) => void;
+    /**
+     * Fires when the user double-clicks the PivotGridCell.
+     */
+    onDoubleClick?: (args: any) => void;
+    /**
+     * Fires when the user presses a mouse button while the cursor is over the PivotGridCell.
+     */
+    onMouseDown?: (args: any) => void;
+    /**
+     * Fires when the cursor enters the PivotGridCell area.
+     */
+    onMouseEnter?: (args: any) => void;
+    /**
+     * Fires when the cursor leaves the PivotGridCell area.
+     */
+    onMouseLeave?: (args: any) => void;
+    /**
+     * Fires when the cursor moves within the PivotGridCell area.
+     */
+    onMouseMove?: (args: any) => void;
+    /**
+     * Fires when the cursor moves outside the PivotGridCell area.
+     */
+    onMouseOut?: (args: any) => void;
+    /**
+     * Fires when the cursor moves over the PivotGridCell area.
+     */
+    onMouseOver?: (args: any) => void;
+    /**
+     * Fires when the user releases a mouse button while the cursor is over the PivotGridCell.
+     */
+    onMouseUp?: (args: any) => void;
 }
 
 /**
@@ -401,7 +488,13 @@ export declare const PivotGridColumn: React_2.ForwardRefExoticComponent<PivotGri
  * 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.
  */
 export declare interface PivotGridColumnHandle {
+    /**
+     * The properties passed to the PivotGridColumn component.
+     */
     props: PivotGridColumnProps;
+    /**
+     * The DOM element of the PivotGridColumn component.
+     */
     element: HTMLTableColElement | null;
 }
 
@@ -433,6 +526,42 @@ export declare interface PivotGridColumnProps extends KendoMouse<PivotGridColumn
      * Represents the `path` leading to the current `column`.
      */
     path?: string[];
+    /**
+     * Fires when the user clicks the PivotGridColumn.
+     */
+    onClick?: (args: any) => void;
+    /**
+     * Fires when the user double-clicks the PivotGridColumn.
+     */
+    onDoubleClick?: (args: any) => void;
+    /**
+     * Fires when the user presses a mouse button while the cursor is over the PivotGridColumn.
+     */
+    onMouseDown?: (args: any) => void;
+    /**
+     * Fires when the cursor enters the PivotGridColumn area.
+     */
+    onMouseEnter?: (args: any) => void;
+    /**
+     * Fires when the cursor leaves the PivotGridColumn area.
+     */
+    onMouseLeave?: (args: any) => void;
+    /**
+     * Fires when the cursor moves within the PivotGridColumn area.
+     */
+    onMouseMove?: (args: any) => void;
+    /**
+     * Fires when the cursor moves outside the PivotGridColumn area.
+     */
+    onMouseOut?: (args: any) => void;
+    /**
+     * Fires when the cursor moves over the PivotGridColumn area.
+     */
+    onMouseOver?: (args: any) => void;
+    /**
+     * Fires when the user releases a mouse button while the cursor is over the PivotGridColumn.
+     */
+    onMouseUp?: (args: any) => void;
 }
 
 /**
@@ -473,8 +602,17 @@ declare interface PivotGridConfiguratorAction {
  * Represents the event arguments of the [`onColumnAxesChange`]({% slug api_pivotgrid_pivotgridconfiguratorprops %}#toc-oncolumnaxeschange), [`onRowAxesChange`]({% slug api_pivotgrid_pivotgridconfiguratorprops %}#toc-onrowaxeschange) and [`onMeasureAxesChange`]({% slug api_pivotgrid_pivotgridconfiguratorprops %}#toc-onmeasureaxeschange) callbacks of the [`PivotGridConfigurator`]({% slug api_pivotgrid_pivotgridconfigurator %}) component.
  */
 export declare interface PivotGridConfiguratorAxesChangeEvent {
+    /**
+     * The new axes configuration value.
+     */
     value: PivotGridAxis[];
+    /**
+     * The handle of the PivotGridConfigurator component.
+     */
     target: PivotGridConfiguratorHandle | null;
+    /**
+     * The DOM event that triggered the change.
+     */
     syntheticEvent: React.SyntheticEvent;
 }
 
@@ -487,7 +625,13 @@ export declare const PivotGridConfiguratorButton: React_2.ForwardRefExoticCompon
  * 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.
  */
 export declare interface PivotGridConfiguratorButtonHandle {
+    /**
+     * The properties passed to the PivotGridConfiguratorButton component.
+     */
     props: PivotGridConfiguratorButtonProps;
+    /**
+     * The DOM element of the PivotGridConfiguratorButton component.
+     */
     element: HTMLDivElement | null;
 }
 
@@ -517,6 +661,42 @@ export declare interface PivotGridConfiguratorButtonProps extends KendoMouse<Piv
      * The default component is: [KendoReactIcon]({% slug api_common_icon %}).
      */
     icon?: CustomComponent<IconProps & SvgIconProps>;
+    /**
+     * Fires when the user clicks the PivotGridConfiguratorButton.
+     */
+    onClick?: (args: any) => void;
+    /**
+     * Fires when the user double-clicks the PivotGridConfiguratorButton.
+     */
+    onDoubleClick?: (args: any) => void;
+    /**
+     * Fires when the user presses a mouse button while the cursor is over the PivotGridConfiguratorButton.
+     */
+    onMouseDown?: (args: any) => void;
+    /**
+     * Fires when the cursor enters the PivotGridConfiguratorButton area.
+     */
+    onMouseEnter?: (args: any) => void;
+    /**
+     * Fires when the cursor leaves the PivotGridConfiguratorButton area.
+     */
+    onMouseLeave?: (args: any) => void;
+    /**
+     * Fires when the cursor moves within the PivotGridConfiguratorButton area.
+     */
+    onMouseMove?: (args: any) => void;
+    /**
+     * Fires when the cursor moves outside the PivotGridConfiguratorButton area.
+     */
+    onMouseOut?: (args: any) => void;
+    /**
+     * Fires when the cursor moves over the PivotGridConfiguratorButton area.
+     */
+    onMouseOver?: (args: any) => void;
+    /**
+     * Fires when the user releases a mouse button while the cursor is over the PivotGridConfiguratorButton.
+     */
+    onMouseUp?: (args: any) => void;
 }
 
 /**
@@ -528,8 +708,17 @@ export declare const PivotGridConfiguratorEditor: React_2.ForwardRefExoticCompon
  * 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.
  */
 export declare interface PivotGridConfiguratorEditorHandle {
+    /**
+     * The properties passed to the PivotGridConfiguratorEditor component.
+     */
     props: PivotGridConfiguratorEditorProps;
+    /**
+     * The current state of the PivotGridConfiguratorEditor component.
+     */
     state: PivotGridConfiguratorState;
+    /**
+     * The DOM element of the PivotGridConfiguratorEditor component.
+     */
     element: HTMLDivElement;
 }
 
@@ -545,6 +734,8 @@ export declare interface PivotGridConfiguratorEditorProps extends FormRenderProp
     data: PivotGridField[];
     /**
      * Renders the PivotGridConfiguratorEditor in `horizontal` orientation.
+     *
+     * @default false
      */
     horizontal?: boolean;
     /**
@@ -650,8 +841,17 @@ declare interface PivotGridConfiguratorEditorState extends PivotGridConfigurator
  * Represents the event arguments of the [`onFilterChange`]({% slug api_pivotgrid_pivotgridconfiguratorprops %}#toc-onfilterchange) callbacks of the [`PivotGridConfigurator`]({% slug api_pivotgrid_pivotgridconfigurator %}) component.
  */
 export declare interface PivotGridConfiguratorFilterChangeEvent {
+    /**
+     * The new filter descriptors value.
+     */
     value: FilterDescriptor[];
+    /**
+     * The handle of the PivotGridConfigurator component.
+     */
     target: PivotGridConfiguratorHandle | null;
+    /**
+     * The DOM event that triggered the change.
+     */
     syntheticEvent: React.SyntheticEvent;
 }
 
@@ -659,7 +859,13 @@ export declare interface PivotGridConfiguratorFilterChangeEvent {
  * 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.
  */
 export declare interface PivotGridConfiguratorHandle {
+    /**
+     * The properties passed to the PivotGridConfigurator component.
+     */
     props: PivotGridConfiguratorProps;
+    /**
+     * The DOM element of the PivotGridConfigurator component.
+     */
     element: HTMLDivElement | null;
 }
 
@@ -685,6 +891,8 @@ export declare interface PivotGridConfiguratorProps {
     style?: React_2.CSSProperties;
     /**
      * Renders the PivotGridConfigurator in `horizontal` orientation.
+     *
+     * @default false
      */
     horizontal?: boolean;
     /**
@@ -773,8 +981,17 @@ export declare interface PivotGridConfiguratorProps {
  * Represents the event arguments of the [`onSortChange`]({% slug api_pivotgrid_pivotgridconfiguratorprops %}#toc-onsortchange) callbacks of the [`PivotGridConfigurator`]({% slug api_pivotgrid_pivotgridconfigurator %}) component.
  */
 export declare interface PivotGridConfiguratorSortChangeEvent {
+    /**
+     * The new sort descriptors value.
+     */
     value: SortDescriptor[];
+    /**
+     * The handle of the PivotGridConfigurator component.
+     */
     target: PivotGridConfiguratorHandle | null;
+    /**
+     * The DOM event that triggered the change.
+     */
     syntheticEvent: React.SyntheticEvent;
 }
 
@@ -790,7 +1007,13 @@ export declare const PivotGridContainer: React_2.ForwardRefExoticComponent<Pivot
  * 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.
  */
 export declare interface PivotGridContainerHandle {
+    /**
+     * The DOM element of the PivotGridContainer component.
+     */
     element: HTMLDivElement | null;
+    /**
+     * The properties passed to the PivotGridContainer component.
+     */
     props: PivotGridContainerProps;
 }
 
@@ -825,6 +1048,8 @@ export declare interface PivotGridContainerProps {
      * - left
      * - right
      * - bottom
+     *
+     * @default 'right'
      */
     configuratorPosition?: 'top' | 'left' | 'right' | 'bottom';
 }
@@ -856,7 +1081,13 @@ export declare interface PivotGridFieldsEditorFieldExpandEvent {
  * 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.
  */
 export declare interface PivotGridFieldsEditorHandle {
+    /**
+     * The properties passed to the PivotGridFieldsEditor component.
+     */
     props: PivotGridFieldsEditorProps;
+    /**
+     * The DOM element of the PivotGridFieldsEditor component.
+     */
     element: HTMLDivElement | null;
 }
 
@@ -908,15 +1139,36 @@ export declare interface PivotGridFieldsEditorProps {
  * 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.
  */
 export declare interface PivotGridHandle {
+    /**
+     * The DOM element of the PivotGrid component.
+     */
     element: HTMLDivElement | null;
+    /**
+     * The current properties of the PivotGrid component.
+     */
     props: PivotGridProps;
+    /**
+     * The rows that make up the column headers.
+     */
     columnHeaderRows: AxisRow[];
+    /**
+     * The rows that make up the row headers.
+     */
     rowHeaderRows: AxisRow[];
+    /**
+     * The data cells organized by row and column.
+     */
     dataCells: {
         row: string[];
         cells: PivotDataItem[];
     }[];
+    /**
+     * The width of the row header area in pixels.
+     */
     rowHeaderBreadth: number;
+    /**
+     * The height of the column header area in pixels.
+     */
     columnHeaderBreadth: number;
 }
 
@@ -929,7 +1181,13 @@ export declare const PivotGridHeaderCell: React_2.ForwardRefExoticComponent<Pivo
  * 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.
  */
 export declare interface PivotGridHeaderCellHandle {
+    /**
+     * The properties passed to the PivotGridHeaderCell component.
+     */
     props: PivotGridHeaderCellProps;
+    /**
+     * The DOM element of the PivotGridHeaderCell component.
+     */
     element: HTMLTableHeaderCellElement | null;
 }
 
@@ -1013,6 +1271,42 @@ export declare interface PivotGridHeaderCellProps extends KendoMouse<PivotGridHe
      * Sets the `role` property of the top-most element of the PivotGridHeaderCell.
      */
     role?: string;
+    /**
+     * Fires when the user clicks the PivotGridHeaderCell.
+     */
+    onClick?: (args: any) => void;
+    /**
+     * Fires when the user double-clicks the PivotGridHeaderCell.
+     */
+    onDoubleClick?: (args: any) => void;
+    /**
+     * Fires when the user presses a mouse button while the cursor is over the PivotGridHeaderCell.
+     */
+    onMouseDown?: (args: any) => void;
+    /**
+     * Fires when the cursor enters the PivotGridHeaderCell area.
+     */
+    onMouseEnter?: (args: any) => void;
+    /**
+     * Fires when the cursor leaves the PivotGridHeaderCell area.
+     */
+    onMouseLeave?: (args: any) => void;
+    /**
+     * Fires when the cursor moves within the PivotGridHeaderCell area.
+     */
+    onMouseMove?: (args: any) => void;
+    /**
+     * Fires when the cursor moves outside the PivotGridHeaderCell area.
+     */
+    onMouseOut?: (args: any) => void;
+    /**
+     * Fires when the cursor moves over the PivotGridHeaderCell area.
+     */
+    onMouseOver?: (args: any) => void;
+    /**
+     * Fires when the user releases a mouse button while the cursor is over the PivotGridHeaderCell.
+     */
+    onMouseUp?: (args: any) => void;
 }
 
 /**
@@ -1059,6 +1353,8 @@ export declare interface PivotGridProps {
      * If set to `true`, the user can use dedicated shortcuts to interact with the PivotGrid.
      * By default, navigation is disabled.
      *
+     * @default false
+     *
      * @example
      * ```jsx
      * <PivotGrid navigatable={true} />
@@ -1271,7 +1567,13 @@ export declare const PivotGridRow: React_2.ForwardRefExoticComponent<PivotGridRo
  * 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.
  */
 export declare interface PivotGridRowHandle {
+    /**
+     * The properties passed to the PivotGridRow component.
+     */
     props: PivotGridRowProps;
+    /**
+     * The DOM element of the PivotGridRow component.
+     */
     element: HTMLTableRowElement | null;
 }
 
@@ -1311,14 +1613,59 @@ export declare interface PivotGridRowProps extends KendoMouse<PivotGridRowHandle
      * Sets the `aria-owns` property of the top-most element of the PivotGridRow.
      */
     ariaOwns?: string;
+    /**
+     * Fires when the user clicks the PivotGridRow.
+     */
+    onClick?: (args: any) => void;
+    /**
+     * Fires when the user double-clicks the PivotGridRow.
+     */
+    onDoubleClick?: (args: any) => void;
+    /**
+     * Fires when the user presses a mouse button while the cursor is over the PivotGridRow.
+     */
+    onMouseDown?: (args: any) => void;
+    /**
+     * Fires when the cursor enters the PivotGridRow area.
+     */
+    onMouseEnter?: (args: any) => void;
+    /**
+     * Fires when the cursor leaves the PivotGridRow area.
+     */
+    onMouseLeave?: (args: any) => void;
+    /**
+     * Fires when the cursor moves within the PivotGridRow area.
+     */
+    onMouseMove?: (args: any) => void;
+    /**
+     * Fires when the cursor moves outside the PivotGridRow area.
+     */
+    onMouseOut?: (args: any) => void;
+    /**
+     * Fires when the cursor moves over the PivotGridRow area.
+     */
+    onMouseOver?: (args: any) => void;
+    /**
+     * Fires when the user releases a mouse button while the cursor is over the PivotGridRow.
+     */
+    onMouseUp?: (args: any) => void;
 }
 
 /**
  * represents the `data` structure of the [TreeView]({% slug api_treeview_treeview %}) component inside the `PivotGrid`.
  */
 export declare interface PivotGridTreeViewData {
+    /**
+     * Indicates whether the item is checked.
+     */
     checked?: boolean;
+    /**
+     * The string value of the item.
+     */
     value?: string;
+    /**
+     * The data item associated with the tree view node.
+     */
     dataItem?: PivotGridField[];
 }
 
@@ -1406,13 +1753,37 @@ export declare const PivotOLAPService: (props: PivotOLAPServiceProps) => any;
  * Represents the arguments of the [usePivotOLAPService]({% slug api_pivotgrid_usepivotolapservice %}) hook.
  */
 export declare interface PivotOLAPServiceArgs {
+    /**
+     * The URL of the OLAP service endpoint.
+     */
     url: string;
+    /**
+     * The name of the cube to connect to.
+     */
     cube: string;
+    /**
+     * The name of the catalog containing the cube.
+     */
     catalog: string;
+    /**
+     * The default configuration of the column axes.
+     */
     defaultColumnAxes?: PivotGridAxis[];
+    /**
+     * The default configuration of the row axes.
+     */
     defaultRowAxes?: PivotGridAxis[];
+    /**
+     * The default configuration of the measure axes.
+     */
     defaultMeasureAxes?: PivotGridAxis[];
+    /**
+     * The default sort descriptors.
+     */
     defaultSort?: SortDescriptor[];
+    /**
+     * The default filter descriptors.
+     */
     defaultFilter?: FilterDescriptor[];
 }
 
@@ -1420,6 +1791,9 @@ export declare interface PivotOLAPServiceArgs {
  * Represents the properties of the [PivotOLAPService]({% slug api_pivotgrid_pivotolapservice %}) component.
  */
 export declare interface PivotOLAPServiceProps extends PivotOLAPServiceArgs {
+    /**
+     * A render prop function that receives the service state and returns JSX elements.
+     */
     children: (args: PivotOLAPServiceState) => any;
 }
 
@@ -1427,8 +1801,17 @@ export declare interface PivotOLAPServiceProps extends PivotOLAPServiceArgs {
  * Represents the `state` of the [usePivotOLAPService]({% slug api_pivotgrid_usepivotolapservice %}) hook and the [PivotOLAPService]({% slug api_pivotgrid_pivotolapservice %}) component.
  */
 export declare interface PivotOLAPServiceState {
+    /**
+     * Properties to pass to the `PivotGrid` component.
+     */
     pivotProps: PivotGridProps;
+    /**
+     * Properties to pass to the `PivotGridConfigurator` component.
+     */
     configuratorProps: PivotGridConfiguratorProps;
+    /**
+     * The loading state and other status information.
+     */
     state: {
         loading: boolean;
     };