@syncfusion/ej2-treegrid 31.1.17 → 31.1.20

package/dist/ts/treegrid/models/selection-settings.ts

@@ -1,82 +0,0 @@
-import { Property, ChildProperty } from '@syncfusion/ej2-base';
-import { SelectionMode, CellSelectionMode, SelectionType, CheckboxSelectionType } from '@syncfusion/ej2-grids';
-
-/**
- * Configures the selection behavior of the TreeGrid.
- */
-export class SelectionSettings extends ChildProperty<SelectionSettings> {
-    /**
-     * Specifies the selection mode for the TreeGrid, which supports row, cell, and both (row and cell) selection modes.
-     * * `Row`: Selects the entire row.
-     * * `Cell`: Selects a single cell.
-     * * `Both`: Selects the entire row and its cells.
-     *
-     * @default Syncfusion.EJ2.Grids.SelectionMode.Row
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.SelectionMode
-     */
-    @Property('Row')
-    public mode: SelectionMode;
-
-    /**
-     * Determines the mode for cell selection, available options are flow and box.
-     * Requires the selection `mode` to be either cell or both.
-     * * `Flow`: Selects the range between start and end indexes, including other cells of selected rows.
-     * * `Box`: Selects cells within the start and end column indexes within the selected rows.
-     *
-     * @default Syncfusion.EJ2.Grids.CellSelectionMode.Flow
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.CellSelectionMode
-     */
-    @Property('Flow')
-    public cellSelectionMode: CellSelectionMode;
-
-    /**
-     * Defines the selection type, specifying whether single or multiple selections are allowed.
-     * * `Single`: Allows selection of only a single row or cell.
-     * * `Multiple`: Allows selection of multiple rows or cells.
-     *
-     * @default Syncfusion.EJ2.Grids.SelectionType.Single
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.SelectionType
-     */
-    @Property('Single')
-    public type: SelectionType;
-
-    /**
-     * When set to true, the TreeGrid selection persists even during various grid operations such as sorting or paging.
-     * Requires at least one column to be configured as the primary key for persistence.
-     *
-     * @default false
-     */
-    @Property(false)
-    public persistSelection: boolean;
-
-    /**
-     * Specifies the mode for checkbox selection:
-     * * `Default`: Allows selection of multiple rows by clicking on each row individually.
-     * * `ResetOnRowClick`: Resets prior selection when a new row is clicked. Multiple rows can be selected using CTRL or SHIFT keys.
-     *
-     * @default Syncfusion.EJ2.Grids.CheckboxSelectionType.Default
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.CheckboxSelectionType
-     */
-    @Property('Default')
-    public checkboxMode: CheckboxSelectionType;
-
-    /**
-     * If set to true, TreeGrid selection is allowed only through checkboxes. Ensure the column type is set to `checkbox` to enable this mode.
-     *
-     * @default false
-     */
-    @Property(false)
-    public checkboxOnly: boolean;
-
-    /**
-     * Enables toggling of the selected row. When true, users can toggle the selection of a row.
-     *
-     * @default true
-     */
-    @Property(true)
-    public enableToggle: boolean;
-}

package/dist/ts/treegrid/models/sort-settings-model.d.ts

@@ -1,49 +0,0 @@
-import { ChildProperty, Property, Collection } from '@syncfusion/ej2-base';import { SortDirection } from '@syncfusion/ej2-grids';
-
-/**
- * Interface for a class SortDescriptor
- */
-export interface SortDescriptorModel {
-
-    /**
-     * Specifies the field name of the column to be sorted.
-     *
-     * @default ''
-     */
-    field?: string;
-
-    /**
-     * Specifies the direction of sorting for the column. The available options are:
-     * * `Ascending`: Sorts the column in ascending order.
-     * * `Descending`: Sorts the column in descending order.
-     *
-     * @default ''
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.SortDirection
-     */
-    direction?: SortDirection;
-
-}
-
-/**
- * Interface for a class SortSettings
- */
-export interface SortSettingsModel {
-
-    /**
-     * Specifies the columns to be sorted at initial rendering of the TreeGrid.
-     * This property can also be used to get or modify the currently sorted columns at runtime.
-     *
-     * @default []
-     */
-    columns?: SortDescriptorModel[];
-
-    /**
-     * If set to false, the user cannot reset the TreeGrid to an unsorted state by clicking on the sorted column header.
-     * When true, clicking an already sorted column header will toggle the sort direction or remove sorting.
-     *
-     * @default true
-     */
-    allowUnsort?: boolean;
-
-}

