@syncfusion/ej2-angular-treegrid 32.1.22 → 32.1.24-ngcc

package/src/treegrid/aggregate-columns.directive.d.ts

@@ -1,6 +1,5 @@
 import { ViewContainerRef } from '@angular/core';
 import { ComplexBase, ArrayBase } from '@syncfusion/ej2-angular-base';
-import * as i0 from "@angular/core";
 /**
  * `e-aggregate->e-column` directive represent a aggregate column of the Angular TreeGrid.
  * ```html
@@ -23,62 +22,62 @@ export declare class AggregateColumnDirective extends ComplexBase<AggregateColum
     private viewContainerRef;
     directivePropList: any;
     /**
-     * Defines the aggregate type(s) for a particular column.
-     * To apply multiple aggregates to a single column, specify the `type` as an array.
-     * Available aggregate types include:
-     * * `sum`: Calculates the sum of all values in a column.
-     * * `average`: Computes the average of the column values.
-     * * `max`: Finds the maximum value in a column.
-     * * `min`: Finds the minimum value in a column.
-     * * `count`: Counts the number of records.
-     * * `falsecount`: Counts the number of false values.
-     * * `truecount`: Counts the number of true values.
-     * * `custom`: Allows for a custom aggregate function.
-     *
-     * Use `custom` to specify a custom aggregation.
-     *
+     * Defines the aggregate type of a particular column.
+     * To use multiple aggregates for single column, specify the `type` as array.
+     * Types of aggregate are,
+     * * sum
+     * * average
+     * * max
+     * * min
+     * * count
+     * * falsecount
+     * * truecount
+     * * custom
+     * > Specify the `type` value as `custom` to use custom aggregation.
      * @asptype string
      * @default null
      */
     type: any;
     /**
-     * Specifies the column name to display the aggregate value. If not defined, the `field` name is used by default.
+     * Defines the column name to display the aggregate value. If `columnName` is not defined,
+     * then `field` name value will be assigned to the `columnName` property.
      * @default null
      */
     columnName: any;
     /**
-     * Defines a custom function to calculate the aggregate value. The `type` must be set to `custom`.
-     * Use the custom value as `${custom}` in templates.
-     * * `Total aggregation`: The custom function is called with the entire dataset and the current `AggregateColumn` object.
-     * * `Group aggregation`: It is called with the current group details and the `AggregateColumn` object.
+     * Defines a function to calculate custom aggregate value. The `type` value should be set to `custom`.
+     * To use custom aggregate value in the template, use the key as `${custom}`.
+     * **Total aggregation**: The custom function will be called with the whole data and the current `AggregateColumn` object.
+     * **Group aggregation**: This will be called with the current group details and the `AggregateColumn` object.
      * @default null
      */
     customAggregate: any;
     /**
-     * Specifies the column name on which to perform the aggregation.
+     * Defines the column name to perform aggregation.
      * @default null
      */
     field: any;
     /**
-     * Specifies the format to be applied to the calculated aggregate value before display.
-     * Supports both standard and custom formats for numbers and dates.
-     * Refer to the Syncfusion documentation for [number](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string)
-     * and [date](https://ej2.syncfusion.com/documentation/common/internationalization#date-formatting) formats.
+     * Format is applied to a calculated value before it is displayed.
+     * Gets the format from the user, which can be standard or custom
+     * [`number`](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string)
+     * and [`date`](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string-1) formats.
      * @asptype string
      * @default null
      */
     format: any;
     /**
-     * Defines a template for the footer cell of the aggregate column.
-     * Use the aggregate `type` names within the template to access aggregate values.
+     * Defines the footer cell template as a string for the aggregate column.
+     * The `type` name should be used to access aggregate values inside the template.
+     *
+     * {% codeBlock src="grid/footer-template-api/index.ts" %}{% endcodeBlock %}
+     *
      * @default null
      * @asptype string
 
      */
     footerTemplate: any;
     constructor(viewContainerRef: ViewContainerRef);
-    static ɵfac: i0.ɵɵFactoryDeclaration<AggregateColumnDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<AggregateColumnDirective, "ejs-treegrid>e-aggregates>e-aggregate>e-columns>e-column", never, { "columnName": "columnName"; "customAggregate": "customAggregate"; "field": "field"; "footerTemplate": "footerTemplate"; "format": "format"; "type": "type"; }, {}, ["footerTemplate"]>;
 }
 /**
  * AggregateColumn Array Directive
@@ -86,6 +85,4 @@ export declare class AggregateColumnDirective extends ComplexBase<AggregateColum
  */
 export declare class AggregateColumnsDirective extends ArrayBase<AggregateColumnsDirective> {
     constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<AggregateColumnsDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<AggregateColumnsDirective, "ejs-treegrid>e-aggregates>e-aggregate>e-columns", never, {}, {}, ["children"]>;
 }

