@syncfusion/ej2-treegrid 30.2.4 → 31.1.17

package/dist/ts/treegrid/enum.d.ts

@@ -0,0 +1,152 @@
+/**
+ * Defines modes of Filter Hierarchy used in TreeGrids.
+ * The available modes are:
+ * * `Parent`: Shows filtered records along with their parent records.
+ * * `Child`: Shows filtered records along with their child records.
+ * * `Both`: Shows filtered records with both parent and child records.
+ * * `None`: Shows only the filtered records without any parent or child context.
+ */
+export declare type FilterHierarchyMode = 'Parent' | 'Child' | 'Both' | 'None';
+/**
+ * Defines predefined toolbar items for TreeGrids.
+ * The available toolbar items are:
+ * * `Add`: Add a new record.
+ * * `Edit`: Edit the selected record.
+ * * `Update`: Update the edited record.
+ * * `Delete`: Delete the selected record.
+ * * `Cancel`: Cancel the current edit operation.
+ * * `Search`: Search TreeGrid records by a given key.
+ * * `ExpandAll`: Expand all the rows in the TreeGrid.
+ * * `CollapseAll`: Collapse all the rows in the TreeGrid.
+ * * `ExcelExport`: Export the TreeGrid as an Excel document.
+ * * `PdfExport`: Export the TreeGrid as a PDF document.
+ * * `CsvExport`: Export the TreeGrid as a CSV document.
+ * * `Print`: Print the TreeGrid contents.
+ *
+ * @hidden
+ */
+export declare type ToolbarItems = 'Add' | 'Delete' | 'Update' | 'Cancel' | 'Edit' | 'Search' | 'ExpandAll' | 'CollapseAll' | 'ExcelExport' | 'PdfExport' | 'CsvExport' | 'Print';
+/**
+ * Defines enumerable toolbar items for programmatic access.
+ *
+ * @hidden
+ */
+export declare enum ToolbarItem {
+    Add = 0,
+    Edit = 1,
+    Update = 2,
+    Delete = 3,
+    Cancel = 4,
+    Search = 5,
+    ExpandAll = 6,
+    CollapseAll = 7,
+    ExcelExport = 8,
+    PdfExport = 9,
+    CsvExport = 10,
+    Print = 11,
+    RowIndent = 12,
+    RowOutdent = 13
+}
+/**
+ * Defines the available PageSizeMode options for pagination in a tree grid structure.
+ *
+ * The available page size modes are:
+ *
+ * * `All`: Considers all records, including both parent and child records, when calculating the number of records per page.
+ * * `Root`: Considers only root-level parent records, excluding child records, when calculating the number of records per page.
+ */
+export declare type PageSizeMode = 'All' | 'Root';
+/**
+ * Defines predefined context menu items for row and column interactions.
+ * The available context menu items are:
+ * * `AutoFitAll`: Automatically fit the size of all columns.
+ * * `AutoFit`: Automatically fit the size of the current column.
+ * * `SortAscending`: Sort the current column in ascending order.
+ * * `SortDescending`: Sort the current column in descending order.
+ * * `Edit`: Edit the current record.
+ * * `Delete`: Delete the current record.
+ * * `Save`: Save the edited state.
+ * * `Cancel`: Cancel the current edit operation.
+ * * `PdfExport`: Export the TreeGrid as a PDF format.
+ * * `ExcelExport`: Export the TreeGrid as an Excel format.
+ * * `CsvExport`: Export the TreeGrid as a CSV format.
+ * * `FirstPage`: Navigate to the first page.
+ * * `PrevPage`: Navigate to the previous page.
+ * * `LastPage`: Navigate to the last page.
+ * * `NextPage`: Navigate to the next page.
+ * * `AddRow`: Add a new row.
+ * * `Indent`: Indent the selected rows.
+ * * `Outdent`: Outdent the selected rows.
+ *
+ * @hidden
+ */
+export declare type ContextMenuItem = 'AutoFitAll' | 'AutoFit' | 'SortAscending' | 'SortDescending' | 'Edit' | 'Delete' | 'Save' | 'Cancel' | 'PdfExport' | 'ExcelExport' | 'CsvExport' | 'FirstPage' | 'PrevPage' | 'LastPage' | 'NextPage' | 'AddRow' | 'Indent' | 'Outdent';
+/**
+ * Enumerates detailed context menu items used for menu configurations.
+ *
+ * @hidden
+ */
+export declare enum ContextMenuItems {
+    AutoFit = 0,
+    AutoFitAll = 1,
+    SortAscending = 2,
+    SortDescending = 3,
+    Edit = 4,
+    Delete = 5,
+    Save = 6,
+    Cancel = 7,
+    PdfExport = 8,
+    ExcelExport = 9,
+    CsvExport = 10,
+    FirstPage = 11,
+    PrevPage = 12,
+    LastPage = 13,
+    NextPage = 14,
+    AddRow = 15,
+    RowIndent = 16,
+    RowOutdent = 17
+}
+/**
+ * Defines modes of editing supported by TreeGrids.
+ * The available editing modes are:
+ * * `Cell`: Enables cell editing mode.
+ * * `Row`: Enables row editing mode.
+ * * `Dialog`: Opens a dialog for editing.
+ * * `Batch`: Allows for batch editing of multiple records.
+ */
+export declare type EditMode = 'Cell' | 'Row' | 'Dialog' | 'Batch';
+/**
+ * Defines the target position for adding new rows in the TreeGrid.
+ * The available positions are:
+ * * `Top`: Adds a new row at the top of all rows.
+ * * `Bottom`: Adds a new row at the bottom of all rows.
+ * * `Above`: Adds a new row above the currently selected row.
+ * * `Below`: Adds a new row below the currently selected row.
+ * * `Child`: Adds a new row as a child to the currently selected row.
+ */
+export declare type RowPosition = 'Top' | 'Bottom' | 'Above' | 'Below' | 'Child';
+/**
+ * Defines types of filters available in TreeGrids.
+ * The available filter types are:
+ * * `Menu`: Applies a dialog-based filtering option, where users can select operators such as 'equals', 'contains', etc., and enter filter values for more granular control.
+ * * `Excel`: Provides Excel-like filtering capabilities.
+ * * `FilterBar`: Uses a filter bar at the top of each column.
+ */
+export declare type FilterType = 'FilterBar' | 'Excel' | 'Menu';
+/**
+ * Defines wrapping modes for column content in TreeGrids.
+ * The available wrap modes are:
+ * * `Both`: Wraps both header and content.
+ * * `Header`: Wraps only the header.
+ * * `Content`: Wraps only the content.
+ */
+export declare type WrapMode = 'Both' | 'Header' | 'Content';
+/**
+ * Defines the types of CopyHierarchyMode for grid data.
+ * The available copy hierarchy types are:
+ * * `Parent`: Copies data maintaining only parent hierarchy.
+ * * `Child`: Copies data with child hierarchy.
+ * * `Both`: Maintains both parent and child hierarchy during copy.
+ * * `None`: Copies data without any hierarchy structure.
+ */
+export declare type CopyHierarchyType = 'Parent' | 'Child' | 'Both' | 'None';