package/dist/ts/treegrid/models/sort-settings.d.ts

@@ -1,43 +0,0 @@
-import { ChildProperty } from '@syncfusion/ej2-base';
-import { SortDirection } from '@syncfusion/ej2-grids';
-import { SortDescriptorModel } from './sort-settings-model';
-/**
- * Represents the field name and direction of a sort column in the TreeGrid.
- */
-export declare class SortDescriptor extends ChildProperty<SortDescriptor> {
-    /**
-     * Specifies the field name of the column to be sorted.
-     *
-     * @default ''
-     */
-    field: string;
-    /**
-     * Specifies the direction of sorting for the column. The available options are:
-     * * `Ascending`: Sorts the column in ascending order.
-     * * `Descending`: Sorts the column in descending order.
-     *
-     * @default ''
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.SortDirection
-     */
-    direction: SortDirection;
-}
-/**
- * Configures the sorting behavior of the TreeGrid.
- */
-export declare class SortSettings extends ChildProperty<SortSettings> {
-    /**
-     * Specifies the columns to be sorted at initial rendering of the TreeGrid.
-     * This property can also be used to get or modify the currently sorted columns at runtime.
-     *
-     * @default []
-     */
-    columns: SortDescriptorModel[];
-    /**
-     * If set to false, the user cannot reset the TreeGrid to an unsorted state by clicking on the sorted column header.
-     * When true, clicking an already sorted column header will toggle the sort direction or remove sorting.
-     *
-     * @default true
-     */
-    allowUnsort: boolean;
-}

package/dist/ts/treegrid/models/sort-settings.ts

@@ -1,51 +0,0 @@
-import { ChildProperty, Property, Collection } from '@syncfusion/ej2-base';
-import { SortDirection } from '@syncfusion/ej2-grids';
-import { SortDescriptorModel } from './sort-settings-model';
-
-/**
- * Represents the field name and direction of a sort column in the TreeGrid.
- */
-export class SortDescriptor extends ChildProperty<SortDescriptor> {
-    /**
-     * Specifies the field name of the column to be sorted.
-     *
-     * @default ''
-     */
-    @Property()
-    public field: string;
-
-    /**
-     * Specifies the direction of sorting for the column. The available options are:
-     * * `Ascending`: Sorts the column in ascending order.
-     * * `Descending`: Sorts the column in descending order.
-     *
-     * @default ''
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.SortDirection
-     */
-    @Property()
-    public direction: SortDirection;
-}
-
-/**
- * Configures the sorting behavior of the TreeGrid.
- */
-export class SortSettings extends ChildProperty<SortSettings> {
-    /**
-     * Specifies the columns to be sorted at initial rendering of the TreeGrid.
-     * This property can also be used to get or modify the currently sorted columns at runtime.
-     *
-     * @default []
-     */
-    @Collection<SortDescriptorModel>([], SortDescriptor)
-    public columns: SortDescriptorModel[];
-
-    /**
-     * If set to false, the user cannot reset the TreeGrid to an unsorted state by clicking on the sorted column header.
-     * When true, clicking an already sorted column header will toggle the sort direction or remove sorting.
-     *
-     * @default true
-     */
-    @Property(true)
-    public allowUnsort: boolean;
-}

package/dist/ts/treegrid/models/summary-model.d.ts