package/src/treegrid/aggregates.directive.d.ts

@@ -1,6 +1,5 @@
 import { ViewContainerRef } from '@angular/core';
 import { ComplexBase, ArrayBase } from '@syncfusion/ej2-angular-base';
-import * as i0 from "@angular/core";
 /**
  * `e-aggregate` directive represent a aggregate row of the Angular TreeGrid.
  * It must be contained in a TreeGrid component(`ejs-treegrid`).
@@ -26,17 +25,15 @@ export declare class AggregateDirective extends ComplexBase<AggregateDirective>
     childColumns: any;
     tags: string[];
     /**
-     * Configures the collection of aggregate columns.
+     * Configures the aggregate columns.
      * @default []
      */
     columns: any;
     /**
-     * Determines whether to display child summaries for each parent row.
+     * Display the childSummary for each parent.
      */
     showChildSummary: any;
     constructor(viewContainerRef: ViewContainerRef);
-    static ɵfac: i0.ɵɵFactoryDeclaration<AggregateDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<AggregateDirective, "ejs-treegrid>e-aggregates>e-aggregate", never, { "columns": "columns"; "showChildSummary": "showChildSummary"; }, {}, ["childColumns"]>;
 }
 /**
  * Aggregate Array Directive
@@ -44,6 +41,4 @@ export declare class AggregateDirective extends ComplexBase<AggregateDirective>
  */
 export declare class AggregatesDirective extends ArrayBase<AggregatesDirective> {
     constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<AggregatesDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<AggregatesDirective, "ejs-treegrid>e-aggregates", never, {}, {}, ["children"]>;
 }

package/src/treegrid/columns.directive.d.ts

@@ -1,6 +1,5 @@
 import { ViewContainerRef } from '@angular/core';
 import { ComplexBase, ArrayBase } from '@syncfusion/ej2-angular-base';
