@syncfusion/ej2-treegrid 30.1.38 → 31.1.17

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

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

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

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

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

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

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

@@ -0,0 +1,216 @@
+import { Collection, Property, ChildProperty } from '@syncfusion/ej2-base';import { ICustomOptr, FilterBarMode, FilterType } from '@syncfusion/ej2-grids';import { FilterHierarchyMode } from '../enum';
+
+/**
+ * Interface for a class Predicate
+ */
+export interface PredicateModel {
+
+    /**
+     * Specifies the field name of the column to apply the filter on.
+     *
+     * @default ''
+     */
+    field?: string;
+
+    /**
+     * Specifies the operator used for filtering TreeGrid records. The available operators support a variety of data types
+     * and offer different filtering mechanisms. Details for each operator are provided below:
+     * <table>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * Operator<br/></td><td colspan=1 rowspan=1>
+     * Description<br/></td><td colspan=1 rowspan=1>
+     * Supported Data Types<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * startswith<br/></td><td colspan=1 rowspan=1>
+     * Checks if the value starts with the specified input.<br/></td><td colspan=1 rowspan=1>
+     * String<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * endswith<br/></td><td colspan=1 rowspan=1>
+     * Checks if the value ends with the specified input.<br/><br/></td><td colspan=1 rowspan=1>
+     * <br/>String<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * contains<br/></td><td colspan=1 rowspan=1>
+     * Checks if the value contains the specified input anywhere within it.<br/><br/></td><td colspan=1 rowspan=1>
+     * <br/>String<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * equal<br/></td><td colspan=1 rowspan=1>
+     * Checks if the value is exactly equal to the specified input.<br/><br/></td><td colspan=1 rowspan=1>
+     * <br/>String | Number | Boolean | Date<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * notequal<br/></td><td colspan=1 rowspan=1>
+     * Identifies values that are not equal to the specified input.<br/><br/></td><td colspan=1 rowspan=1>
+     * <br/>String | Number | Boolean | Date<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * greaterthan<br/></td><td colspan=1 rowspan=1>
+     * Verifies if the value is greater than the specified input.<br/><br/></td><td colspan=1 rowspan=1>
+     * Number | Date<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * greaterthanorequal<br/></td><td colspan=1 rowspan=1>
+     * Verifies if the value is greater than or equal to the specified input.<br/><br/></td><td colspan=1 rowspan=1>
+     * <br/>Number | Date<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * lessthan<br/></td><td colspan=1 rowspan=1>
+     * Checks if the value is less than the specified input.<br/><br/></td><td colspan=1 rowspan=1>
+     * <br/>Number | Date<br/></td></tr>
+     * <tr>
+     * <td colspan=1 rowspan=1>
+     * lessthanorequal<br/></td><td colspan=1 rowspan=1>
+     * Checks if the value is less than or equal to the specified input.<br/><br/></td><td colspan=1 rowspan=1>
+     * <br/>Number | Date<br/></td></tr>
+     * </table>
+     *
+     * @default null
+     */
+    operator?: string;
+
+    /**
+     * Specifies the value to filter the column's data by.
+     *
+     * @default ''
+     */
+    value?: string | number | Date | boolean;
+
+    /**
+     * Applies case-sensitive filtering if set to `true`. When false, filtering is case-insensitive.
+     *
+     * @default null
+     */
+    matchCase?: boolean;
+
+    /**
+     * Ignores diacritic characters during filtering if set to `true`.
+     *
+     * @default false
+     */
+    ignoreAccent?: boolean;
+
+    /**
+     * Defines the logical relationship between multiple filter conditions ('AND' / 'OR').
+     *
+     * @default null
+     */
+    predicate?: string;
+
+    /**
+     * @hidden
+     * Holds the actual value used for filtering the column.
+     */
+    actualFilterValue?: Object;
+
+    /**
+     * @hidden
+     * Represents the actual filter operator applied to the column.
+     */
+    actualOperator?: Object;
+
+    /**
+     * @hidden
+     * Defines the data type of the filter column.
+     */
+    type?: string;
+
+    /**
+     * @hidden
+     * Represents the internal predicate condition for the filter column.
+     */
+    ejpredicate?: Object;
+
+    /**
+     * @hidden
+     * Unique identifier for the filter column.
+     */
+    uid?: string;
+
+    /**
+     * @hidden
+     * Indicates whether the column is a foreign key in the filter set.
+     */
+    isForeignKey?: boolean;
+
+}
+
+/**
+ * Interface for a class FilterSettings
+ */
+export interface FilterSettingsModel {
+
+    /**
+     * Specifies the initial filter configuration for TreeGrid columns or retrieves the current filter state.
+     *
+     * @default []
+     */
+    columns?: PredicateModel[];
+
+    /**
+     * Sets the filtering interface type. Options include:
+     * * `Menu`: Provides a menu for filtering options.
+     * * `FilterBar`: Allows direct input filtering in a bar at the top of each column.
+     * * `Excel` : Specifies the filter type as excel.
+     * * `CheckBox` : Specifies the filter type as check box.
+     *
+     * @default FilterBar
+     */
+    type?: FilterType;
+
+    /**
+     * Determines the mode of the filter bar operation. Options include:
+     * * `OnEnter`: Filtering is triggered upon pressing the Enter key.
+     * * `Immediate`: Filtering occurs after a short delay automatically.
+     *
+     * @default Syncfusion.EJ2.Grids.FilterBarMode.OnEnter
+     * @isEnumeration true
+     * @aspType Syncfusion.EJ2.Grids.FilterBarMode
+     */
+    mode?: FilterBarMode;
+
+    /**
+     * Shows or hides the status message related to filtering actions on the pager.
+     *
+     * @default true
+     */
+    showFilterBarStatus?: boolean;
+
+    /**
+     * Determines the delay in milliseconds before filtering is triggered in `Immediate` mode.
+     *
+     * @default 1500
+     */
+    immediateModeDelay?: number;
+
+    /**
+     * Allows customization of the default operators offered in the filter menu by defining custom operators for string, number, date, and boolean types.
+     *
+     * @default null
+     */
+    operators?: ICustomOptr;
+
+    /**
+     * If set to `true`, filtering ignores accent characters, making diacritic characters identical to their unaccented versions.
+     *
+     * @default false
+     */
+    ignoreAccent?: boolean;
+
+    /**
+     * Specifies how the hierarchy should be maintained during filtering:
+     * * `Parent`: Displays the filtered records along with their parent records.
+     * * `Child`: Displays the filtered records along with their child records.
+     * * `Both`: Displays the filtered records with both parent and child records.
+     * * `None`: Only displays the filtered records.
+     *
+     * @default Parent
+     * @isEnumeration true
+     * @aspType FilterHierarchyMode
+     */
+    hierarchyMode?: FilterHierarchyMode;
+
+}