@syncfusion/ej2-treegrid 28.2.6 → 29.1.33

package/src/treegrid/models/column.js

@@ -19,90 +19,78 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 import { merge, Property } from '@syncfusion/ej2-base';
 /**
- * Represents TreeGrid `Column` model class.
+ * Represents the "Column" model class for TreeGrid, defining essential properties and functionalities of a column.
  */
 var Column = /** @class */ (function () {
     function Column(options) {
         /**
-         * If `allowEditing` set to false, then it disables editing of a particular column.
-         * By default all columns are editable.
+         * Allows or disallows editing of the column. Set to `false` to make a column non-editable.
+         * By default, all columns are editable.
          *
          * @default true
          */
         this.allowEditing = true;
         /**
-         * Defines the `IEditCell` object to customize default edit cell.
+         * Customization options for the edit cell.
          *
          * @default {}
          */
         this.edit = {};
         /**
-         * If `disableHtmlEncode` is set to true, it encodes the HTML of the header and content cells.
+         * When set to `true`, encodes HTML content in headers and cells to prevent HTML injection.
          *
          * @default true
          */
         this.disableHtmlEncode = true;
         /**
-         * If `allowReordering` set to false, then it disables reorder of a particular column.
-         * By default all columns can be reorder.
+         * Disables column reordering if set to `false`. By default, columns can be reordered.
          *
          * @default true
          */
         this.allowReordering = true;
         /**
-         * If `showColumnMenu` set to false, then it disable the column menu of a particular column.
-         * By default column menu will show for all columns
+         * Disables column menu for the column if set to `false`. By default, column menus are enabled for all columns.
          *
          * @default true
          */
         this.showColumnMenu = true;
         /**
-         * If `allowFiltering` set to false, then it disables filtering option and filter bar element of a particular column.
-         * By default all columns are filterable.
+         * Disables filtering for the column if set to `false`. By default, columns are filterable.
          *
          * @default true
          */
         this.allowFiltering = true;
         /**
-         * If `allowSorting` set to false, then it disables sorting option of a particular column.
-         * By default all columns are sortable.
+         * Disables sorting for the column if set to `false`. By default, columns are sortable.
          *
          * @default true
          */
         this.allowSorting = true;
         /**
-         * If `allowResizing` is set to false, it disables resize option of a particular column.
-         * By default all the columns can be resized.
+         * Disables resizing for the column if set to `false`. By default, columns can be resized.
          *
          * @default true
          */
         this.allowResizing = true;
         /**
-         *  It is used to customize the default filter options for a specific columns.
-         * * type -  Specifies the filter type as menu.
-         * * ui - to render custom component for specific column it has following functions.
-         * * ui.create – It is used for creating custom components.
-         * * ui.read -  It is used for read the value from the component.
-         * * ui.write - It is used to apply component model as dynamically.
+         * Customize default filter options for a specific column, providing types and UI definitions for custom components.
          *
-         *  @default null
+         * @default null
          */
         this.filter = {};
         merge(this, options);
     }
     /**
-     * Update the State changes reflected for TreeGrid columndirective in react platform.
+     * Reflects state changes for TreeGrid column directives, particularly in React.
      *
-     * @param {Column} column - specifies the column
+     * @param {Column} column - The column to update.
      * @returns {void}
      * @hidden
      */
     Column.prototype.setProperties = function (column) {
-        //Angular two way binding
         var keys = Object.keys(column);
         for (var i = 0; i < keys.length; i++) {
             this[keys[parseInt(i.toString(), 10)]] = column[keys[parseInt(i.toString(), 10)]];
-            //Refresh the react columnTemplates on state change
             if (this.parent && this.parent['isReact'] && keys[parseInt(i.toString(), 10)] === 'template') {
                 var refreshReactColumnTemplateByUid = 'refreshReactColumnTemplateByUid';
                 this.parent.clipboardModule['treeGridParent'].renderModule["" + refreshReactColumnTemplateByUid](this.uid);

package/src/treegrid/models/edit-settings-model.d.ts

@@ -6,34 +6,35 @@ import { ChildProperty, Property } from '@syncfusion/ej2-base';import { EditMode
 export interface EditSettingsModel {
 
     /**
-     * If `allowAdding` is set to true, new records can be added to the TreeGrid.
+     * Enables the ability to add new records to the TreeGrid when set to `true`.
+     * This allows users to insert new rows into the data set.
      *
      * @default false
      */
     allowAdding?: boolean;
 
     /**
-     * If `allowEditing` is set to true, values can be updated in the existing record.
+     * Permits updating values in existing records if set to `true`.
+     * This setting allows inline modification of data cells within the TreeGrid.
      *
      * @default false
      */
     allowEditing?: boolean;
 
     /**
-     * If `allowDeleting` is set to true, existing record can be deleted from the TreeGrid.
+     * Allows removal of records from the TreeGrid when set to `true`.
+     * Users can delete rows from the data set, reflecting changes immediately.
      *
      * @default false
      */
     allowDeleting?: boolean;
 
     /**
-     * Defines the mode to edit. The available editing modes are:
-     * ```props
-     * * Cell :- Defines the editing mode as Cell.
-     * * Row :- Defines the editing mode as Row.
-     * * Dialog :- Defines the editing mode as Dialog.
-     * * Batch :- Defines the editing mode as Batch.
-     * ```
+     * Specifies the editing mode for the TreeGrid. Available modes include:
+     * * `Cell`: Enables individual cell editing.
+     * * `Row`: Allows entire row editing at once.
+     * * `Dialog`: Opens a dialog for row editing.
+     * * `Batch`: Supports batch editing of cells across multiple rows. Changes are not immediately saved but can be committed all at once, enhancing efficiency in bulk data edits.
      *
      * @default Cell
      * @isEnumeration true
@@ -41,43 +42,41 @@ export interface EditSettingsModel {
     mode?: EditMode;
 
     /**
-     * Defines the row position for new records. The available row positions are:
-     * ```props
-     * * Top :- Defines the row position as Top.
-     * * Bottom :- Defines the row position as Bottom.
-     * * Above :- Defines the row position as Above.
-     * * Below :- Defines the row position as Below.
-     * * Child :- Defines the row position as Child.
-     * ```
-     * {% codeBlock src='treegrid/newRowPosition/index.md' %}{% endcodeBlock %}
+     * Determines the position where new rows are added within the TreeGrid. Options are:
+     * * `Top`: Adds new rows at the top of the grid.
+     * * `Bottom`: Adds new rows at the bottom of the grid.
+     * * `Above`: Inserts a new row above the selected row.
+     * * `Below`: Adds a new row below the selected row.
+     * * `Child`: Inserts a new row as a child of the currently selected row.
      *
      * @default Top
      */
     newRowPosition?: RowPosition;
 
     /**
-     * If `allowEditOnDblClick` is set to false, TreeGrid will not allow editing of a record on double click.
+     * If set to `false`, prevents editing on a row double-click, allowing edits through other triggers only.
      *
      * @default true
      */
     allowEditOnDblClick?: boolean;
 
     /**
-     * if `showConfirmDialog` is set to false, confirm dialog does not show when batch changes are saved or discarded.
+     * Controls the display of a confirmation dialog when batch changes are either applied or discarded.
+     * Set to `false` to suppress the display of this confirmation prompt.
      *
      * @default true
      */
     showConfirmDialog?: boolean;
 
     /**
-     * If `showDeleteConfirmDialog` is set to true, confirm dialog will show delete action. You can also cancel delete command.
+     * If set to `true`, a confirmation dialog appears before record deletion, allowing users to confirm or cancel the operation.
      *
      * @default false
      */
     showDeleteConfirmDialog?: boolean;
 
     /**
-     * Defines the custom edit elements for the dialog template.
+     * Provides a template for custom editing elements within the dialog, supporting both HTML strings and functions.
      *
      * @default ''
      * @aspType string
@@ -85,14 +84,14 @@ export interface EditSettingsModel {
     template?: string | Function;
 
     /**
-     * Defines the dialog params to edit.
+     * Specifies the parameters for customizing the edit dialog, allowing the configuration of elements and behavior.
      *
      * @default {}
      */
     dialog?: IDialogUI;
 
     /**
-     * If `allowNextRowEdit` is set as true, editing is continued to next row with keyboard navigation.
+     * Enables continued editing in subsequent rows when navigating with keyboard shortcuts if set to `true`.
      *
      * @default false
      */

package/src/treegrid/models/edit-settings.d.ts

@@ -2,87 +2,86 @@ import { ChildProperty } from '@syncfusion/ej2-base';
 import { EditMode, RowPosition } from '../enum';
 import { IDialogUI } from '@syncfusion/ej2-grids';
 /**
- * Configures the edit behavior of the TreeGrid.
+ * Configures the edit behavior of the TreeGrid, defining how records can be added, modified, or deleted.
  */
 export declare class EditSettings extends ChildProperty<EditSettings> {
     /**
-     * If `allowAdding` is set to true, new records can be added to the TreeGrid.
+     * Enables the ability to add new records to the TreeGrid when set to `true`.
+     * This allows users to insert new rows into the data set.
      *
      * @default false
      */
     allowAdding: boolean;
     /**
-     * If `allowEditing` is set to true, values can be updated in the existing record.
+     * Permits updating values in existing records if set to `true`.
+     * This setting allows inline modification of data cells within the TreeGrid.
      *
      * @default false
      */
     allowEditing: boolean;
     /**
-     * If `allowDeleting` is set to true, existing record can be deleted from the TreeGrid.
+     * Allows removal of records from the TreeGrid when set to `true`.
+     * Users can delete rows from the data set, reflecting changes immediately.
      *
      * @default false
      */
     allowDeleting: boolean;
     /**
-     * Defines the mode to edit. The available editing modes are:
-     * ```props
-     * * Cell :- Defines the editing mode as Cell.
-     * * Row :- Defines the editing mode as Row.
-     * * Dialog :- Defines the editing mode as Dialog.
-     * * Batch :- Defines the editing mode as Batch.
-     * ```
+     * Specifies the editing mode for the TreeGrid. Available modes include:
+     * * `Cell`: Enables individual cell editing.
+     * * `Row`: Allows entire row editing at once.
+     * * `Dialog`: Opens a dialog for row editing.
+     * * `Batch`: Supports batch editing of cells across multiple rows. Changes are not immediately saved but can be committed all at once, enhancing efficiency in bulk data edits.
      *
      * @default Cell
      * @isEnumeration true
      */
     mode: EditMode;
     /**
-     * Defines the row position for new records. The available row positions are:
-     * ```props
-     * * Top :- Defines the row position as Top.
-     * * Bottom :- Defines the row position as Bottom.
-     * * Above :- Defines the row position as Above.
-     * * Below :- Defines the row position as Below.
-     * * Child :- Defines the row position as Child.
-     * ```
-     * {% codeBlock src='treegrid/newRowPosition/index.md' %}{% endcodeBlock %}
+     * Determines the position where new rows are added within the TreeGrid. Options are:
+     * * `Top`: Adds new rows at the top of the grid.
+     * * `Bottom`: Adds new rows at the bottom of the grid.
+     * * `Above`: Inserts a new row above the selected row.
+     * * `Below`: Adds a new row below the selected row.
+     * * `Child`: Inserts a new row as a child of the currently selected row.
      *
      * @default Top
      */
     newRowPosition: RowPosition;
     /**
-     * If `allowEditOnDblClick` is set to false, TreeGrid will not allow editing of a record on double click.
+     * If set to `false`, prevents editing on a row double-click, allowing edits through other triggers only.
      *
      * @default true
      */
     allowEditOnDblClick: boolean;
     /**
-     * if `showConfirmDialog` is set to false, confirm dialog does not show when batch changes are saved or discarded.
+     * Controls the display of a confirmation dialog when batch changes are either applied or discarded.
+     * Set to `false` to suppress the display of this confirmation prompt.
      *
      * @default true
      */
     showConfirmDialog: boolean;
     /**
-     * If `showDeleteConfirmDialog` is set to true, confirm dialog will show delete action. You can also cancel delete command.
+     * If set to `true`, a confirmation dialog appears before record deletion, allowing users to confirm or cancel the operation.
      *
      * @default false
      */
     showDeleteConfirmDialog: boolean;
     /**
-     * Defines the custom edit elements for the dialog template.
+     * Provides a template for custom editing elements within the dialog, supporting both HTML strings and functions.
      *
      * @default ''
      * @aspType string
      */
     template: string | Function;
     /**
-     * Defines the dialog params to edit.
+     * Specifies the parameters for customizing the edit dialog, allowing the configuration of elements and behavior.
      *
      * @default {}
      */
     dialog: IDialogUI;
     /**
-     * If `allowNextRowEdit` is set as true, editing is continued to next row with keyboard navigation.
+     * Enables continued editing in subsequent rows when navigating with keyboard shortcuts if set to `true`.
      *
      * @default false
      */

package/src/treegrid/models/edit-settings.js

@@ -19,7 +19,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 import { ChildProperty, Property } from '@syncfusion/ej2-base';
 /**
- * Configures the edit behavior of the TreeGrid.
+ * Configures the edit behavior of the TreeGrid, defining how records can be added, modified, or deleted.
  */
 var EditSettings = /** @class */ (function (_super) {
     __extends(EditSettings, _super);

package/src/treegrid/models/filter-settings-model.d.ts

@@ -6,64 +6,65 @@ import { Collection, Property, ChildProperty } from '@syncfusion/ej2-base';impor
 export interface PredicateModel {
 
     /**
-     * Defines the field name of the filter column in Tree Grid.
+     * Specifies the field name of the column to apply the filter on.
      *
      * @default ''
      */
     field?: string;
 
     /**
-     * Defines the operator to filter Tree Grid records. The available operators and its supported data types are:
+     * Specifies the operator used for filtering TreeGrid records. The available operators support a variety of data types
+     * and offer different filtering mechanisms. Details for each operator are provided below:
      * <table>
      * <tr>
      * <td colspan=1 rowspan=1>
      * Operator<br/></td><td colspan=1 rowspan=1>
      * Description<br/></td><td colspan=1 rowspan=1>
-     * Supported Types<br/></td></tr>
+     * Supported Data Types<br/></td></tr>
      * <tr>
      * <td colspan=1 rowspan=1>
      * startswith<br/></td><td colspan=1 rowspan=1>
-     * Checks whether the value begins with the specified value.<br/></td><td colspan=1 rowspan=1>
+     * Checks if the value starts with the specified input.<br/></td><td colspan=1 rowspan=1>
      * String<br/></td></tr>
      * <tr>
      * <td colspan=1 rowspan=1>
      * endswith<br/></td><td colspan=1 rowspan=1>
-     * Checks whether the value ends with the specified value.<br/><br/></td><td colspan=1 rowspan=1>
+     * Checks if the value ends with the specified input.<br/><br/></td><td colspan=1 rowspan=1>
      * <br/>String<br/></td></tr>
      * <tr>
      * <td colspan=1 rowspan=1>
      * contains<br/></td><td colspan=1 rowspan=1>
-     * Checks whether the value contains the specified value.<br/><br/></td><td colspan=1 rowspan=1>
+     * Checks if the value contains the specified input anywhere within it.<br/><br/></td><td colspan=1 rowspan=1>
      * <br/>String<br/></td></tr>
      * <tr>
      * <td colspan=1 rowspan=1>
      * equal<br/></td><td colspan=1 rowspan=1>
-     * Checks whether the value is equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
+     * Checks if the value is exactly equal to the specified input.<br/><br/></td><td colspan=1 rowspan=1>
      * <br/>String | Number | Boolean | Date<br/></td></tr>
      * <tr>
      * <td colspan=1 rowspan=1>
      * notequal<br/></td><td colspan=1 rowspan=1>
-     * Checks for values that are not equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
+     * Identifies values that are not equal to the specified input.<br/><br/></td><td colspan=1 rowspan=1>
      * <br/>String | Number | Boolean | Date<br/></td></tr>
      * <tr>
      * <td colspan=1 rowspan=1>
      * greaterthan<br/></td><td colspan=1 rowspan=1>
-     * Checks whether the value is greater than the specified value.<br/><br/></td><td colspan=1 rowspan=1>
+     * Verifies if the value is greater than the specified input.<br/><br/></td><td colspan=1 rowspan=1>
      * Number | Date<br/></td></tr>
      * <tr>
      * <td colspan=1 rowspan=1>
      * greaterthanorequal<br/></td><td colspan=1 rowspan=1>
-     * Checks whether the value is greater than or equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
+     * Verifies if the value is greater than or equal to the specified input.<br/><br/></td><td colspan=1 rowspan=1>
      * <br/>Number | Date<br/></td></tr>
      * <tr>
      * <td colspan=1 rowspan=1>
      * lessthan<br/></td><td colspan=1 rowspan=1>
-     * Checks whether the value is less than the specified value.<br/><br/></td><td colspan=1 rowspan=1>
+     * Checks if the value is less than the specified input.<br/><br/></td><td colspan=1 rowspan=1>
      * <br/>Number | Date<br/></td></tr>
      * <tr>
      * <td colspan=1 rowspan=1>
      * lessthanorequal<br/></td><td colspan=1 rowspan=1>
-     * Checks whether the value is less than or equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
+     * Checks if the value is less than or equal to the specified input.<br/><br/></td><td colspan=1 rowspan=1>
      * <br/>Number | Date<br/></td></tr>
      * </table>
      *
@@ -72,29 +73,28 @@ export interface PredicateModel {
     operator?: string;
 
     /**
-     * Defines the value used to filter records in Tree Grid.
+     * Specifies the value to filter the column's data by.
      *
      * @default ''
      */
     value?: string | number | Date | boolean;
 
     /**
-     * If match case set to true, then filter records with exact match or else
-     * filter records with case insensitive(uppercase and lowercase letters treated as same) in Tree Grid.
+     * Applies case-sensitive filtering if set to `true`. When false, filtering is case-insensitive.
      *
      * @default null
      */
     matchCase?: boolean;
 
     /**
-     * If ignoreAccent is set to true, then filter ignores the diacritic characters or accents while filtering in Tree Grid.
+     * Ignores diacritic characters during filtering if set to `true`.
      *
      * @default false
      */
     ignoreAccent?: boolean;
 
     /**
-     * Defines relationship between one filter query and another by using AND or OR predicate.
+     * Defines the logical relationship between multiple filter conditions ('AND' / 'OR').
      *
      * @default null
      */
@@ -102,37 +102,37 @@ export interface PredicateModel {
 
     /**
      * @hidden
-     * Defines the actual filter value for the filter column in Tree Grid.
+     * Holds the actual value used for filtering the column.
      */
     actualFilterValue?: Object;
 
     /**
      * @hidden
-     * Defines the actual filter operator for the filter column in Tree Grid.
+     * Represents the actual filter operator applied to the column.
      */
     actualOperator?: Object;
 
     /**
      * @hidden
-     * Defines the type of the filter column in Tree Grid.
+     * Defines the data type of the filter column.
      */
     type?: string;
 
     /**
      * @hidden
-     * Defines the predicate of filter column in Tree Grid.
+     * Represents the internal predicate condition for the filter column.
      */
     ejpredicate?: Object;
 
     /**
      * @hidden
-     * Defines the UID of filter column.
+     * Unique identifier for the filter column.
      */
     uid?: string;
 
     /**
      * @hidden
-     * Defines the foreignKey availability in filtered columns.
+     * Indicates whether the column is a foreign key in the filter set.
      */
     isForeignKey?: boolean;
 
@@ -144,27 +144,27 @@ export interface PredicateModel {
 export interface FilterSettingsModel {
 
     /**
-     * Specifies the columns to be filtered at initial rendering of the TreeGrid. You can also get the columns that were currently filtered.
+     * Specifies the initial filter configuration for TreeGrid columns or retrieves the current filter state.
      *
      * @default []
      */
     columns?: PredicateModel[];
 
     /**
-     * Defines options for filtering type. The available options are
-     * * `Menu` - Specifies the filter type as menu.
-     * * `FilterBar` - Specifies the filter type as filterbar.
+     * Sets the filtering interface type. Options include:
+     * * `Menu`: Provides a menu for filtering options.
+     * * `FilterBar`: Allows direct input filtering in a bar at the top of each column.
+     * * `Excel` : Specifies the filter type as excel.
+     * * `CheckBox` : Specifies the filter type as check box.
      *
      * @default FilterBar
      */
     type?: FilterType;
 
     /**
-     * Defines the filter bar modes. The available options are,
-     * ```props
-     * *  OnEnter :- Initiates filter operation after Enter key is pressed.
-     * *  Immediate :- Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.
-     * ```
+     * Determines the mode of the filter bar operation. Options include:
+     * * `OnEnter`: Filtering is triggered upon pressing the Enter key.
+     * * `Immediate`: Filtering occurs after a short delay automatically.
      *
      * @default Syncfusion.EJ2.Grids.FilterBarMode.OnEnter
      * @isEnumeration true
@@ -173,47 +173,39 @@ export interface FilterSettingsModel {
     mode?: FilterBarMode;
 
     /**
-     * Shows or hides the filtered status message on the pager.
+     * Shows or hides the status message related to filtering actions on the pager.
      *
      * @default true
      */
     showFilterBarStatus?: boolean;
 
     /**
-     * Defines the time delay (in milliseconds) in filtering records when the `Immediate` mode of filter bar is set.
+     * Determines the delay in milliseconds before filtering is triggered in `Immediate` mode.
      *
      * @default 1500
      */
     immediateModeDelay?: number;
 
     /**
-     * The `operators` is used to override the default operators in filter menu. This should be defined by type wise
-     * (string, number, date and boolean). Based on the column type, this customize operator list will render in filter menu.
-     *
-     * > Check the `Filter Menu Operator` customization.
+     * Allows customization of the default operators offered in the filter menu by defining custom operators for string, number, date, and boolean types.
      *
      * @default null
      */
     operators?: ICustomOptr;
 
     /**
-     * If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
-     *
-     * > Check the [`Diacritics`](../../treegrid/filtering/#diacritics/) filtering.
+     * If set to `true`, filtering ignores accent characters, making diacritic characters identical to their unaccented versions.
      *
      * @default false
      */
     ignoreAccent?: boolean;
 
     /**
-     *  Defines the filter hierarchy modes. The available options are,
-     * ```props
-     * *  Parent :- Shows the filtered record with parent record.
-     * *  Child :- Shows the filtered record with child record.
-     * *  Both :- Shows the filtered record with both parent and child record.
-     * *  None :- Shows only the filtered record.
-     * ```
-     * {% codeBlock src='treegrid/hierarchyMode/index.md' %}{% endcodeBlock %}
+     * Specifies how the hierarchy should be maintained during filtering:
+     * * `Parent`: Displays the filtered records along with their parent records.
+     * * `Child`: Displays the filtered records along with their child records.
+     * * `Both`: Displays the filtered records with both parent and child records.
+     * * `None`: Only displays the filtered records.
      *
      * @default Parent
      * @isEnumeration true