@progress/kendo-angular-grid 19.1.2-develop.3 → 19.1.2-develop.5

package/scrolling/scroll-bottom-event.d.ts

@@ -4,11 +4,11 @@
 *-------------------------------------------------------------------------------------------*/
 import { GridComponent } from "../grid.component";
 /**
- * Arguments for the `scrollBottom` event.
+ * Provides the arguments for the `scrollBottom` event.
  */
 export interface ScrollBottomEvent {
     /**
-     * The instance of the GridComponent.
+     * The instance of the `GridComponent` that triggers the event.
      */
     sender: GridComponent;
 }

package/scrolling/scroll-request.service.d.ts

@@ -5,30 +5,30 @@
 import { Subject } from 'rxjs';
 import * as i0 from "@angular/core";
 /**
- * Arguments for the `scrollTo` method. Specifies to which row or column should the Grid scroll to.
+ * Defines the arguments for the `scrollTo` method. Use this to specify the row or column to scroll to.
  * [See example](slug:scrollmmodes_grid#toc-scrolling-to-a-specific-row-and-column).
  */
 export interface ScrollRequest {
     /**
-     * The row index to which the Grid should scroll to, considering `0` as first row.
+     * Specifies the row index to scroll to. The first row has index `0`.
      */
     row?: number;
     /**
-     * The column index to which the Grid should scroll to, considering `0` as first column.
+     * Specifies the column index to scroll to. The first column has index `0`.
      */
     column?: number;
 }
 /**
- * Arguments for the `scrollToItem` method. Specifies to which data item and column should the Grid scroll to.
+ * Defines the arguments for the `scrollToItem` method. Use this to specify the data item and column to scroll to.
  * [See example](slug:scrollmmodes_grid#toc-scrolling-to-a-specific-item).
  */
 export interface ScrollToItemRequest {
     /**
-     * The property of the Grid data items that represents the unique ID of the item.
+     * Specifies the property name in the Grid data items that holds the unique ID.
      */
     idField: string;
     /**
-     * The value of the data item unique identifier.
+     * Specifies the value of the unique identifier for the data item.
      */
     id: any;
 }

package/scrolling/scrollmode.d.ts

@@ -3,11 +3,11 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The scroll mode of the Grid.
+ * Sets the scroll mode of the Grid.
  *
  * The available values are:
- * * `none`—Scrollbars are hidden. The Grid cannot be scrolled.
- * * `scrollable`—Displays scrollbars in Grid.
+ * * `none`—Hides scrollbars. The Grid does not scroll.
+ * * `scrollable`—Shows scrollbars in the Grid.
  * * `virtual`—Enables the [virtual scroll mode](slug:virtualscrolling_grid) of the Grid.
  *
  * @example

package/selection/selectall-checkbox.directive.d.ts

@@ -9,7 +9,7 @@ import { CellSelectionService } from './cell-selection.service';
 import { CheckBoxComponent } from '@progress/kendo-angular-inputs';
 import * as i0 from "@angular/core";
 /**
- * Represents the select-all checkbox feature of the Grid ([see example](slug:grid_selection_persistence#toc-selecting-all-items)).
+ * Adds a select-all checkbox to the Grid. ([See example](slug:grid_selection_persistence#toc-selecting-all-items)).
  *
  * @example
  * ```html
@@ -34,7 +34,7 @@ export declare class SelectAllCheckboxDirective implements AfterContentChecked,
      */
     state: SelectAllCheckboxState;
     /**
-     * Fires when the user clicks the `kendoGridSelectAllCheckbox` select-all checkbox
+     * Emits when the user clicks the select-all checkbox.
      * ([see example](slug:grid_row_selection#toc-select-all-checkbox)).
      */
     selectAllChange: EventEmitter<SelectAllCheckboxState>;

package/selection/selection-checkbox.directive.d.ts