@@ -1,93 +0,0 @@
-import { Property, ChildProperty, Collection, getEnumValue, compile, DateFormatOptions, NumberFormatOptions } from '@syncfusion/ej2-base';import { Internationalization } from '@syncfusion/ej2-base';import { CustomSummaryType, AggregateType, CellType } from '@syncfusion/ej2-grids';
-
-/**
- * Interface for a class AggregateColumn
- */
-export interface AggregateColumnModel {
-
-    /**
-     * 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.
-     *
-     * @aspType string
-     * @default null
-     */
-    type?: AggregateType | AggregateType[] | string;
-
-    /**
-     * Defines a template for the footer cell of the aggregate column.
-     * Use the aggregate `type` names within the template to access aggregate values.
-     *
-     * @default null
-     * @aspType string
-     *
-     */
-    footerTemplate?: string | Function;
-
-    /**
-     * Specifies the column name on which to perform the aggregation.
-     *
-     * @default null
-     */
-    field?: string;
-
-    /**
-     * 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.
-     *
-     * @aspType string
-     * @default null
-     */
-    format?: string | NumberFormatOptions | DateFormatOptions;
-
-    /**
-     * Specifies the column name to display the aggregate value. If not defined, the `field` name is used by default.
-     *
-     * @default null
-     */
-    columnName?: string;
-
-    /**
-     * 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.
-     *
-     * @default null
-     */
-    customAggregate?: CustomSummaryType | string;
-
-}
-
-/**
- * Interface for a class AggregateRow
- */
-export interface AggregateRowModel {
-
-    /**
-     * Configures the collection of aggregate columns.
-     *
-     * @default []
-     */
-    columns?: AggregateColumnModel[];
-
-    /**
-     * Determines whether to display child summaries for each parent row.
-     *
-     */
-    showChildSummary?: boolean;
-
-}

package/dist/ts/treegrid/models/summary.d.ts

@@ -1,126 +0,0 @@
-import { ChildProperty, DateFormatOptions, NumberFormatOptions } from '@syncfusion/ej2-base';
-import { AggregateColumnModel } from './summary-model';
-import { CustomSummaryType, AggregateType, CellType } from '@syncfusion/ej2-grids';
-/**
- * Configures the aggregate column for the TreeGrid.
- */
-export declare class AggregateColumn extends ChildProperty<AggregateColumn> {
-    private formatFn;
-    private intl;
-    private templateFn;
-    /**
-     * 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.
-     *
-     * @aspType string
-     * @default null
-     */
-    type: AggregateType | AggregateType[] | string;
-    /**
-     * Defines a template for the footer cell of the aggregate column.
-     * Use the aggregate `type` names within the template to access aggregate values.
-     *
-     * @default null
-     * @aspType string
-     *
-     */
-    footerTemplate: string | Function;
-    /**
-     * Specifies the column name on which to perform the aggregation.
-     *
-     * @default null
-     */
-    field: string;
-    /**
-     * 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.
-     *
-     * @aspType string
-     * @default null
-     */
-    format: string | NumberFormatOptions | DateFormatOptions;
-    /**
-     * Specifies the column name to display the aggregate value. If not defined, the `field` name is used by default.
-     *
-     * @default null
-     */
-    columnName: string;
-    /**
-     * 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.
-     *
-     * @default null
-     */
-    customAggregate: CustomSummaryType | string;
-    /**
-     * Custom format function
-     *
-     * @hidden
-     * @param {string} cultureName - culture name to format
-     * @returns {void}
-     */
-    setFormatter(cultureName: string): void;
-    /**
-     * @param {NumberFormatOptions | DateFormatOptions} format - formatting options for number and date values
-     * @hidden
-     * @returns {Function} - return formatter function
-     */
-    getFormatFunction(format: NumberFormatOptions | DateFormatOptions): Function;
-    /**
-     * @hidden
-     * @returns {Function} - Returns formatter function
-     */
-    getFormatter(): Function;
-    /**
-     * @param {Object} helper - Specified the helper
-     * @hidden
-     * @returns {void}
-     */
-    setTemplate(helper?: Object): void;
-    /**
-     * @param {CellType} type - specifies the cell type
-     * @returns {Object} returns the object
-     * @hidden
-     */
-    getTemplate(type: CellType): {
-        fn: Function;
-        property: string;
-    };
-    /**
-     * @param {Object} prop - updates aggregate properties without change detection
-     * @hidden
-     * @returns {void}
-     */
-    setPropertiesSilent(prop: Object): void;
-}
-/**
- * Configures the aggregate rows in the TreeGrid.
- */
-export declare class AggregateRow extends ChildProperty<AggregateRow> {
-    /**
-     * Configures the collection of aggregate columns.
-     *
-     * @default []
-     */
-    columns: AggregateColumnModel[];
-    /**
-     * Determines whether to display child summaries for each parent row.
-     *
-     */
-    showChildSummary: boolean;
-}

