@syncfusion/ej2-treegrid 30.2.4 → 31.1.17

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

@@ -0,0 +1,66 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';import { PageSizeMode } from '../enum';
+
+/**
+ * Interface for a class PageSettings
+ */
+export interface PageSettingsModel {
+
+    /**
+     * Specifies the number of records to display per page in the TreeGrid. Adjust this setting to control the volume of data presented on each page.
+     *
+     * @default 12
+     */
+    pageSize?: number;
+
+    /**
+     * Determines the number of page numbers displayed in the TreeGrid pager container. This setting helps users navigate between different parts of the dataset.
+     *
+     * @default 8
+     */
+    pageCount?: number;
+
+    /**
+     * Sets the current page number in the TreeGrid, defining which page of data is initially displayed to users.
+     *
+     * @default 1
+     */
+    currentPage?: number;
+
+    /**
+     * @hidden
+     * Retrieves the total number of records in the TreeGrid. This property is primarily used internally by the TreeGrid component.
+     */
+    totalRecordsCount?: number;
+
+    /**
+     * When set to true, appends the current page information as a query string to the remote service URL during page navigation within the TreeGrid.
+     *
+     * @default false
+     */
+    enableQueryString?: boolean;
+
+    /**
+     * Enables a DropDownList in the TreeGrid pager, allowing users to select the page size. Accepts either a boolean to toggle this feature or an array of page size options.
+     *
+     * @default false
+     */
+    pageSizes?: boolean | (number | string)[];
+
+    /**
+     * Provides a custom template for rendering pager elements in the TreeGrid, offering enhanced flexibility and control over the pager's appearance and functionality. Accepts a template string or the ID of an HTML element.
+     *
+     * @default null
+     * @aspType string
+     */
+    template?: string | Function;
+
+    /**
+     * Specifies the mode for counting records on a page, determining whether all records are counted or only zeroth level parent records. The available options are:
+     * * `All`: Includes all records in the count.
+     * * `Root`: Includes only zeroth level parent records.
+     *
+     * @default All
+     */
+    pageSizeMode?: PageSizeMode;
+
+}

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

@@ -0,0 +1,57 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+import { PageSizeMode } from '../enum';
+/**
+ * Configures the paging behavior of the TreeGrid, enabling you to manage and display data efficiently across multiple pages.
+ */
+export declare class PageSettings extends ChildProperty<PageSettings> {
+    /**
+     * Specifies the number of records to display per page in the TreeGrid. Adjust this setting to control the volume of data presented on each page.
+     *
+     * @default 12
+     */
+    pageSize: number;
+    /**
+     * Determines the number of page numbers displayed in the TreeGrid pager container. This setting helps users navigate between different parts of the dataset.
+     *
+     * @default 8
+     */
+    pageCount: number;
+    /**
+     * Sets the current page number in the TreeGrid, defining which page of data is initially displayed to users.
+     *
+     * @default 1
+     */
+    currentPage: number;
+    /**
+     * @hidden
+     * Retrieves the total number of records in the TreeGrid. This property is primarily used internally by the TreeGrid component.
+     */
+    totalRecordsCount: number;
+    /**
+     * When set to true, appends the current page information as a query string to the remote service URL during page navigation within the TreeGrid.
+     *
+     * @default false
+     */
+    enableQueryString: boolean;
+    /**
+     * Enables a DropDownList in the TreeGrid pager, allowing users to select the page size. Accepts either a boolean to toggle this feature or an array of page size options.
+     *
+     * @default false
+     */
+    pageSizes: boolean | (number | string)[];
+    /**
+     * Provides a custom template for rendering pager elements in the TreeGrid, offering enhanced flexibility and control over the pager's appearance and functionality. Accepts a template string or the ID of an HTML element.
+     *
+     * @default null
+     * @aspType string
+     */
+    template: string | Function;
+    /**
+     * Specifies the mode for counting records on a page, determining whether all records are counted or only zeroth level parent records. The available options are:
+     * * `All`: Includes all records in the count.
+     * * `Root`: Includes only zeroth level parent records.
+     *
+     * @default All
+     */
+    pageSizeMode: PageSizeMode;
+}

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

