GridComponent

Enables or disables adaptive mode. Adaptive rendering is off by default.

If true, resizes columns during initialization to fit headers and content. Columns with autoSize set to false are excluded. See example.

Sets a function to determine if a data cell is selected. The function returns an object with selected and item properties (see example).

If true, displays the column menu for columns (see example).

Sets the data of the Grid. If you provide an array, the Grid gets the total count automatically. (more information and example).

Sets the Grid data layout display mode.

Sets the style.height attribute of each Grid detail row (tr.k-detail-row) element in the DOM in pixels. If the detail row has content that requires more space, the row automatically expands to fit the content.

Sets the filter descriptor for the data (see examples).

Enables the filtering feature of the Grid for columns with a field option.

Determines if the Grid can be resized.

Sets the descriptors for grouping the data (see example).

If true, allows grouping by dragging column headers (see example).

Defines the height in pixels for the Grid when scrollable is set. You can also set the height using style.height with units like px, %, em, or rem.

If true, hides the Grid header. The header is visible by default. The header includes column headers and the filter row.

Sets a function to determine if a specific row is expanded.

Sets a function to determine if a specific group row is expanded.

Sets a function to determine if a data row is pinnable.

Sets a function to determine if a data row is selectable.

If true, displays the Grid loading indicator (see example).

By default, navigation is enabled. To disable, set to false. To enable navigation for specific sections, provide a GridNavigableSection.

Configures the Grid pager (see example).

Defines the page size used by the Grid pager. Required for the paging feature.

Enables the end user to pin rows through the UI. You can set it to true to allow pinning to both top and bottom, or specify the desired pinning location by providing a GridRowPinLocation. By default, the row pinning feature is disabled.

The array of data items pinned to the bottom of the Grid. Pinned rows remain visible while the body scrolls and are immune to filtering and pagination.

Requires setting pinnable to true or a valid GridRowPinLocation.

The array of data items pinned to the top of the Grid. Pinned rows remain visible while the body scrolls and are immune to filtering and pagination.

Requires setting pinnable to true or a valid GridRowPinLocation.

If true, allows reordering columns by dragging header cells (see example).

If true, allows resizing columns by dragging header cell edges (see example).

Sets a function to apply custom CSS classes to each data row (see example).

Sets the style.height attribute of each Grid data or group header/footer row (tr) element in the DOM in pixels. If some row cells have content that requires more space, the row automatically expands to fit the content.

Enables row reordering feature of the Grid (see example).

Sets a function to determine if a data row is selected (see example).

Sets a function to determine if a data row is sticky (always visible after scrolling).

Defines the scroll mode for the Grid.

Enables the selection feature of the Grid. The selectable property can be set to true, false, or an object with additional settings. See example.

Specifies if the currently inactive toolbar tools will be visible. Applicable when the toolbar is configured using the <kendo-toolbar> component. By default, such tools are hidden.

Specifies the sizing for Grid elements like tables, buttons, and inputs.

Defines the number of records to skip in the pager. Required for the paging feature.

Sets the descriptors for sorting the data (see example).

Enables sorting feature of the Grid for columns with a field option.

A function that defines how to track changes for the data rows. By default, the Grid tracks changes by the index of the data item. Edited rows are tracked by reference. See example.

If true, renders only columns in the current viewport.

Returns the currently focused cell (if any).

Returns the currently focused row (if any).

A query list of all declared columns.

Gets the current GridState, including data operations and column state. Use this to store and restore the Grid state.

Fires when a new row is added by clicking the Add command button (see example).

Fires when editing is canceled by clicking the Cancel command button (see example).

Fires when a cell is clicked (see example).

Fires when a cell edit is closed (see example).

Fires when columns are locked or unlocked.

Fires when columns are reordered.

Fires when columns are resized.

Fires when columns are made sticky or unsticky.

Fires when column visibility changes.

Fires when the grid content is scrolled. The event is triggered outside the Angular zone for performance. Enter the Angular zone if you make changes that require change detection.

Fires when the CSV export command is triggered.

Fires when the data state of the Grid is changed.

Fires when a detail row is collapsed through the UI.