-import * as i0 from "@angular/core";
 /**
  * `e-column` directive represent a column of the Angular TreeGrid.
  * It must be contained in a TreeGrid component(`ejs-treegrid`).
@@ -19,53 +18,60 @@ export declare class ColumnDirective extends ComplexBase<ColumnDirective> {
     childColumns: any;
     tags: string[];
     /**
-     * Defines the type of data stored in the column, which may be string, number, date, or other types.
+     * Defines the data type of the column.
      * @default null
      */
     type: any;
     /**
-     * Controls whether editing is permitted for the column. By default, all columns are editable.
+     * If `allowEditing` set to false, then it disables editing of a particular column.
+     * By default all columns are editable.
      * @default true
      */
     allowEditing: any;
     /**
-     * Controls whether the column supports filtering. If set to false, users cannot filter data by this column.
+     * If `allowFiltering` set to false, then it disables filtering option and filter bar element of a particular column.
+     * By default all columns are filterable.
      * @default true
      */
     allowFiltering: any;
     /**
-     * Enables or disables the reordering of this column via drag-and-drop. Allows for dynamic column adjustments.
+     * If `allowReordering` set to false, then it disables reorder of a particular column.
+     * By default all columns can be reorder.
      * @default true
      */
     allowReordering: any;
     /**
-     * Determines if this column can be resized. If false, the column size is fixed.
+     * If `allowResizing` set to false, it disables resize option of a particular column.
      * @default true
      */
     allowResizing: any;
     /**
-     * Specifies whether sorting is enabled for this column. Set to false to prevent sort actions.
+     * If `allowSorting` set to false, then it disables sorting option of a particular column.
+     * By default all columns are sortable.
      * @default true
      */
     allowSorting: any;
     /**
-     * Determines how overflow content is handled within a cell. Options include:
-     * * `Clip`: Truncates the content.
-     * * `Ellipsis`: Shows ellipsis for overflow.
-     * * `EllipsisWithTooltip`: Shows ellipsis and tooltip on hover.
+     * Defines the cell content's overflow mode. The available modes are
+     *
+     * also it will display tooltip while hover on ellipsis applied cell.
      * @default Syncfusion.EJ2.Grids.ClipMode.Ellipsis
      * @isenumeration true
      * @asptype Syncfusion.EJ2.Grids.ClipMode
      */
     clipMode: any;
     /**
-     * Allows for the creation of stacked headers by using multiple rows in the grid's header.
+     * Used to render multiple header rows(stacked headers) on TreeGrid header.
      * @default null
      */
     columns: any;
     /**
-     * Provides built-in command button options for cells. Options include Edit, Delete, Save, and Cancel.
-     * Custom command button implementations are possible.
+     * `commands` provides an option to display command buttons in every cell.
+     * The available built-in command buttons are
+     * * Edit - Edit the record.
+     * * Delete - Delete the record.
+     * * Save - Save the record.
+     * * Cancel - Cancel the edit state.
      *
      * The following code example implements the custom command column.
      *```html
@@ -92,59 +98,55 @@ export declare class ColumnDirective extends ComplexBase<ColumnDirective> {
      */
     commands: any;
     /**
-     * Enables the addition of CSS styles and attributes for the content cells in a particular column.
+     * The CSS styles and attributes of the content cells of a particular column can be customized.
      * @default null
      */
     customAttributes: any;
     /**
-     * Sets default values when new records are added to the TreeGrid involving this column.
+     * Defines default values for the component when adding a new record to the TreeGrid.
      * @default null
      */
     defaultValue: any;
     /**
-     * If set to `true`, the HTML content within header and content cells is encoded to prevent injection attacks.
+     * If `disableHtmlEncode` is set to true, it encodes the HTML of the header and content cells.
      * @default true
      */
     disableHtmlEncode: any;
     /**
-     * Displays the column value as a checkbox instead of a Boolean value when set to `true`.
+     * If `displayAsCheckBox` is set to true, it displays the column value as a check box instead of Boolean value.
      * @default false
      */
     displayAsCheckBox: any;
     /**
-     * Allows customizing the default edit cell through the `IEditCell` object for more control over editing.
+     * Defines the `IEditCell` object to customize default edit cell.
      * @default {}
      */
     edit: any;
     /**
-     * Specifies the component type used for editing cells within this column.
+     * Defines the type of component for editing.
      * @default 'stringedit'
      */
     editType: any;
     /**
-     * Allows treegrid to perform column spanning on the specified column.
-     * @default true
-     */
-    enableColumnSpan: any;
-    /**
-     * Allows treegrid to perform row spanning on the specified column.
-     * @default true
-     */
-    enableRowSpan: any;
-    /**
-     * Specifies the field name in the data source to which the column is bound. This field is used for operations like sorting and filtering.
-     * The field name must be a valid JavaScript identifier, beginning with a letter and avoiding spaces and special characters.
+     * Defines the field name of column which is mapped with mapping name of DataSource.
+     * The bounded columns can be sort, filter etc.,
+     * The `field` name must be a valid JavaScript identifier,
+     * the first character must be an alphabet and should not contain spaces and special characters.
      * @default 'undefined'
      */
     field: any;
     /**
-     * Customizes filter options for the column, enabling specialized filtering functionality.
-     * @default null
+     *  Defines the filter options to customize filtering for the particular column.
+     *
+     *  @default null
+     *
      */
     filter: any;
     /**
-     * Allows for a custom component within the filter bar, facilitating advanced filter interfaces.
-     * Includes create and read functions for custom component management.
+     * The `filterBarTemplate` is used to add a custom component instead of default input component for filter bar.
+     * It have create and read functions.
+     * * create: It is used for creating custom components.
+     * * read: It is used to perform custom filter action.
      *
      * ```html
      *<div id="TreeGrid"></div>
@@ -169,7 +171,7 @@ export declare class ColumnDirective extends ComplexBase<ColumnDirective> {
      *            gridObj.filterByColumn(args.element.id, 'equal', args.element.value);
      *       }
      *    }
-     *}],
+     * }],
      *  allowFiltering: true
      *});
      *gridObj.appendTo('#TreeGrid');
@@ -179,33 +181,35 @@ export declare class ColumnDirective extends ComplexBase<ColumnDirective> {
      */
     filterBarTemplate: any;
     /**
-     * Formats the displayed value of the column without affecting the underlying data. Supports standard and custom formats for numbers and dates.
-     *
-     * References for [number](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string)
-     *and [date](https://ej2.syncfusion.com/documentation/common/internationalization#date-formatting) formats.
+     * It is used to change display value with the given format and does not affect the original data.
+     * Gets the format from the user which can be standard or custom
+     * [`number`](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string)
+     * and [`date`](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string-1) formats.
      * @default null
      * @asptype string
      */
     format: any;
     /**
-     * Allows for custom cell content formatting using an external method, executed prior to rendering.
+     * Defines the method which is used to achieve custom formatting from an external function.
+     * This function triggers before rendering of each cell.
      * @default null
      */
     formatter: any;
     /**
-     * Determines which side (left, right, or center) the column should be frozen on.
+     * Defines which side the column need to freeze
      * @default Syncfusion.EJ2.Grids.FreezeDirection.None
      * @isenumeration true
      * @asptype Syncfusion.EJ2.Grids.FreezeDirection
      */
     freeze: any;
     /**
-     * Specifies the text displayed in the column header. If omitted, the `field` value is used as the header text.
+     * Defines the header text of column which is used to display in column header.
+     * If `headerText` is not defined, then field name value will be assigned to header text.
      * @default 'undefined'
      */
     headerText: any;
     /**
-     * Aligns the text in the column header. By default, the alignment corresponds to other content alignments.
+     * Define the alignment of column header which is used to align the text of column header.
      * @default null
      * @aspdefaultvalueignore
      * @isenumeration true
@@ -213,119 +217,124 @@ export declare class ColumnDirective extends ComplexBase<ColumnDirective> {
      */
     headerTextAlign: any;
     /**
-     * Adjusts column visibility based on [Media Queries](http://cssmediaqueries.com/what-are-css-media-queries.html). Accepts valid CSS media query strings for responsive adjustments.
+     * Column visibility can change based on [`Media Queries`](http://cssmediaqueries.com/what-are-css-media-queries.html).
+     * `hideAtMedia` accepts only valid Media Queries.
      * @default 'undefined'
      */
     hideAtMedia: any;
     /**
-     * Allows the column to be frozen, keeping it stationary while scrolling horizontally through the grid.
+     * You can use this property to freeze selected columns in grid.
      * @default false
      */
     isFrozen: any;
     /**
-     * Identifies the column as an identity column in database terms, if set to `true`.
+     * If `isIdentity` is set to true, then this column is considered as identity column.
      * @default false
      */
     isIdentity: any;
     /**
-     * Identifies the column as a primary key if set to `true`, enforcing uniqueness.
+     * If `isPrimaryKey` is set to true, considers this column as the primary key constraint.
      * @default false
      */
     isPrimaryKey: any;
     /**
-     * Prevents column reordering when set to true, locking the column into a set position.
+     * If `lockColumn` set to true, then it disables Reordering of a particular column.
+     * The locked column will be moved to first position.
      * @default false
      */
     lockColumn: any;
     /**
-     * Defines the maximum allowable width of the column in pixels or as a percentage, preventing resizing beyond this limit.
+     * Defines the maximum width of the column in pixels or percentage, which will restrict resizing beyond this pixels or percentage.
      * @default 'undefined'
      */
     maxWidth: any;
     /**
-     * Determines the minimum width of the column in pixels or percentage. This ensures the column does not shrink below this size.
+     * Defines the minimum width of the column in pixels or percentage.
      * @default 'undefined'
      */
     minWidth: any;
     /**
-     * Displays checkboxes in the column when enabled, allowing for selections and certain operations.
+     * If `showCheckbox` set to true, then the checkboxes will be displayed in particular column.
      * @default false
      */
     showCheckbox: any;
     /**
-     * Decides if the column menu should be available, providing options for column customization.
+     * If `showColumnMenu` set to false, then it disable the column menu of a particular column.
+     * By default column menu will show for all columns
      * @default true
      */
     showColumnMenu: any;
     /**
-     * Determines whether the column should appear in the Column Chooser. Set to false to exclude it.
+     * If `showInColumnChooser` set to false, then hide the particular column in column chooser.
+     *  By default all columns are displayed in column Chooser.
      * @default true
      */
     showInColumnChooser: any;
     /**
-     * Provides a custom sort comparer property to control how sorting is handled for this column's data.
+     * Defines the sort comparer property.
      * @default 'undefined'
      */
     sortComparer: any;
     /**
-     * Specifies the horizontal alignment for the column content and header. Options include alignment to the left, center, or right.
+     * Defines the alignment of the column in both header and content cells.
      * @default Syncfusion.EJ2.Grids.TextAlign.Left
      * @isenumeration true
      * @asptype Syncfusion.EJ2.Grids.TextAlign
      */
     textAlign: any;
     /**
-     * Retrieves the unique identifier for the column. This UID is used internally to reference and manipulate the column.
+     * Gets the unique identifier value of the column. It is used to get the object.
      * @default 'undefined'
      */
     uid: any;
     /**
-     * Establishes validation rules to ensure data integrity during creation and updates.
+     * Defines rules to validate data before creating and updating.
      * @default null
      */
     validationRules: any;
     /**
-     * Applies custom cell values using an external function, allowing for dynamic display adjustments.
+     * Defines the method used to apply custom cell values from external function and display this on each cell rendered.
      * @default null
      */
     valueAccessor: any;
     /**
-     * Toggles the visibility of the column. Set to false to hide the column from view. Columns are visible by default.
+     * If `visible` is set to false, hides the particular column. By default, columns are displayed.
      * @default true
      */
     visible: any;
     /**
-     * Sets the column's width in pixels or as a percentage. This defines how the column will occupy space in the grid.
+     * Defines the width of the column in pixels or percentage.
      * @default 'undefined'
      */
     width: any;
     /**
-     * Customizes the rendering of cell content using either a template string or HTML element ID.
+     * Defines the column template that renders customized element in each cell of the column.
+     * It accepts either [template string](https://ej2.syncfusion.com/documentation/common/template-engine/) or HTML element ID.
      * @default null
      * @asptype string
      */
     template: any;
     /**
-     * Customizes the header content with a template, defined as a string or an HTML element ID.
+     * Defines the header template as string or HTML element ID which is used to add customized element in the column header.
      * @default null
      * @asptype string
      */
     headerTemplate: any;
     filter_itemTemplate: any;
     /**
-     * Specifies a custom template or UI for filtering within this column, utilizing either string templates or HTML element IDs.
+     * Defines the filter template/UI that is used as filter for a particular column.
+     * It accepts either template string or HTML element ID.
      * @aspignore
      */
     filterTemplate: any;
     commandsTemplate: any;
     /**
-     * Provides a template for editing cells in this column, supporting either a template string or an HTML element ID.
+     * Defines the cell edit template that used as editor for a particular column.
+     * It accepts either template string or HTML element ID.
      * @aspignore
      */
     editTemplate: any;
     constructor(viewContainerRef: ViewContainerRef);
