@syncfusion/ej2-treegrid 25.2.6 → 26.1.35-469198

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

@@ -1,90 +0,0 @@
-import { ChildProperty } from '@syncfusion/ej2-base';
-import { EditMode, RowPosition } from '../enum';
-import { IDialogUI } from '@syncfusion/ej2-grids';
-/**
- * Configures the edit behavior of the TreeGrid.
- */
-export declare class EditSettings extends ChildProperty<EditSettings> {
-    /**
-     * If `allowAdding` is set to true, new records can be added to the TreeGrid.
-     *
-     * @default false
-     */
-    allowAdding: boolean;
-    /**
-     * If `allowEditing` is set to true, values can be updated in the existing record.
-     *
-     * @default false
-     */
-    allowEditing: boolean;
-    /**
-     * If `allowDeleting` is set to true, existing record can be deleted from the TreeGrid.
-     *
-     * @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.
-     * ```
-     *
-     * @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 %}
-     *
-     * @default Top
-     */
-    newRowPosition: RowPosition;
-    /**
-     * If `allowEditOnDblClick` is set to false, TreeGrid will not allow editing of a record on double click.
-     *
-     * @default true
-     */
-    allowEditOnDblClick: boolean;
-    /**
-     * if `showConfirmDialog` is set to false, confirm dialog does not show when batch changes are saved or discarded.
-     *
-     * @default true
-     */
-    showConfirmDialog: boolean;
-    /**
-     * If `showDeleteConfirmDialog` is set to true, confirm dialog will show delete action. You can also cancel delete command.
-     *
-     * @default false
-     */
-    showDeleteConfirmDialog: boolean;
-    /**
-     * Defines the custom edit elements for the dialog template.
-     *
-     * @default ''
-     * @aspType string
-     */
-    template: string | Function;
-    /**
-     * Defines the dialog params to edit.
-     *
-     * @default {}
-     */
-    dialog: IDialogUI;
-    /**
-     * If `allowNextRowEdit` is set as true, editing is continued to next row with keyboard navigation.
-     *
-     * @default false
-     */
-    allowNextRowEdit: boolean;
-}

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

@@ -1,203 +0,0 @@
-import { ChildProperty } from '@syncfusion/ej2-base';
-import { ICustomOptr, FilterBarMode, FilterType } from '@syncfusion/ej2-grids';
-import { FilterHierarchyMode } from '../enum';
-import { PredicateModel } from './filter-settings-model';
-/**
- * Represents the Tree Grid predicate for the filter column.
- */
-export declare class Predicate extends ChildProperty<Predicate> {
-    /**
-     * Defines the field name of the filter column in Tree Grid.
-     *
-     * @default ''
-     */
-    field: string;
-    /**
-     * Defines the operator to filter Tree Grid records. The available operators and its supported data types are:
-     * <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>
-     * <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>
-     * 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>
-     * <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>
-     * <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>
-     * <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>
-     * <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>
-     * 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>
-     * <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>
-     * <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>
-     * <br/>Number | Date<br/></td></tr>
-     * </table>
-     *
-     * @default null
-     */
-    operator: string;
-    /**
-     * Defines the value used to filter records in Tree Grid.
-     *
-     * @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.
-     *
-     * @default null
-     */
-    matchCase: boolean;
-    /**
-     * If ignoreAccent is set to true, then filter ignores the diacritic characters or accents while filtering in Tree Grid.
-     *
-     * @default false
-     */
-    ignoreAccent: boolean;
-    /**
-     * Defines relationship between one filter query and another by using AND or OR predicate.
-     *
-     * @default null
-     */
-    predicate: string;
-    /**
-     * @hidden
-     * Defines the actual filter value for the filter column in Tree Grid.
-     */
-    actualFilterValue: Object;
-    /**
-     * @hidden
-     * Defines the actual filter operator for the filter column in Tree Grid.
-     */
-    actualOperator: Object;
-    /**
-     * @hidden
-     * Defines the type of the filter column in Tree Grid.
-     */
-    type: string;
-    /**
-     * @hidden
-     * Defines the predicate of filter column in Tree Grid.
-     */
-    ejpredicate: Object;
-    /**
-     * @hidden
-     * Defines the UID of filter column.
-     */
-    uid: string;
-    /**
-     * @hidden
-     * Defines the foreignKey availability in filtered columns.
-     */
-    isForeignKey: boolean;
-}
-/**
- * Configures the filtering behavior of the TreeGrid.
- */
-export declare class FilterSettings extends ChildProperty<FilterSettings> {
-    /**
-     * Specifies the columns to be filtered at initial rendering of the TreeGrid. You can also get the columns that were currently filtered.
-     *
-     * @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.
-     *
-     * @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.
-     * ```
-     *
-     * @default Syncfusion.EJ2.Grids.FilterBarMode.OnEnter
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.FilterBarMode
-     */
-    mode: FilterBarMode;
-    /**
-     * Shows or hides the filtered status message 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.
-     *
-     * @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.
-     *
-     * @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.
-     *
-     * @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 %}
-     *
-     * @default Parent
-     * @isEnumeration true
-     * @aspType FilterHierarchyMode
-     */
-    hierarchyMode: FilterHierarchyMode;
-}

