@syncfusion/ej2-treegrid 30.1.38 → 31.1.17

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

@@ -0,0 +1,195 @@
+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 filter configuration for a column in the TreeGrid.
+ */
+export declare class Predicate extends ChildProperty<Predicate> {
+    /**
+     * 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;
+}
+/**
+ * Configures the filtering behavior of the TreeGrid, enabling complex data filtering capabilities.
+ */
+export declare class FilterSettings extends ChildProperty<FilterSettings> {
+    /**
+     * 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;
+}

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

@@ -0,0 +1,237 @@
+import { Collection, Property, 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 filter configuration for a column in the TreeGrid.
+ */
+export class Predicate extends ChildProperty<Predicate> {
+
+    /**
+     * Specifies the field name of the column to apply the filter on.
+     *
+     * @default ''
+     */
+    @Property()
+    public 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
+     */
+    @Property()
+    public operator: string;
+
+    /**
+     * Specifies the value to filter the column's data by.
+     *
+     * @default ''
+     */
+    @Property()
+    public value: string | number | Date | boolean;
+
+    /**
+     * Applies case-sensitive filtering if set to `true`. When false, filtering is case-insensitive.
+     *
+     * @default null
+     */
+    @Property()
+    public matchCase: boolean;
+
+    /**
+     * Ignores diacritic characters during filtering if set to `true`.
+     *
+     * @default false
+     */
+    @Property()
+    public ignoreAccent: boolean;
+
+    /**
+     * Defines the logical relationship between multiple filter conditions ('AND' / 'OR').
+     *
+     * @default null
+     */
+    @Property()
+    public predicate: string;
+
+    /**
+     * @hidden
+     * Holds the actual value used for filtering the column.
+     */
+    @Property({})
+    public actualFilterValue: Object;
+
+    /**
+     * @hidden
+     * Represents the actual filter operator applied to the column.
+     */
+    @Property({})
+    public actualOperator: Object;
+
+    /**
+     * @hidden
+     * Defines the data type of the filter column.
+     */
+    @Property()
+    public type: string;
+
+    /**
+     * @hidden
+     * Represents the internal predicate condition for the filter column.
+     */
+    @Property()
+    public ejpredicate: Object;
+
+    /**
+     * @hidden
+     * Unique identifier for the filter column.
+     */
+    @Property()
+    public uid: string;
+
+    /**
+     * @hidden
+     * Indicates whether the column is a foreign key in the filter set.
+     */
+    @Property()
+    public isForeignKey: boolean;
+}
+
+/**
+ * Configures the filtering behavior of the TreeGrid, enabling complex data filtering capabilities.
+ */
+export class FilterSettings extends ChildProperty<FilterSettings> {
+
+    /**
+     * Specifies the initial filter configuration for TreeGrid columns or retrieves the current filter state.
+     *
+     * @default []
+     */
+    @Collection<PredicateModel[]>([], Predicate)
+    public 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
+     */
+    @Property('FilterBar')
+    public 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
+     */
+    @Property()
+    public mode: FilterBarMode;
+
+    /**
+     * Shows or hides the status message related to filtering actions on the pager.
+     *
+     * @default true
+     */
+    @Property(true)
+    public showFilterBarStatus: boolean;
+
+    /**
+     * Determines the delay in milliseconds before filtering is triggered in `Immediate` mode.
+     *
+     * @default 1500
+     */
+    @Property(1500)
+    public 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
+     */
+    @Property()
+    public operators: ICustomOptr;
+
+    /**
+     * If set to `true`, filtering ignores accent characters, making diacritic characters identical to their unaccented versions.
+     *
+     * @default false
+     */
+    @Property(false)
+    public 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
+     */
+    @Property('Parent')
+    public hierarchyMode: FilterHierarchyMode;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * 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/dist/ts/treegrid/models/index.ts

@@ -0,0 +1,24 @@
+/**
+ * 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/dist/ts/treegrid/models/infinite-scroll-settings-model.d.ts

@@ -0,0 +1,29 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';import { InfiniteScrollSettings as GridInfiniteScrollSettings } from '@syncfusion/ej2-grids';
+
+/**
+ * Interface for a class InfiniteScrollSettings
+ */
+export interface InfiniteScrollSettingsModel {
+
+    /**
+     * If `enableCache` is set to true, the Tree Grid will cache the loaded data for reuse in future requests, improving performance.
+     *
+     * @default false
+     */
+    enableCache?: boolean;
+
+    /**
+     * Specifies the number of data blocks to maintain in the Tree Grid's cache when `enableCache` is true.
+     *
+     * @default 3
+     */
+    maxBlocks?: number;
+
+    /**
+     * Specifies the number of data blocks to render initially when the Tree Grid loads, if caching is enabled.
+     *
+     * @default 3
+     */
+    initialBlocks?: number;
+
+}

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

@@ -0,0 +1,25 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+import { InfiniteScrollSettings as GridInfiniteScrollSettings } from '@syncfusion/ej2-grids';
+/**
+ * Configures the infinite scroll behavior of the Tree Grid.
+ */
+export declare class InfiniteScrollSettings extends ChildProperty<GridInfiniteScrollSettings> {
+    /**
+     * If `enableCache` is set to true, the Tree Grid will cache the loaded data for reuse in future requests, improving performance.
+     *
+     * @default false
+     */
+    enableCache: boolean;
+    /**
+     * Specifies the number of data blocks to maintain in the Tree Grid's cache when `enableCache` is true.
+     *
+     * @default 3
+     */
+    maxBlocks: number;
+    /**
+     * Specifies the number of data blocks to render initially when the Tree Grid loads, if caching is enabled.
+     *
+     * @default 3
+     */
+    initialBlocks: number;
+}

package/dist/ts/treegrid/models/infinite-scroll-settings.ts

@@ -0,0 +1,31 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+import { InfiniteScrollSettings as GridInfiniteScrollSettings } from '@syncfusion/ej2-grids';
+
+/**
+ * Configures the infinite scroll behavior of the Tree Grid.
+ */
+export class InfiniteScrollSettings extends ChildProperty<GridInfiniteScrollSettings> {
+    /**
+     * If `enableCache` is set to true, the Tree Grid will cache the loaded data for reuse in future requests, improving performance.
+     *
+     * @default false
+     */
+    @Property(false)
+    public enableCache: boolean;
+
+    /**
+     * Specifies the number of data blocks to maintain in the Tree Grid's cache when `enableCache` is true.
+     *
+     * @default 3
+     */
+    @Property(3)
+    public maxBlocks: number;
+
+    /**
+     * Specifies the number of data blocks to render initially when the Tree Grid loads, if caching is enabled.
+     *
+     * @default 3
+     */
+    @Property(3)
+    public initialBlocks: number;
+}

package/dist/ts/treegrid/models/loading-indicator-model.d.ts

@@ -0,0 +1,21 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+
+/**
+ * Interface for a class LoadingIndicator
+ */
+export interface LoadingIndicatorModel {
+
+    /**
+     * Specifies the type of loading indicator to be displayed. You can choose between:
+     * ```props
+     * * `Spinner`: Displays a spinning loader to indicate ongoing loading.
+     * * `Shimmer`: Displays a shimmer effect that suggests content is loading.
+     * ```
+     *
+     * @default Syncfusion.EJ2.Grids.IndicatorType.Spinner
+     * @isEnumeration true
+     * @aspType Syncfusion.EJ2.Grids.IndicatorType
+     */
+    indicatorType?: IndicatorType;
+
+}

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

@@ -0,0 +1,19 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+import { IndicatorType } from '@syncfusion/ej2-grids';
+/**
+ * Configures the loading indicator for the Tree Grid, allowing you to display a visual indicator during data loading operations to enhance user experience.
+ */
+export declare class LoadingIndicator extends ChildProperty<LoadingIndicator> {
+    /**
+     * Specifies the type of loading indicator to be displayed. You can choose between:
+     * ```props
+     * * `Spinner`: Displays a spinning loader to indicate ongoing loading.
+     * * `Shimmer`: Displays a shimmer effect that suggests content is loading.
+     * ```
+     *
+     * @default Syncfusion.EJ2.Grids.IndicatorType.Spinner
+     * @isEnumeration true
+     * @aspType Syncfusion.EJ2.Grids.IndicatorType
+     */
+    indicatorType: IndicatorType;
+}

package/dist/ts/treegrid/models/loading-indicator.ts

@@ -0,0 +1,21 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+import { IndicatorType } from '@syncfusion/ej2-grids';
+
+/**
+ * Configures the loading indicator for the Tree Grid, allowing you to display a visual indicator during data loading operations to enhance user experience.
+ */
+export class LoadingIndicator extends ChildProperty<LoadingIndicator> {
+    /**
+     * Specifies the type of loading indicator to be displayed. You can choose between:
+     * ```props
+     * * `Spinner`: Displays a spinning loader to indicate ongoing loading.
+     * * `Shimmer`: Displays a shimmer effect that suggests content is loading.
+     * ```
+     *
+     * @default Syncfusion.EJ2.Grids.IndicatorType.Spinner
+     * @isEnumeration true
+     * @aspType Syncfusion.EJ2.Grids.IndicatorType
+     */
+    @Property('Spinner')
+    public indicatorType: IndicatorType;
+}