package/dist/ts/treegrid/enum.ts

@@ -0,0 +1,217 @@
+/**
+ * Defines modes of Filter Hierarchy used in TreeGrids.
+ * The available modes are:
+ * * `Parent`: Shows filtered records along with their parent records.
+ * * `Child`: Shows filtered records along with their child records.
+ * * `Both`: Shows filtered records with both parent and child records.
+ * * `None`: Shows only the filtered records without any parent or child context.
+ */
+export type FilterHierarchyMode =
+      'Parent' |
+      'Child' |
+      'Both' |
+      'None';
+
+/**
+ * Defines predefined toolbar items for TreeGrids.
+ * The available toolbar items are:
+ * * `Add`: Add a new record.
+ * * `Edit`: Edit the selected record.
+ * * `Update`: Update the edited record.
+ * * `Delete`: Delete the selected record.
+ * * `Cancel`: Cancel the current edit operation.
+ * * `Search`: Search TreeGrid records by a given key.
+ * * `ExpandAll`: Expand all the rows in the TreeGrid.
+ * * `CollapseAll`: Collapse all the rows in the TreeGrid.
+ * * `ExcelExport`: Export the TreeGrid as an Excel document.
+ * * `PdfExport`: Export the TreeGrid as a PDF document.
+ * * `CsvExport`: Export the TreeGrid as a CSV document.
+ * * `Print`: Print the TreeGrid contents.
+ *
+ * @hidden
+ */
+export type ToolbarItems =
+    'Add' |
+    'Delete' |
+    'Update' |
+    'Cancel' |
+    'Edit' |
+    'Search' |
+    'ExpandAll' |
+    'CollapseAll' |
+    'ExcelExport' |
+    'PdfExport' |
+    'CsvExport' |
+    'Print';
+
+/**
+ * Defines enumerable toolbar items for programmatic access.
+ *
+ * @hidden
+ */
+export enum ToolbarItem {
+    Add,
+    Edit,
+    Update,
+    Delete,
+    Cancel,
+    Search,
+    ExpandAll,
+    CollapseAll,
+    ExcelExport,
+    PdfExport,
+    CsvExport,
+    Print,
+    RowIndent,
+    RowOutdent
+}
+
+/**
+ * Defines the available PageSizeMode options for pagination in a tree grid structure.
+ *
+ * The available page size modes are:
+ *
+ * * `All`: Considers all records, including both parent and child records, when calculating the number of records per page.
+ * * `Root`: Considers only root-level parent records, excluding child records, when calculating the number of records per page.
+ */
+export type PageSizeMode =
+    'All' |
+    'Root';
+
+/**
+ * Defines predefined context menu items for row and column interactions.
+ * The available context menu items are:
+ * * `AutoFitAll`: Automatically fit the size of all columns.
+ * * `AutoFit`: Automatically fit the size of the current column.
+ * * `SortAscending`: Sort the current column in ascending order.
+ * * `SortDescending`: Sort the current column in descending order.
+ * * `Edit`: Edit the current record.
+ * * `Delete`: Delete the current record.
+ * * `Save`: Save the edited state.
+ * * `Cancel`: Cancel the current edit operation.
+ * * `PdfExport`: Export the TreeGrid as a PDF format.
+ * * `ExcelExport`: Export the TreeGrid as an Excel format.
+ * * `CsvExport`: Export the TreeGrid as a CSV format.
+ * * `FirstPage`: Navigate to the first page.
+ * * `PrevPage`: Navigate to the previous page.
+ * * `LastPage`: Navigate to the last page.
+ * * `NextPage`: Navigate to the next page.
+ * * `AddRow`: Add a new row.
+ * * `Indent`: Indent the selected rows.
+ * * `Outdent`: Outdent the selected rows.
+ *
+ * @hidden
+ */
+export type ContextMenuItem =
+    'AutoFitAll' |
+    'AutoFit' |
+    'SortAscending' |
+    'SortDescending' |
+    'Edit' |
+    'Delete' |
+    'Save' |
+    'Cancel' |
+    'PdfExport' |
+    'ExcelExport' |
+    'CsvExport' |
+    'FirstPage' |
+    'PrevPage' |
+    'LastPage' |
+    'NextPage' |
+    'AddRow' |
+    'Indent' |
+    'Outdent';
+
+/**
+ * Enumerates detailed context menu items used for menu configurations.
+ *
+ * @hidden
+ */
+export enum ContextMenuItems {
+    AutoFit,
+    AutoFitAll,
+    SortAscending,
+    SortDescending,
+    Edit,
+    Delete,
+    Save,
+    Cancel,
+    PdfExport,
+    ExcelExport,
+    CsvExport,
+    FirstPage,
+    PrevPage,
+    LastPage,
+    NextPage,
+    AddRow,
+    RowIndent,
+    RowOutdent
+}
+
+/**
+ * Defines modes of editing supported by TreeGrids.
+ * The available editing modes are:
+ * * `Cell`: Enables cell editing mode.
+ * * `Row`: Enables row editing mode.
+ * * `Dialog`: Opens a dialog for editing.
+ * * `Batch`: Allows for batch editing of multiple records.
+ */
+export type EditMode =
+'Cell' |
+'Row' |
+'Dialog' |
+'Batch';
+
+/**
+ * Defines the target position for adding new rows in the TreeGrid.
+ * The available positions are:
+ * * `Top`: Adds a new row at the top of all rows.
+ * * `Bottom`: Adds a new row at the bottom of all rows.
+ * * `Above`: Adds a new row above the currently selected row.
+ * * `Below`: Adds a new row below the currently selected row.
+ * * `Child`: Adds a new row as a child to the currently selected row.
+ */
+export type RowPosition =
+'Top' |
+'Bottom' |
+'Above' |
+'Below' |
+'Child';
+
+/**
+ * Defines types of filters available in TreeGrids.
+ * The available filter types are:
+ * * `Menu`: Applies a dialog-based filtering option, where users can select operators such as 'equals', 'contains', etc., and enter filter values for more granular control.
+ * * `Excel`: Provides Excel-like filtering capabilities.
+ * * `FilterBar`: Uses a filter bar at the top of each column.
+ */
+export type FilterType =
+    'FilterBar' |
+    'Excel' |
+    'Menu';
+
+/**
+ * Defines wrapping modes for column content in TreeGrids.
+ * The available wrap modes are:
+ * * `Both`: Wraps both header and content.
+ * * `Header`: Wraps only the header.
+ * * `Content`: Wraps only the content.
+ */
+export type WrapMode =
+    'Both' |
+    'Header' |
+    'Content';
+
+/**
+ * Defines the types of CopyHierarchyMode for grid data.
+ * The available copy hierarchy types are:
+ * * `Parent`: Copies data maintaining only parent hierarchy.
+ * * `Child`: Copies data with child hierarchy.
+ * * `Both`: Maintains both parent and child hierarchy during copy.
+ * * `None`: Copies data without any hierarchy structure.
+ */
+export declare type CopyHierarchyType =
+'Parent' |
+'Child' |
+'Both' |
+'None';

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