@@ -0,0 +1,73 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+import { PageSizeMode } from '../enum';
+
+/**
+ * Configures the paging behavior of the TreeGrid, enabling you to manage and display data efficiently across multiple pages.
+ */
+export class PageSettings extends ChildProperty<PageSettings> {
+    /**
+     * Specifies the number of records to display per page in the TreeGrid. Adjust this setting to control the volume of data presented on each page.
+     *
+     * @default 12
+     */
+    @Property(12)
+    public pageSize: number;
+
+    /**
+     * Determines the number of page numbers displayed in the TreeGrid pager container. This setting helps users navigate between different parts of the dataset.
+     *
+     * @default 8
+     */
+    @Property(8)
+    public pageCount: number;
+
+    /**
+     * Sets the current page number in the TreeGrid, defining which page of data is initially displayed to users.
+     *
+     * @default 1
+     */
+    @Property(1)
+    public currentPage: number;
+
+    /**
+     * @hidden
+     * Retrieves the total number of records in the TreeGrid. This property is primarily used internally by the TreeGrid component.
+     */
+    @Property()
+    public totalRecordsCount: number;
+
+    /**
+     * When set to true, appends the current page information as a query string to the remote service URL during page navigation within the TreeGrid.
+     *
+     * @default false
+     */
+    @Property(false)
+    public enableQueryString: boolean;
+
+    /**
+     * Enables a DropDownList in the TreeGrid pager, allowing users to select the page size. Accepts either a boolean to toggle this feature or an array of page size options.
+     *
+     * @default false
+     */
+    @Property(false)
+    public pageSizes: boolean | (number | string)[];
+
+    /**
+     * Provides a custom template for rendering pager elements in the TreeGrid, offering enhanced flexibility and control over the pager's appearance and functionality. Accepts a template string or the ID of an HTML element.
+     *
+     * @default null
+     * @aspType string
+     */
+    @Property(null)
+    public template: string | Function;
+
+    /**
+     * Specifies the mode for counting records on a page, determining whether all records are counted or only zeroth level parent records. The available options are:
+     * * `All`: Includes all records in the count.
+     * * `Root`: Includes only zeroth level parent records.
+     *
+     * @default All
+     */
+    @Property('All')
+    public pageSizeMode: PageSizeMode;
+}

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

@@ -0,0 +1,15 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';import { ITreeData } from '..';
+
+/**
+ * Interface for a class RowDropSettings
+ */
+export interface RowDropSettingsModel {
+
+    /**
+     * Specifies the ID of the droppable component where rows can be dragged and dropped. Ensures that the row drop operation targets the correct component within the application.
+     *
+     * @default null
+     */
+    targetID?: string;
+
+}

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

@@ -0,0 +1,34 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+import { ITreeData } from '..';
+/**
+ * Configures the settings for row dragging and dropping within the TreeGrid, allowing for enhanced user interaction and data manipulation capabilities.
+ */
+export declare class RowDropSettings extends ChildProperty<RowDropSettings> {
+    /**
+     * Specifies the ID of the droppable component where rows can be dragged and dropped. Ensures that the row drop operation targets the correct component within the application.
+     *
+     * @default null
+     */
+    targetID: string;
+}
+/**
+ * Interface for TreeGrid row drop action event arguments, providing detailed information about the row drop operation and its related context.
+ */
+export interface TreeActionEventArgs {
+    /** Identifies the type of request made during the action. */
+    requestType?: string;
+    /** Contains the data of the row(s) involved in the action, either a single row or an array of rows. */
+    data?: ITreeData | ITreeData[];
+    /** Refers to the rows affected by the action. */
+    row?: Object[];
+    /** A boolean value indicating whether the action should be canceled. */
+    cancel?: boolean;
+    /** Describes the specific action being performed. */
+    action?: string;
+    /** Indicates the target index where the row(s) will be dropped. */
+    dropIndex?: number;
+    /** Specifies the position where the dragged record will be dropped relative to the target. */
+    dropPosition?: string;
+    /** Lists the records that have been modified as a result of the action. */
+    modifiedRecords?: ITreeData[];
+}

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