package/dist/ts/treegrid/models/summary.ts

@@ -1,170 +0,0 @@
-import { Property, ChildProperty, Collection, getEnumValue, compile, DateFormatOptions, NumberFormatOptions } from '@syncfusion/ej2-base';
-import { Internationalization } from '@syncfusion/ej2-base';
-import { AggregateColumnModel } from './summary-model';
-import { CustomSummaryType, AggregateType, CellType } from '@syncfusion/ej2-grids';
-
-/**
- * Configures the aggregate column for the TreeGrid.
- */
-export class AggregateColumn extends ChildProperty<AggregateColumn> {
-    private formatFn: Function;
-    private intl: Internationalization = new Internationalization();
-    private templateFn: { [x: string]: { fn: Function, property: string } } = {};
-
-    /**
-     * 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.
-     *
-     * @aspType string
-     * @default null
-     */
-    @Property()
-    public type: AggregateType | AggregateType[] | string;
-
-    /**
-     * Defines a template for the footer cell of the aggregate column.
-     * Use the aggregate `type` names within the template to access aggregate values.
-     *
-     * @default null
-     * @aspType string
-     *
-     */
-    @Property()
-    public footerTemplate: string | Function;
-
-    /**
-     * Specifies the column name on which to perform the aggregation.
-     *
-     * @default null
-     */
-    @Property()
-    public field: string;
-
-    /**
-     * 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.
-     *
-     * @aspType string
-     * @default null
-     */
-    @Property()
-    public format: string | NumberFormatOptions | DateFormatOptions;
-
-    /**
-     * Specifies the column name to display the aggregate value. If not defined, the `field` name is used by default.
-     *
-     * @default null
-     */
-    @Property()
-    public columnName: string;
-
-    /**
-     * 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.
-     *
-     * @default null
-     */
-    @Property()
-    public customAggregate: CustomSummaryType | string;
-
-    /**
-     * Custom format function
-     *
-     * @hidden
-     * @param {string} cultureName - culture name to format
-     * @returns {void}
-     */
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    public setFormatter(cultureName: string): void {
-        if (this.format && ((<DateFormatOptions>this.format).skeleton || (<DateFormatOptions>this.format).format)) {
-            this.formatFn = this.getFormatFunction(this.format as DateFormatOptions);
-        }
-    }
-
-    /**
-     * @param {NumberFormatOptions | DateFormatOptions} format - formatting options for number and date values
-     * @hidden
-     * @returns {Function} - return formatter function
-     */
-    public getFormatFunction(format: NumberFormatOptions | DateFormatOptions): Function {
-        if ((<DateFormatOptions>format).type) {
-            return this.intl.getDateFormat(<DateFormatOptions>format);
-        } else {
-            return this.intl.getNumberFormat(<DateFormatOptions>format);
-        }
-    }
-
-    /**
-     * @hidden
-     * @returns {Function} - Returns formatter function
-     */
-    public getFormatter(): Function {
-        return this.formatFn;
-    }
-
-    /**
-     * @param {Object} helper - Specified the helper
-     * @hidden
-     * @returns {void}
-     */
-    public setTemplate(helper: Object = {}): void {
-        if (this.footerTemplate !== undefined) {
-            this.templateFn[getEnumValue(CellType, CellType.Summary)] = { fn: compile(this.footerTemplate, helper),
-                property: 'footerTemplate' };
-
-        }
-    }
-    /**
-     * @param {CellType} type - specifies the cell type
-     * @returns {Object} returns the object
-     * @hidden
-     */
-    public getTemplate(type: CellType): { fn: Function, property: string } {
-        return this.templateFn[getEnumValue(CellType, type)];
-    }
-
-    /**
-     * @param {Object} prop - updates aggregate properties without change detection
-     * @hidden
-     * @returns {void}
-     */
-    public setPropertiesSilent(prop: Object): void {
-        this.setProperties(prop, true);
-    }
-
-}
-
-/**
- * Configures the aggregate rows in the TreeGrid.
- */
-export class AggregateRow extends ChildProperty<AggregateRow> {
-    /**
-     * Configures the collection of aggregate columns.
-     *
-     * @default []
-     */
-    @Collection<AggregateColumnModel>([], AggregateColumn)
-    public columns: AggregateColumnModel[];
-
-    /**
-     * Determines whether to display child summaries for each parent row.
-     *
-     */
-    @Property(true)
-    public showChildSummary: boolean;
-}