@@ -0,0 +1,9 @@
+/**
+ * TreeGrid component exported items
+ */
+export * from './base';
+export * from './models';
+export * from './renderer';
+export * from './utils';
+export * from './enum';
+export * from './actions';

package/dist/ts/treegrid/index.ts

@@ -0,0 +1,9 @@
+/**
+ * TreeGrid component exported items
+ */
+export * from './base';
+export * from './models';
+export * from './renderer';
+export * from './utils';
+export * from './enum';
+export * from './actions';

package/dist/ts/treegrid/models/column-chooser-settings-model.d.ts

@@ -0,0 +1,62 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+
+/**
+ * Interface for a class ColumnChooserSettings
+ */
+export interface ColumnChooserSettingsModel {
+
+    /**
+     * Defines the search operator for column chooser.
+     *
+     * @default 'startsWith'
+     * @blazorType Syncfusion.Blazor.Operator
+     * @blazorDefaultValue Syncfusion.Blazor.Operator.StartsWith
+     */
+    operator?: string;
+
+    /**
+     * If ignoreAccent set to true, then ignores the diacritic characters or accents while searching in column chooser dialog.
+     *
+     * @default false
+     */
+    ignoreAccent?: boolean;
+
+    /**
+     * Defines the custom header elements for the column chooser header template.
+     *
+     * @default null
+     * @aspType string
+     */
+    headerTemplate?: string | Function;
+
+    /**
+     * Defines the custom content elements for the column chooser content template.
+     *
+     * @default null
+     * @aspType string
+     */
+    template?: string | Function;
+
+    /**
+     * Defines the custom footer elements for the column chooser footer template.
+     *
+     * @default null
+     * @aspType string
+     */
+    footerTemplate?: string | Function;
+
+    /**
+     * Enables or disables the search option in the column chooser.
+     *
+     * @default true
+     */
+    enableSearching?: boolean;
+
+    /**
+     * Renders a custom component to replace or extend the default column chooser UI.
+     * @param target - The target HTML element where the custom component will be appended in the column chooser dialog.
+     * @aspType string
+     */
+    renderCustomColumnChooser?: string | Function;
+
+}