@@ -9,22 +9,23 @@ import { CellSelectionService } from './cell-selection.service';
 import { CheckBoxComponent } from '@progress/kendo-angular-inputs';
 import * as i0 from "@angular/core";
 /**
- * Represents the row-selection checkbox of the Grid. The directive expects the
- * index of the current row as an input parameter. Inside the [`CellTemplateDirective`](slug:api_grid_celltemplatedirective), apply the
- * `kendoGridSelectionCheckbox` to a `<kendo-checkbox></kendo-checkbox>` or an `<input type="checkbox"/>` element. When the user clicks the checkbox that is associated
- * with the directive, a [selectionChange](slug:api_grid_gridcomponent#toc-selectionChange)
- * event is triggered.
+ * Adds a row-selection checkbox to the Grid.
+ * Use this directive on a `<kendo-checkbox>` component or `<input type="checkbox">` element inside a cell template.
+ * When the user clicks the checkbox, the Grid triggers a [`selectionChange`](slug:api_grid_gridcomponent#toc-selectionChange) event.
  *
  * @example
  * ```html
- * <kendo-grid ... >
+ * <kendo-grid>
  *   <kendo-grid-column>
  *     <ng-template kendoGridCellTemplate let-rowIndex="rowIndex">
- *       <input ... [kendoGridSelectionCheckbox]="rowIndex"/>
+ *       <input [kendoGridSelectionCheckbox]="rowIndex"/>
+ *       <kendo-checkbox [kendoGridSelectionCheckbox]="rowIndex"></kendo-checkbox>
  *     </ng-template>
  *   </kendo-grid-column>
  * </kendo-grid>
  * ```
+ * @remarks
+ * Applied to: {@link CheckBoxComponent}.
  */
 export declare class SelectionCheckboxDirective implements AfterContentChecked, OnDestroy {
     private selectionService;
@@ -35,7 +36,7 @@ export declare class SelectionCheckboxDirective implements AfterContentChecked,
     private ngZone;
     private checkbox;
     /**
-     * The current index of the `dataItem` that will be selected.
+     * Sets the index of the `dataItem` to select.
      */
     itemIndex: number;
     private destroyClick;

package/selection/selection-default.d.ts

@@ -17,35 +17,36 @@ export declare class Selection {
     protected ctx: ContextService;
     protected cd: ChangeDetectorRef;
     /**
-     * Defines the collection that will store the selected item keys.
+     * Stores the selected item keys.
      * @default []
      */
     selectedKeys: any[];
     /**
-     * Defines the initial shift-click range selection starting row index.
+     * Sets the starting row index for `Shift`+click range selection.
      *
      * @default 0
      */
     rangeSelectionStartRow: RowArgs;
     /**
-     * Defines the initial shift-click range selection starting column index when cell selection is enabled.
+     * Sets the starting column index for `Shift`+click range selection when cell selection is on.
      *
      * @default 0
      */
     rangeSelectionStartColumnIndex: number;
     /**
-     * Defines the item key that will be stored in the `selectedKeys` collection. [See example](slug:grid_selection_persistence#by-a-custom-key).
+     * Sets the item key to store in `selectedKeys`.
+     * [See example](slug:grid_selection_persistence#by-a-custom-key).
      */
     selectionKey: string | ((context: RowArgs) => any);
     /**
-     * Defines a function that determines the column key of a data cell.
+     * Sets a function to get the column key for a data cell.
      *
-     * The function should return an unique value for each column.
-     * By default, the Grid uses the column index as a column key.
+     * The function must return a unique value for each column.
+     * The Grid uses the column index as the default column key.
      */
     columnKey: string | ((column: any, columnIndex: number) => any);
     /**
-     * Fires when the `selectedKeys` collection has been updated.
+     * Emits when the `selectedKeys` collection changes.
      */
     selectedKeysChange: EventEmitter<any[]>;
     rowSelectionState: Set<any>;

package/selection/selection.directive.d.ts

@@ -7,8 +7,17 @@ import { ContextService } from '../common/provider.service';
 import { Selection } from "./selection-default";
 import * as i0 from "@angular/core";
 /**
- * A directive which stores the row selection state of the Grid in memory
+ * Stores the row selection state of the Grid in memory
  * ([see example]({% slug selection_grid %}#toc-toggling-the-selection-functionality)).
+ *
+ * @example
+ * ```typescript
+ * <kendo-grid kendoGridSelectBy="ProductID"></kendo-grid>
+ *
+ * <kendo-grid [kendoGridSelectBy]="myKey"></kendo-grid>
+ * ```
+ * @remarks
+ * Applied to: {@link GridComponent}.
  */
 export declare class SelectionDirective extends Selection implements OnInit, OnDestroy {
     protected ctx: ContextService;

package/selection/types.d.ts

@@ -6,64 +6,68 @@ import { SelectionAggregate, SelectionAggregates } from '../aggregates/aggregate
 import { ColumnComponent } from './../columns/column.component';
 import { RowArgs } from './../rendering/common/row-args';
 /**
- * Represents the callback that is used by the
- * [cellSelected]({% slug api_grid_gridcomponent %}#toc-cellselected) property ([see example](slug:grid_selection_custom#toc-setting-the-selected-cells)).
+ * Represents the callback used by the [`cellSelected`]({% slug api_grid_gridcomponent %}#toc-cellselected) property. ([See example](slug:grid_selection_custom#toc-setting-the-selected-cells)).
+ *
+ * @param row The row arguments.
+ * @param column The column component.
+ * @param colIndex The column index.
+ * @returns An object with `selected` and `item` properties.
  */
 export type CellSelectedFn = (row: RowArgs, column: ColumnComponent, colIndex: number) => {
     selected: boolean;
     item: CellSelectionItem;
 };
 /**
- * Arguments for the Grid [`selectionChange`](slug:api_grid_gridcomponent#toc-selectionchange) event.
+ * Provides arguments for the Grid [`selectionChange`](slug:api_grid_gridcomponent#toc-selectionchange) event.
  */
 export interface SelectionEvent {
     /**
-     * The cell selection aggregates.
+     * Contains the cell selection aggregates.
      */
     cellAggregates?: SelectionAggregates;
     /**
-     * The row items that were added to the selection.
+     * Lists the row items added to the selection.
      */
     selectedRows?: RowArgs[];
     /**
-     * The row items that were removed from the selection.
+     * Lists the row items removed from the selection.
      */
     deselectedRows?: RowArgs[];
     /**
-     * The cell items that were added to the selection.
+     * Lists the cell items added to the selection.
      */
     selectedCells?: CellSelectionItem[];
     /**
-     * The cell items that were removed from the selection.
+     * Lists the cell items removed from the selection.
      */
     deselectedCells?: CellSelectionItem[];
     /**
-     * Shows the state of the `Ctrl` key (or the `Command` key on a Mac) during the selection.
+     * Shows the state of the `Ctrl` key (or the `Command` key on a Mac) during selection.
      */
     ctrlKey?: boolean;
     /**
-     * Shows the state of the `Shift` key during the selection.
+     * Shows the state of the `Shift` key during selection.
      */
     shiftKey?: boolean;
     /**
-     * Represents the initially clicked row in a shift-click range row selection
+     * Represents the initially clicked row in a `Shift`+click range row selection.
      */
     rangeStartRow?: RowArgs;
     /**
-     * Represents the shift-clicked item in a shift-click range row selection
+     * Represents the item in a `Shift`+click range row selection.
      */
     rangeEndRow?: RowArgs;
     /**
-     * Represents the initially clicked cell in a shift-click range cell selection
+     * Represents the initially clicked cell in a `Shift`+click range cell selection.
      */
     rangeStartCell?: CellSelectionItem;
     /**
-     * Represents the shift-clicked cell in a shift-click range cell selection
+     * Represents the cell in a `Shift`+click range cell selection.
      */
     rangeEndCell?: CellSelectionItem;
 }
 /**
- * The settings for the selection functionality of the Grid ([more information and example]({% slug selection_grid %}#toc-setup)).
+ * Configures the selection functionality of the Grid. ([See example]({% slug selection_grid %}#toc-setup)).
  *
  * @example
  * ```html
@@ -75,53 +79,55 @@ export interface SelectionEvent {
  */
 export interface SelectableSettings {
     /**
-     * Determines if selection aggregates will be enabled. By default the property is set to `false`.
-     * If cellAggregates is set to `true` it will calculate all aggregate options.
-     * You can choose which aggregates to calculate by passing an array of [SelectionAggregate]({% slug api_grid_selectionaggregate %}) type options.
+     * Enables selection aggregates. By default, this property is set to `false`.
+     * If you set `cellAggregates` to `true`, the Grid calculates all aggregate options.
+     * Pass an array of [`SelectionAggregate`]({% slug api_grid_selectionaggregate %}) type options to choose which aggregates to calculate.
+     *
      */
     cellAggregates?: boolean | SelectionAggregate[];
     /**
-     * Determines if selection is allowed.
+     * Enables selection.
      *
      */
     enabled?: boolean;
     /**
-     * Determines if the selection is performed only through clicking a checkbox.
-     * If enabled, clicking the row itself will not select the row.
-     * Applicable if at least one checkbox column is present.
+     * Allows selection only through clicking a checkbox.
+     * When enabled, clicking the row does not select it.
+     * This applies if at least one checkbox column exists.
      *
      */
     checkboxOnly?: boolean;
     /**
-     * Determines the selectable mode.
+     * Sets the selectable mode.
+     *
      */
     mode?: SelectableMode;
     /**
-     * Determines if cell selection is allowed.
+     * Enables cell selection.
      *
      */
     cell?: boolean;
     /**
-     * Determines if drag selection is allowed.
+     * Enables drag selection.
      *
      */
     drag?: boolean;
     /**
-     * Determines whether a meta key (Ctrl or Command) will be needed to perform multiple selection. By default, adding a new row or cell to the selection requires pressing a meta key.
+     * Requires a meta key (`Ctrl` or `Command`) to select multiple items. By default, you must press a meta key to add a new row or cell to the selection.
      *
      */
     metaKeyMultiSelect?: boolean;
     /**
-     * Determines whether the existing selection is preserved when a new range selection is performed.
+     * Preserves the existing selection when you perform a new range selection.
      *
      */
     multipleRanges?: boolean;
 }
 /**
- * Represents the available selection modes. [See example](slug:grid_row_selection).
+ * Lists the available selection modes. [See example](slug:grid_row_selection).
  *
  * The available values are:
- * * `single`—Enables single selection. If you click the selected row, it will not be deselected. [See example](slug:grid_row_selection#toc-single-row-selection).
+ * * `single`—Enables single selection. Clicking the selected row does not deselect it. [See example](slug:grid_row_selection#toc-single-row-selection).
  * * `multiple`—Enables multiple selection. [See example](slug:grid_row_selection#toc-multiple-rows-selection).
  *
  * @example
@@ -131,7 +137,7 @@ export interface SelectableSettings {
  */
 export type SelectableMode = "single" | "multiple";
 /**
- * Represents the possible states of the select-all checkbox.
+ * Lists the possible states of the select-all checkbox.
  *
  * @example
  * ```html
@@ -140,7 +146,7 @@ export type SelectableMode = "single" | "multiple";
  *     <input
  *       kendoGridSelectAllCheckbox
  *       state="indeterminate"
-*        ...
+ *       ...
  *     />
  *    </ng-template>
  *  <kendo-grid-column>
@@ -148,20 +154,20 @@ export type SelectableMode = "single" | "multiple";
  */
 export type SelectAllCheckboxState = "checked" | "unchecked" | "indeterminate";
 /**
- * The Grid `cell` selection items type.
+ * Describes the Grid cell selection item type.
  */
 export interface CellSelectionItem {
     /**
-     * The key that identifies the selected item.
+     * Identifies the selected item.
      */
     itemKey?: any;
     /**
-     * The key that identifies the selected item column.
+     * Identifies the selected item column.
      */
     columnKey?: any;
 }
 /**
- * The possible data types of the Grid selection items.
+ * Lists the possible data types of the Grid selection items.
  *
  * @hidden
  */

package/state-management/grid-state.models.d.ts

@@ -6,7 +6,7 @@ import { State } from "@progress/kendo-data-query";
 import { GridDataResult } from "../data/data.collection";
 import { PreventableEvent } from "@progress/kendo-angular-common";
 /**
- * Represent the state of each Grid column that can be changed by the user.
+ * Describes the state of a Grid column that users can change.
  */
 export interface ColumnState {
     /**
@@ -18,7 +18,7 @@ export interface ColumnState {
      */
     width?: number;
     /**
-     * The column visibility.
+     * The column visibility state.
      */
     hidden?: boolean;
     /**
@@ -29,26 +29,35 @@ export interface ColumnState {
      * The column sticky state.
      */
     sticky?: boolean;
+    /**
+     * The order index of the column.
+     */
     orderIndex?: number;
 }
 /**
- * The state of the grid component.
- * It includes the current `State`, data, and columns state.
+ * Describes the state of the Grid component.
+ * Includes the current `State`, data, and columns state.
  */
 export interface GridState extends State {
+    /**
+     * The state of all columns in the Grid.
+     */
     columnsState?: ColumnState[];
+    /**
+     * The current data in the Grid.
+     */
     currentData?: Array<any> | GridDataResult | null;
 }
 /**
- * Arguments for the `undo` and `redo` events.
+ * Provides arguments for the `undo` and `redo` events.
  */
 export declare class UndoRedoEvent extends PreventableEvent {
     /**
-     * The event data of the original action that triggered the state change.
+     * The event data for the action that changed the state.
      */
     readonly originalEvent: any;
     /**
-     * The grid state and rendered data at the time of the action.
+     * The Grid state and rendered data at the time of the action.
      */
     readonly gridState: GridState;
     /**

package/state-management/redo-command-tool.d.ts

@@ -6,15 +6,14 @@ import { ToolBarButtonComponent } from '@progress/kendo-angular-toolbar';
 import { UndoRedoService } from './undo-redo.service';
 import * as i0 from "@angular/core";
 /**
- * Represents the command for triggering the redo action in the Grid.
- * You can apply this directive to any `kendo-toolbar-button` element inside a
- * ToolbarComponent used in the Grid.
+ * Represents the command that triggers the redo action in the Grid.
+ * Apply this directive to any `kendo-toolbar-button` inside a ToolbarComponent in the Grid.
  *
- * When the user clicks the toolbar button that is associated with the directive, the
- * [redo]({% slug api_grid_undoredodirective %}#toc-redo) event is triggered.
+ * When users click the toolbar button with this directive, the
+ * [`redo`]({% slug api_grid_undoredodirective %}#toc-redo) event is triggered.
  *
  * @example
- * ```html-no-run
+ * ```html
  * <kendo-grid>
  *      <kendo-toolbar>
  *         <kendo-toolbar-button kendoGridRedoTool></kendo-toolbar-button>
@@ -26,8 +25,17 @@ export declare class RedoCommandToolbarDirective {
     private undoRedoService;
     private host;
     private subs;
+    /**
+     * @hidden
+     */
     constructor(undoRedoService: UndoRedoService, host: ToolBarButtonComponent);
+    /**
+     * @hidden
+     */
     ngOnInit(): void;
+    /**
+     * @hidden
+     */
     ngOnDestroy(): void;
     /**
      * @hidden

package/state-management/undo-command-tool.d.ts

@@ -6,15 +6,14 @@ import { ToolBarButtonComponent } from '@progress/kendo-angular-toolbar';
 import { UndoRedoService } from './undo-redo.service';
 import * as i0 from "@angular/core";
 /**
- * Represents the command for triggering the undo action in the Grid.
- * You can apply this directive to any `kendo-toolbar-button` element inside a
- * ToolbarComponent used in the Grid.
+ * Represents the command that triggers the undo action in the Grid.
+ * Apply this directive to any `kendo-toolbar-button` inside a ToolbarComponent in the Grid.
  *
- * When the user clicks the toolbar button that is associated with the directive, the
- * [undo]({% slug api_grid_undoredodirective %}#toc-undo) event is triggered.
+ * When users click the toolbar button with this directive, the
+ * [`undo`]({% slug api_grid_undoredodirective %}#toc-undo) event is triggered.
  *
  * @example
- * ```html-no-run
+ * ```html
  * <kendo-grid>
  *      <kendo-toolbar>
  *         <kendo-toolbar-button kendoGridUndoTool></kendo-toolbar-button>
@@ -26,8 +25,17 @@ export declare class UndoCommandToolbarDirective {
     private undoRedoService;
     private host;
     private subs;
+    /**
+     * @hidden
+     */
     constructor(undoRedoService: UndoRedoService, host: ToolBarButtonComponent);
+    /**
+     * @hidden
+     */
     ngOnInit(): void;
+    /**
+     * @hidden
+     */
     ngOnDestroy(): void;
     /**
      * @hidden

package/state-management/undo-redo.directive.d.ts

@@ -9,26 +9,37 @@ import { EditService } from '../editing/edit.service';
 import { UndoRedoService } from './undo-redo.service';
 import { ChangeNotificationService } from '../data/change-notification.service';
 import * as i0 from "@angular/core";
+/**
+ * Represents the directive that manages undo-redo operations in the Grid.
+ * Use this directive to enable undo and redo functionality for user actions in the Grid.
+ *
+ * @example
+ * ```html
+ * <kendo-grid [data]="data" kendoGridUndoRedo></kendo-grid>
+ * ```
+ * @remarks
+ * Applied to: {@link GridComponent}.
+ */
 export declare class UndoRedoDirective implements OnInit, OnDestroy {
     private host;
     private editService;
     private undoRedoService;
     private changeNotification;
     /**
-     * Determines the maximum number of actions to keep in the undo-redo stack.
+     * Sets the maximum number of actions to keep in the undo-redo stack.
      * @default 10
      */
     maxStoredStates: number;
     /**
-     * Fires when undo action is performed. Exposes the state of the grid that will be applied.
+     * Fires when you perform the undo action. Provides the Grid state to apply.
      */
     onUndo: EventEmitter<UndoRedoEvent>;
     /**
-     * Fires when undo action is performed. Exposes the state of the grid that will be applied.
+     * Fires when you perform the redo action. Provides the Grid state to apply.
      */
     onRedo: EventEmitter<UndoRedoEvent>;
     /**
-     * Returns an array of all undo-redo actions that are currently in the stack.
+     * Returns all undo-redo actions currently in the stack.
      */
     get undoRedoItems(): UndoRedoEvent[];
     private stack;
@@ -38,11 +49,11 @@ export declare class UndoRedoDirective implements OnInit, OnDestroy {
     ngOnInit(): void;
     ngOnDestroy(): void;
     /**
-     * Re-applies the last action, reverted by the `undo` method.
+     * Re-applies the last action that you reverted with the `undo` method.
      */
     redo(): void;
     /**
-     * Reverts the last user action.
+     * Reverts the last user action that you performed.
      */
     undo(): void;
     private updateUndoRedoDisabled;