Fires when a detail row is expanded through the UI.

Fires when a row enters edit mode (see example).

Fires when the Excel export command is triggered.

Fires when the Grid data is filtered through the UI and the filter descriptor changes.

Fires when the data or columns state of the Grid is changed.

Fires when the Grid data is grouped through the UI and the group descriptors change (see example).

Fires when a group is collapsed through the UI.

Fires when a group is expanded through the UI.

Fires when the page is changed through the UI (see example).

Fires when the PDF export command is triggered.

Fires when a row is removed by clicking the Remove command button (see example).

Fires when a row’s pinned state is updated through the UI.

Fires when a row is reordered through the UI.

Fires when a row is saved by clicking the Save command button (see example).

Fires when the last record is scrolled into view (see example).

Fires when the Grid selection changes through the UI.

Fires when the Grid data is sorted through the UI and the sort descriptors change (see example).

Creates a new row editor (see example).

Applies the minimum possible width for the specified column so the whole text fits without wrapping. This method expects the Grid to be resizable. Run this method after the Grid is populated with data. See example

Adjusts the width of the specified columns to fit the entire content, including headers, without wrapping. If you do not specify columns, autoFitColumns applies to all columns. Run this method after the Grid is populated with data. See example

Adjusts the width of the Grid columns to fit the entire Grid width.

• when the sum of all columns widths is less than the available Grid width—the available space is distributed evenly between all columns.
• when the sum of all columns widths is greater than the available Grid width—the columns are shrinked equally to fit the Grid width.

Run this method after the Grid is populated with data.

Closes the current cell in edit mode.

Clears the search operation applied through the SmartBox tool.

Closes the current cell in edit mode and fires the cellClose event.

Closes the editor for the specified row (see example).

Collapses a group header at the given hierarchical index, such as 0_1 for the second inner group of the first master group.

This method is for backwards compatibility with legacy versions that track expanded group state by hierarchical group index. If the Grid is pageable, the group indexes are offset by the current Grid skip.

Collapses the master row at the specified data row index (see example).

This method is for backwards compatibility with legacy versions that track expanded state by row index. For new development, use the kendoGridDetailsExpandBy directive or provide an isDetailExpanded callback. See Controlling the Expanded State for examples.

Exports the Grid element to a Drawing Group using the kendo-grid-pdf component options (see example).

Puts the specified cell in edit mode (see example).

Switches the specified table row to edit mode (see example).

Expands a group header at the given hierarchical index, such as 0_1 for the second inner group of the first master group.

This method is for backwards compatibility with legacy versions that track expanded group state by hierarchical group index. If the Grid is pageable, the group indexes are offset by the current Grid skip.

Expands the master row at the specified data row index (see example).

This method is for backwards compatibility with legacy versions that track expanded state by row index. For new development, use the kendoGridDetailsExpandBy directive or provide an isDetailExpanded callback. See Controlling the Expanded State for examples.

Focuses the last active or the first cell of the Grid.

Focuses the cell with the specified row and column index.

The row index is based on the logical structure of the Grid and does not correspond to the data item index. Header rows are included, starting at index 0. Group headers and footers are included. The row indexing is absolute and does not change with paging.

If the Grid is configured for scrolling, including virtual scrolling, the scroll position will be updated. If the row is not present on the current page, the method will have no effect.

Focuses the next cell, optionally wrapping to the next row.

Focuses the previous cell. Optionally wraps to the previous row.

Builds the request body for the AI service based on the provided prompt message. Allows developers to construct the AI service requests manually (see example).

Processes an AI service response and applies the commands to the Grid. Allows developers to handle the AI service responses manually (see example).

Returns true if a row or cell is currently edited.

Returns true if a cell is currently edited.

Applies the given GridState object to the Grid.

Changes the position of the specified column. The reordering of columns operates only on the level inferred by the source column. For this method to work, the source column must be visible.

Initiates the CSV export (see example).

Initiates the Excel export (see example).

Initiates the PDF export (see example).

Scrolls to the specified row and column (see example).

Scrolls to the specified data item and column (see example).

Generates and returns the CSV-formatted string without triggering file download (see example).