package/dist/ts/treegrid/models/column-chooser-settings.d.ts

@@ -0,0 +1,53 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+/**
+ * Configures the column chooser behavior of the Grid.
+ */
+export declare class ColumnChooserSettings extends ChildProperty<ColumnChooserSettings> {
+    /**
+     * Defines the search operator for column chooser.
+     *
+     * @default 'startsWith'
+     * @blazorType Syncfusion.Blazor.Operator
+     * @blazorDefaultValue Syncfusion.Blazor.Operator.StartsWith
+     */
+    operator: string;
+    /**
+     * If ignoreAccent set to true, then ignores the diacritic characters or accents while searching in column chooser dialog.
+     *
+     * @default false
+     */
+    ignoreAccent: boolean;
+    /**
+     * Defines the custom header elements for the column chooser header template.
+     *
+     * @default null
+     * @aspType string
+     */
+    headerTemplate: string | Function;
+    /**
+     * Defines the custom content elements for the column chooser content template.
+     *
+     * @default null
+     * @aspType string
+     */
+    template: string | Function;
+    /**
+     * Defines the custom footer elements for the column chooser footer template.
+     *
+     * @default null
+     * @aspType string
+     */
+    footerTemplate: string | Function;
+    /**
+     * Enables or disables the search option in the column chooser.
+     *
+     * @default true
+     */
+    enableSearching: boolean;
+    /**
+     * Renders a custom component to replace or extend the default column chooser UI.
+     * @param target - The target HTML element where the custom component will be appended in the column chooser dialog.
+     * @aspType string
+     */
+    renderCustomColumnChooser: string | Function;
+}