package/src/treegrid/models/index.d.ts

@@ -1,24 +0,0 @@
-/**
- * Models export
- */
-export * from './column';
-export * from './edit-settings';
-export * from './edit-settings-model';
-export * from './filter-settings';
-export * from './filter-settings-model';
-export * from './page-settings';
-export * from './page-settings-model';
-export * from './search-settings';
-export * from './search-settings-model';
-export * from './selection-settings';
-export * from './selection-settings-model';
-export * from './summary';
-export * from './summary-model';
-export * from './sort-settings';
-export * from './sort-settings-model';
-export * from './rowdrop-settings';
-export * from './rowdrop-settings-model';
-export * from './infinite-scroll-settings';
-export * from './infinite-scroll-settings-model';
-export * from './loading-indicator';
-export * from './loading-indicator-model';

package/src/treegrid/models/infinite-scroll-settings.d.ts

@@ -1,25 +0,0 @@
-import { ChildProperty } from '@syncfusion/ej2-base';
-import { InfiniteScrollSettings as GridInfiniteScrollSettings } from '@syncfusion/ej2-grids';
-/**
- * Configures the infinite scroll behavior of Tree Grid.
- */
-export declare class InfiniteScrollSettings extends ChildProperty<GridInfiniteScrollSettings> {
-    /**
-     * If `enableCache` is set to true, the Tree Grid will cache the loaded data to be reused next time it is needed.
-     *
-     * @default false
-     */
-    enableCache: boolean;
-    /**
-     * Defines the number of blocks to be maintained in Tree Grid while settings enableCache as true.
-     *
-     * @default 3
-     */
-    maxBlocks: number;
-    /**
-     * Defines the number of blocks will render at the initial Tree Grid rendering while enableCache is enabled.
-     *
-     * @default 3
-     */
-    initialBlocks: number;
-}

package/src/treegrid/models/loading-indicator.d.ts

@@ -1,19 +0,0 @@
-import { ChildProperty } from '@syncfusion/ej2-base';
-import { IndicatorType } from '@syncfusion/ej2-grids';
-/**
- * Configures the Loading Indicator of the Tree Grid.
- */
-export declare class LoadingIndicator extends ChildProperty<LoadingIndicator> {
-    /**
-     * Defines the loading indicator. The available loading indicator are:
-     * ```props
-     * * Spinner :- Defines Loading Indicator as Spinner.
-     * * Shimmer :- Defines Loading Indicator as Shimmer.
-     * ```
-     *
-     * @default Syncfusion.EJ2.Grids.IndicatorType.Spinner
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.IndicatorType
-     */
-    indicatorType: IndicatorType;
-}

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

@@ -1,60 +0,0 @@
-import { ChildProperty } from '@syncfusion/ej2-base';
-import { PageSizeMode } from '../enum';
-/**
- * Configures the paging behavior of the TreeGrid.
- */
-export declare class PageSettings extends ChildProperty<PageSettings> {
-    /**
-     * Defines the number of records to be displayed in TreeGrid per page.
-     *
-     * @default 12
-     */
-    pageSize: number;
-    /**
-     * Defines the number of pages to be displayed in the TreeGrid pager container.
-     *
-     * @default 8
-     */
-    pageCount: number;
-    /**
-     * Defines the current page number of the pager in TreeGrid.
-     *
-     * @default 1
-     */
-    currentPage: number;
-    /**
-     * @hidden
-     * Gets the total records count of the TreeGrid.
-     */
-    totalRecordsCount: number;
-    /**
-     * If `enableQueryString` set to true,
-     * then it pass current page information as a query string along with the URL while navigating to other page in TreeGrid.
-     *
-     * @default false
-     */
-    enableQueryString: boolean;
-    /**
-     * If `pageSizes` set to true or Array of values,
-     * It renders DropDownList in the pager of TreeGrid which allow us to select pageSize from DropDownList.
-     *
-     * @default false
-     */
-    pageSizes: boolean | (number | string)[];
-    /**
-     * Defines the template which renders customized elements in pager of TreeGrid instead of default elements.
-     * It accepts either [template string](https://ej2.syncfusion.com/documentation/common/template-engine/) or HTML element ID.
-     *
-     * @default null
-     * @aspType string
-     */
-    template: string | Function;
-    /**
-     * Specifies the mode of record count in a page. The options are,
-     * * `All`: Count all the records.
-     * * `Root`: Count only zeroth level parent records.
-     *
-     * @default All
-     */
-    pageSizeMode: PageSizeMode;
-}

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

@@ -1,27 +0,0 @@
-import { ChildProperty } from '@syncfusion/ej2-base';
-import { ITreeData } from '..';
-/**
- * Configures the row drop settings of the TreeGrid.
- */
-export declare class RowDropSettings extends ChildProperty<RowDropSettings> {
-    /**
-     * Defines the ID of droppable component on which row drop should occur.
-     *
-     * @default null
-     */
-    targetID: string;
-}
-export interface TreeActionEventArgs {
-    requestType?: string;
-    data?: ITreeData | ITreeData[];
-    row?: Object[];
-    cancel?: boolean;
-    /** Defines the corresponding action */
-    action?: string;
-    /** Defines the target element from index. */
-    dropIndex?: number;
-    /** Defines drop position of the dragged record */
-    dropPosition?: string;
-    /** Defines the modified records. */
-    modifiedRecords?: ITreeData[];
-}

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