@@ -0,0 +1,37 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+import { ITreeData } from '..';
+
+/**
+ * Configures the settings for row dragging and dropping within the TreeGrid, allowing for enhanced user interaction and data manipulation capabilities.
+ */
+export class RowDropSettings extends ChildProperty<RowDropSettings> {
+    /**
+     * Specifies the ID of the droppable component where rows can be dragged and dropped. Ensures that the row drop operation targets the correct component within the application.
+     *
+     * @default null
+     */
+    @Property()
+    public targetID: string;
+}
+
+/**
+ * Interface for TreeGrid row drop action event arguments, providing detailed information about the row drop operation and its related context.
+ */
+export interface TreeActionEventArgs {
+    /** Identifies the type of request made during the action. */
+    requestType?: string;
+    /** Contains the data of the row(s) involved in the action, either a single row or an array of rows. */
+    data?: ITreeData | ITreeData[];
+    /** Refers to the rows affected by the action. */
+    row?: Object[];
+    /** A boolean value indicating whether the action should be canceled. */
+    cancel?: boolean;
+    /** Describes the specific action being performed. */
+    action?: string;
+    /** Indicates the target index where the row(s) will be dropped. */
+    dropIndex?: number;
+    /** Specifies the position where the dragged record will be dropped relative to the target. */
+    dropPosition?: string;
+    /** Lists the records that have been modified as a result of the action. */
+    modifiedRecords?: ITreeData[];
+}

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

@@ -0,0 +1,79 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';import { FilterHierarchyMode } from '../enum';
+
+/**
+ * Interface for a class SearchSettings
+ */
+export interface SearchSettingsModel {
+
+    /**
+     * Specifies the columns to be searched upon the initial rendering of the TreeGrid.
+     * You can also retrieve the list of columns that are currently searched.
+     *
+     * @default []
+     */
+    fields?: string[];
+
+    /**
+     * When set to true, the search operation ignores case sensitivity,
+     * including diacritic characters or accents while filtering.
+     *
+     * > Check the [`Diacritics`](../../treegrid/filtering/filtering#diacritics) filtering.
+     *
+     * @default false
+     */
+    ignoreCase?: boolean;
+
+    /**
+     * Defines the operator to search records. The available operators are:
+     * <table>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * Operator<br/></td><td colspan=1 rowspan=1>
+     * Description<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * startswith<br/></td><td colspan=1 rowspan=1>
+     * Checks whether the string begins with the specified string.<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * endswith<br/></td><td colspan=1 rowspan=1>
+     * Checks whether the string ends with the specified string.<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * contains<br/></td><td colspan=1 rowspan=1>
+     * Checks whether the string contains the specified string. <br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * equal<br/></td><td colspan=1 rowspan=1>
+     * Checks whether the string is equal to the specified string.<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * notequal<br/></td><td colspan=1 rowspan=1>
+     * Checks for strings not equal to the specified string. <br/></td></tr>
+     * </table>
+     *
+     * @default 'contains'
+     */
+    operator?: string;
+
+    /**
+     * A keyword used for searching within the TreeGrid content.
+     *
+     */
+    key?: string;
+
+    /**
+     * Defines the search hierarchy modes dictating which parts of the tree should be included in search results.
+     * The available options are:
+     * * `Parent`: Shows the searched record along with its parent record.
+     * * `Child`: Shows the searched record along with its child record.
+     * * `Both`: Shows the searched record with both its parent and child records.
+     * * `None`: Shows only the searched record.
+     *
+     * @default Parent
+     * @isEnumeration true
+     * @aspType FilterHierarchyMode
+     */
+    hierarchyMode?: FilterHierarchyMode;
+
+}

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

@@ -0,0 +1,73 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+import { FilterHierarchyMode } from '../enum';
+/**
+ * Configures the searching behavior of the TreeGrid.
+ */
+export declare class SearchSettings extends ChildProperty<SearchSettings> {
+    /**
+     * Specifies the columns to be searched upon the initial rendering of the TreeGrid.
+     * You can also retrieve the list of columns that are currently searched.
+     *
+     * @default []
+     */
+    fields: string[];
+    /**
+     * When set to true, the search operation ignores case sensitivity,
+     * including diacritic characters or accents while filtering.
+     *
+     * > Check the [`Diacritics`](../../treegrid/filtering/filtering#diacritics) filtering.
+     *
+     * @default false
+     */
+    ignoreCase: boolean;
+    /**
+     * Defines the operator to search records. The available operators are:
+     * <table>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * Operator<br/></td><td colspan=1 rowspan=1>
+     * Description<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * startswith<br/></td><td colspan=1 rowspan=1>
+     * Checks whether the string begins with the specified string.<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * endswith<br/></td><td colspan=1 rowspan=1>
+     * Checks whether the string ends with the specified string.<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * contains<br/></td><td colspan=1 rowspan=1>
+     * Checks whether the string contains the specified string. <br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * equal<br/></td><td colspan=1 rowspan=1>
+     * Checks whether the string is equal to the specified string.<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * notequal<br/></td><td colspan=1 rowspan=1>
+     * Checks for strings not equal to the specified string. <br/></td></tr>
+     * </table>
+     *
+     * @default 'contains'
+     */
+    operator: string;
+    /**
+     * A keyword used for searching within the TreeGrid content.
+     *
+     */
+    key: string;
+    /**
+     * Defines the search hierarchy modes dictating which parts of the tree should be included in search results.
+     * The available options are:
+     * * `Parent`: Shows the searched record along with its parent record.
+     * * `Child`: Shows the searched record along with its child record.
+     * * `Both`: Shows the searched record with both its parent and child records.
+     * * `None`: Shows only the searched record.
+     *
+     * @default Parent
+     * @isEnumeration true
+     * @aspType FilterHierarchyMode
+     */
+    hierarchyMode: FilterHierarchyMode;
+}

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