package/dist/ts/treegrid/models/column-chooser-settings.ts

@@ -0,0 +1,67 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+
+/**
+ * Configures the column chooser behavior of the Grid.
+ */
+export class ColumnChooserSettings extends ChildProperty<ColumnChooserSettings> {
+    /**
+     * Defines the search operator for column chooser.
+     *
+     * @default 'startsWith'
+     * @blazorType Syncfusion.Blazor.Operator
+     * @blazorDefaultValue Syncfusion.Blazor.Operator.StartsWith
+     */
+    @Property('startsWith')
+    public operator: string;
+
+    /**
+     * If ignoreAccent set to true, then ignores the diacritic characters or accents while searching in column chooser dialog.
+     *
+     * @default false
+     */
+    @Property(false)
+    public ignoreAccent: boolean;
+
+    /**
+     * Defines the custom header elements for the column chooser header template.
+     *
+     * @default null
+     * @aspType string
+     */
+    @Property(null)
+    public headerTemplate: string | Function;
+
+    /**
+     * Defines the custom content elements for the column chooser content template.
+     *
+     * @default null
+     * @aspType string
+     */
+    @Property(null)
+    public template: string | Function;
+
+    /**
+     * Defines the custom footer elements for the column chooser footer template.
+     *
+     * @default null
+     * @aspType string
+     */
+    @Property(null)
+    public footerTemplate: string | Function;
+
+    /**
+     * Enables or disables the search option in the column chooser.
+     *
+     * @default true
+     */
+    @Property(true)
+    public enableSearching: boolean;
+
+    /**
+     * Renders a custom component to replace or extend the default column chooser UI.
+     * @param target - The target HTML element where the custom component will be appended in the column chooser dialog.
+     * @aspType string
+     */
+    @Property(null)
+    public renderCustomColumnChooser: string | Function;
+}

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

@@ -0,0 +1,30 @@
+import { TextAlign, ClipMode, ValueAccessor, IFilter, IFilterUI, IEditCell, CommandModel, freezeDirection } from '@syncfusion/ej2-grids';import { NumberFormatOptions, DateFormatOptions, merge, Property } from '@syncfusion/ej2-base';import { ITreeGridCellFormatter } from '../base/interface';import { SortComparer} from '@syncfusion/ej2-grids';import { TreeGrid } from '..';
+import {ColumnModel} from "./column";
+
+/**
+ * Interface for a class Column
+ */
+export interface ColumnModel {
+
+}
+
+/**
+ * Interface for a class TreeGridColumn
+ */
+export interface TreeGridColumnModel extends ColumnModel{
+
+    /**
+     * Defines stacked columns
+     *
+     * @default null
+     */
+    columns?: string[] | ColumnModel[];
+
+}
+
+/**
+ * Interface for a class StackedColumn
+ */
+export interface StackedColumnModel extends TreeGridColumnModel{
+
+}