@@ -1,71 +0,0 @@
-import { ChildProperty } from '@syncfusion/ej2-base';
-import { FilterHierarchyMode } from '../enum';
-/**
- * Configures the filtering behavior of the TreeGrid.
- */
-export declare class SearchSettings extends ChildProperty<SearchSettings> {
-    /**
-     * Specifies the columns to be searched at initial rendering of the TreeGrid. You can also get the columns that were currently filtered.
-     *
-     * @default []
-     */
-    fields: string[];
-    /**
-     * If ignoreCase set to true, then search ignores the diacritic characters or accents while filtering.
-     *
-     * > Check the [`Diacritics`](../../treegrid/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 key word for searching the TreeGrid content.
-     */
-    key: string;
-    /**
-     *  Defines the search hierarchy modes. The available options are,
-     * ```props
-     * * Parent :- Shows the searched record with parent record.
-     * * Child :- Shows the searched record with child record.
-     * * Both :- shows the searched record with both parent and child record.
-     * * None :- Shows only the searched record.
-     * ```
-     *
-     * @default Parent
-     * @isEnumeration true
-     * @aspType FilterHierarchyMode
-     */
-    hierarchyMode: FilterHierarchyMode;
-}

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

@@ -1,79 +0,0 @@
-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> {
-    /**
-     * TreeGrid supports row, cell, and both (row and cell) selection mode.
-     * ```props
-     * * Row :- Selects the entire row.
-     * * Cell :- Selects the cell alone.
-     * * Both :- Selects the entire row and its cell.
-     * ```
-     *
-     * @default Syncfusion.EJ2.Grids.SelectionMode.Row
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.SelectionMode
-     */
-    mode: SelectionMode;
-    /**
-     * The cell selection modes are flow and box. It requires the selection
-     * [`mode`](#mode) to be either cell or both.
-     * ```props
-     * * Flow :- Selects the range of cells between start index and end index that also includes the other cells of the selected rows.
-     * * Box :- Selects the range of cells within the start and end column indexes that includes in between cells of rows within the range.
-     * ```
-     *
-     * @default Syncfusion.EJ2.Grids.CellSelectionMode.Flow
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.CellSelectionMode
-     */
-    cellSelectionMode: CellSelectionMode;
-    /**
-     * Defines options for selection type. They are
-     * ```props
-     * * Single :- Allows selection of only a row or a cell.
-     * * Multiple :- Allows selection of multiple rows or cells.
-     * ```
-     *
-     * @default Syncfusion.EJ2.Grids.SelectionType.Single
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.SelectionType
-     */
-    type: SelectionType;
-    /**
-     * If 'persistSelection' set to true, then the TreeGrid selection is persisted on all operations.
-     * For persisting selection in the TreeGrid, any one of the column should be enabled as a primary key.
-     *
-     * @default false
-     */
-    persistSelection: boolean;
-    /**
-     * Defines options for checkbox selection Mode. They are
-     * ```props
-     * * Default :- This is the default value of the checkboxMode. In this mode, user can select multiple rows by clicking rows one by one.
-     * * ResetOnRowClick :- In ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple.
-     * ```
-     *  rows can be selected by using CTRL or SHIFT key.
-     *
-     * @default Syncfusion.EJ2.Grids.CheckboxSelectionType.Default
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.CheckboxSelectionType
-     */
-    checkboxMode: CheckboxSelectionType;
-    /**
-     * If 'checkboxOnly' set to true, then the TreeGrid selection is allowed only through checkbox.
-     *
-     * > To enable checkboxOnly selection, should specify the column type as `checkbox`.
-     *
-     * @default false
-     */
-    checkboxOnly: boolean;
-    /**
-     * If ‘enableToggle’ set to true, then the user can able to perform toggle for the selected row.
-     *
-     * @default true
-     */
-    enableToggle: boolean;
-}

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

@@ -1,40 +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 sort column.
- */
-export declare class SortDescriptor extends ChildProperty<SortDescriptor> {
-    /**
-     * Defines the field name of sort column.
-     *
-     * @default ''
-     */
-    field: string;
-    /**
-     * Defines the direction of sort column.
-     *
-     * @default ''
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.SortDirection
-     */
-    direction: SortDirection;
-}
-/**
- * Configures the sorting behavior of TreeGrid.
- */
-export declare class SortSettings extends ChildProperty<SortSettings> {
-    /**
-     * Specifies the columns to sort at initial rendering of TreeGrid.
-     * Also user can get current sorted columns.
-     *
-     * @default []
-     */
-    columns: SortDescriptorModel[];
-    /**
-     * If `allowUnsort` set to false the user can not get the TreeGrid in unsorted state by clicking the sorted column header.
-     *
-     * @default true
-     */
-    allowUnsort: boolean;
-}