@@ -0,0 +1,83 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+import { FilterHierarchyMode } from '../enum';
+
+/**
+ * Configures the searching behavior of the TreeGrid.
+ */
+export class SearchSettings extends ChildProperty<SearchSettings> {
+    /**
+     * Specifies the columns to be searched upon the initial rendering of the TreeGrid.
+     * You can also retrieve the list of columns that are currently searched.
+     *
+     * @default []
+     */
+    @Property()
+    public fields: string[];
+
+    /**
+     * When set to true, the search operation ignores case sensitivity,
+     * including diacritic characters or accents while filtering.
+     *
+     * > Check the [`Diacritics`](../../treegrid/filtering/filtering#diacritics) filtering.
+     *
+     * @default false
+     */
+    @Property(false)
+    public ignoreCase: boolean;
+
+    /**
+     * Defines the operator to search records. The available operators are:
+     * <table>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * Operator<br/></td><td colspan=1 rowspan=1>
+     * Description<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * startswith<br/></td><td colspan=1 rowspan=1>
+     * Checks whether the string begins with the specified string.<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * endswith<br/></td><td colspan=1 rowspan=1>
+     * Checks whether the string ends with the specified string.<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * contains<br/></td><td colspan=1 rowspan=1>
+     * Checks whether the string contains the specified string. <br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * equal<br/></td><td colspan=1 rowspan=1>
+     * Checks whether the string is equal to the specified string.<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * notequal<br/></td><td colspan=1 rowspan=1>
+     * Checks for strings not equal to the specified string. <br/></td></tr>
+     * </table>
+     *
+     * @default 'contains'
+     */
+    @Property('contains')
+    public operator: string;
+
+    /**
+     * A keyword used for searching within the TreeGrid content.
+     *
+     */
+    @Property()
+    public key: string;
+
+    /**
+     * Defines the search hierarchy modes dictating which parts of the tree should be included in search results.
+     * The available options are:
+     * * `Parent`: Shows the searched record along with its parent record.
+     * * `Child`: Shows the searched record along with its child record.
+     * * `Both`: Shows the searched record with both its parent and child records.
+     * * `None`: Shows only the searched record.
+     *
+     * @default Parent
+     * @isEnumeration true
+     * @aspType FilterHierarchyMode
+     */
+    @Property()
+    public hierarchyMode: FilterHierarchyMode;
+}

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

@@ -0,0 +1,76 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';import { SelectionMode, CellSelectionMode, SelectionType, CheckboxSelectionType } from '@syncfusion/ej2-grids';
+
+/**
+ * Interface for a class SelectionSettings
+ */
+export interface SelectionSettingsModel {
+
+    /**
+     * 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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    checkboxOnly?: boolean;
+
+    /**
+     * Enables toggling of the selected row. When true, users can toggle the selection of a row.
+     *
+     * @default true
+     */
+    enableToggle?: boolean;
+
+}

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

@@ -0,0 +1,68 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+import { SelectionMode, CellSelectionMode, SelectionType, CheckboxSelectionType } from '@syncfusion/ej2-grids';
+/**
+ * Configures the selection behavior of the TreeGrid.
+ */
+export declare 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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    checkboxOnly: boolean;
+    /**
+     * Enables toggling of the selected row. When true, users can toggle the selection of a row.
+     *
+     * @default true
+     */
+    enableToggle: boolean;
+}