-    static ɵfac: i0.ɵɵFactoryDeclaration<ColumnDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<ColumnDirective, "ejs-treegrid>e-columns>e-column", never, { "allowEditing": "allowEditing"; "allowFiltering": "allowFiltering"; "allowReordering": "allowReordering"; "allowResizing": "allowResizing"; "allowSorting": "allowSorting"; "clipMode": "clipMode"; "columns": "columns"; "commands": "commands"; "customAttributes": "customAttributes"; "defaultValue": "defaultValue"; "disableHtmlEncode": "disableHtmlEncode"; "displayAsCheckBox": "displayAsCheckBox"; "edit": "edit"; "editTemplate": "editTemplate"; "editType": "editType"; "enableColumnSpan": "enableColumnSpan"; "enableRowSpan": "enableRowSpan"; "field": "field"; "filter": "filter"; "filterBarTemplate": "filterBarTemplate"; "filterTemplate": "filterTemplate"; "format": "format"; "formatter": "formatter"; "freeze": "freeze"; "headerTemplate": "headerTemplate"; "headerText": "headerText"; "headerTextAlign": "headerTextAlign"; "hideAtMedia": "hideAtMedia"; "isFrozen": "isFrozen"; "isIdentity": "isIdentity"; "isPrimaryKey": "isPrimaryKey"; "lockColumn": "lockColumn"; "maxWidth": "maxWidth"; "minWidth": "minWidth"; "showCheckbox": "showCheckbox"; "showColumnMenu": "showColumnMenu"; "showInColumnChooser": "showInColumnChooser"; "sortComparer": "sortComparer"; "template": "template"; "textAlign": "textAlign"; "type": "type"; "uid": "uid"; "validationRules": "validationRules"; "valueAccessor": "valueAccessor"; "visible": "visible"; "width": "width"; }, {}, ["template", "headerTemplate", "filter_itemTemplate", "filterTemplate", "commandsTemplate", "editTemplate", "childColumns"]>;
 }
 /**
  * Column Array Directive
@@ -333,6 +342,4 @@ export declare class ColumnDirective extends ComplexBase<ColumnDirective> {
  */
 export declare class ColumnsDirective extends ArrayBase<ColumnsDirective> {
     constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<ColumnsDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<ColumnsDirective, "ejs-treegrid>e-columns", never, {}, {}, ["children"]>;
 }