package/dist/ts/treegrid/models/textwrap-settings-model.d.ts

@@ -1,21 +0,0 @@
-import { Property, ChildProperty } from '@syncfusion/ej2-base';import { WrapMode } from '../enum';
-
-/**
- * Interface for a class TextWrapSettings
- */
-export interface TextWrapSettingsModel {
-
-    /**
-     * Defines the `wrapMode` of the TreeGrid, controlling how text wrapping is applied to header and content.
-     * Available wrap modes are:
-     * * `Both`: Wraps both the header and the content of all columns.
-     * * `Content`: Wraps only the content of the columns, allowing headers to remain unchanged.
-     * * `Header`: Wraps only the header text of the columns, while content remains unwrapped.
-     *
-     * Text wrapping can improve readability when dealing with long text values or narrow column widths.
-     *
-     * @default Both
-     */
-    wrapMode?: WrapMode;
-
-}

package/dist/ts/treegrid/models/textwrap-settings.d.ts

@@ -1,19 +0,0 @@
-import { ChildProperty } from '@syncfusion/ej2-base';
-import { WrapMode } from '../enum';
-/**
- * Configures the text wrapping behavior of the TreeGrid.
- */
-export declare class TextWrapSettings extends ChildProperty<TextWrapSettings> {
-    /**
-     * Defines the `wrapMode` of the TreeGrid, controlling how text wrapping is applied to header and content.
-     * Available wrap modes are:
-     * * `Both`: Wraps both the header and the content of all columns.
-     * * `Content`: Wraps only the content of the columns, allowing headers to remain unchanged.
-     * * `Header`: Wraps only the header text of the columns, while content remains unwrapped.
-     *
-     * Text wrapping can improve readability when dealing with long text values or narrow column widths.
-     *
-     * @default Both
-     */
-    wrapMode: WrapMode;
-}

package/dist/ts/treegrid/models/textwrap-settings.ts

@@ -1,21 +0,0 @@
-import { Property, ChildProperty } from '@syncfusion/ej2-base';
-import { WrapMode } from '../enum';
-
-/**
- * Configures the text wrapping behavior of the TreeGrid.
- */
-export class TextWrapSettings extends ChildProperty<TextWrapSettings> {
-    /**
-     * Defines the `wrapMode` of the TreeGrid, controlling how text wrapping is applied to header and content.
-     * Available wrap modes are:
-     * * `Both`: Wraps both the header and the content of all columns.
-     * * `Content`: Wraps only the content of the columns, allowing headers to remain unchanged.
-     * * `Header`: Wraps only the header text of the columns, while content remains unwrapped.
-     *
-     * Text wrapping can improve readability when dealing with long text values or narrow column widths.
-     *
-     * @default Both
-     */
-    @Property('Both')
-    public wrapMode: WrapMode;
-}

package/dist/ts/treegrid/renderer/index.d.ts

@@ -1,5 +0,0 @@
-/**
- * Renderer export
- */
-export * from './render';
-export * from './virtual-row-model-generator';