@syncfusion/ej2-treegrid 25.2.5 → 26.1.35-469198

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

@@ -1,752 +0,0 @@
-import { TextAlign, ClipMode, ValueAccessor, IFilter, IFilterUI, IEditCell, CommandModel, freezeDirection } from '@syncfusion/ej2-grids';
-import { NumberFormatOptions, DateFormatOptions } from '@syncfusion/ej2-base';
-import { ITreeGridCellFormatter } from '../base/interface';
-import { SortComparer } from '@syncfusion/ej2-grids';
-/**
- * Represents TreeGrid `Column` model class.
- */
-export declare class Column {
-    /**
-     * Defines the field name of column which is mapped with mapping name of DataSource.
-     * The bounded columns can be sort, filter etc.,
-     * The `field` name must be a valid JavaScript identifier,
-     * the first character must be an alphabet and should not contain spaces and special characters.
-     *
-     * @default 'undefined'
-     */
-    field: string;
-    /**
-     * Defines the header text of column which is used to display in column header.
-     * If `headerText` is not defined, then field name value will be assigned to header text.
-     *
-     * @default 'undefined'
-     */
-    headerText: string;
-    /**
-     * Gets the unique identifier value of the column. It is used to get the column object.
-     *
-     * @default 'undefined'
-     */
-    uid: string;
-    /**
-     * If `allowEditing` set to false, then it disables editing of a particular column.
-     * By default all columns are editable.
-     *
-     * @default true
-     */
-    allowEditing: boolean;
-    /**
-     * If `showCheckbox` set to true, then the checkboxes will be displayed in particular column.
-     *
-     * @default false
-     */
-    showCheckbox: boolean;
-    /**
-     * Defines the custom sort comparer function.
-     * The sort comparer function has the same functionality like
-     * [`Array.sort`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) sort comparer.
-     * {% codeBlock src="grid/sort-comparer-api/index.ts" %}{% endcodeBlock %}
-     */
-    sortComparer: SortComparer | string;
-    /**
-     * If `isPrimaryKey` is set to true, considers this column as the primary key constraint.
-     *
-     * @default false
-     */
-    isPrimaryKey: boolean;
-    /**
-     * @hidden
-     * Defines the commands column template as string or HTML element ID which is used to add
-     * customized command buttons in each cells of the column.
-     *
-     * @aspType string
-     */
-    commandsTemplate: string | Function;
-    /**
-     * `commands` provides an option to display command buttons in every cell.
-     * The available built-in command buttons are
-     * * Edit - Edit the record.
-     * * Delete - Delete the record.
-     * * Save - Save the record.
-     * * Cancel - Cancel the edit state.
-     *
-     * @default null
-     */
-    commands: CommandModel[];
-    /**
-     * Defines the width of the column in pixels or percentage.
-     *
-     * @default 'undefined'
-     */
-    width: string | number;
-    /**
-     * Defines the type of component for editable.
-     *
-     * @default 'stringedit'
-     */
-    editType: string;
-    /**
-     * Defines rules to validate data before creating and updating.
-     *
-     * @default null
-     */
-    validationRules: Object;
-    /**
-     * Defines default values for the component when adding a new record to the TreeGrid.
-     *
-     * @default null
-     */
-    defaultValue: string;
-    /**
-     * Defines the `IEditCell` object to customize default edit cell.
-     *
-     * @default {}
-     */
-    edit: IEditCell;
-    /**
-     * Defines the cell edit template that used as editor for a particular column.
-     * It accepts either template string or HTML element ID.
-     *
-     * @default null
-     * @aspIgnore
-     */
-    editTemplate: string | Function;
-    /**
-     * Defines the filter template/UI that used as filter for a particular column.
-     * It accepts either template string or HTML element ID.
-     *
-     * @default null
-     * @aspIgnore
-     */
-    filterTemplate: string | Function;
-    /**
-     * If `isIdentity` is set to true, then this column is considered as identity column.
-     *
-     * @default false
-     */
-    isIdentity: boolean;
-    /**
-     * Defines the minimum Width of the column in pixels or percentage.
-     *
-     * @default 'undefined'
-     */
-    minWidth: string | number;
-    /**
-     * Defines the maximum width of the column in pixel or percentage, which will restrict resizing beyond this pixel or percentage.
-     *
-     * @default 'undefined'
-     */
-    maxWidth: string | number;
-    /**
-     * Defines the alignment of the column in both header and content cells.
-     *
-     * @default Left
-     */
-    textAlign: TextAlign;
-    /**
-     * Defines the cell content's overflow mode. The available modes are
-     * * `Clip` -  Truncates the cell content when it overflows its area.
-     * * `Ellipsis` -  Displays ellipsis when the cell content overflows its area.
-     * * `EllipsisWithTooltip` - Displays ellipsis when the cell content overflows its area
-     * also it will display tooltip while hover on ellipsis applied cell.
-     *
-     * @default Ellipsis
-     */
-    clipMode: ClipMode;
-    /**
-     * Define the alignment of column header which is used to align the text of column header.
-     *
-     * @default null
-     */
-    headerTextAlign: TextAlign;
-    /**
-     * If `disableHtmlEncode` is set to true, it encodes the HTML of the header and content cells.
-     *
-     * @default true
-     */
-    disableHtmlEncode: boolean;
-    /**
-     * Defines the data type of the column.
-     *
-     * @default null
-     */
-    type: string;
-    /**
-     * It is used to change display value with the given format and does not affect the original data.
-     * Gets the format from the user which can be standard or custom
-     * [`number`](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string)
-     * and [`date`](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string-1) formats.
-     *
-     * @default null
-     * @aspType string
-     */
-    format: string | NumberFormatOptions | DateFormatOptions;
-    /**
-     * If `visible` is set to false, hides the particular column. By default, columns are displayed.
-     *
-     * @default true
-     */
-    visible: boolean;
-    /**
-     * Defines the column template that renders customized element in each cell of the column.
-     * It accepts either [template string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals)
-     * or HTML element ID.
-     *
-     * @default null
-     * @aspType string
-     */
-    template: string | Function;
-    /**
-     * Defines the header template as string or HTML element ID which is used to add customized element in the column header.
-     *
-     * @default null
-     * @aspType string
-     */
-    headerTemplate: string | Function;
-    /**
-     * You can use this property to freeze selected columns in treegrid
-     *
-     * @default false
-     */
-    isFrozen: boolean;
-    /**
-     * The CSS styles and attributes of the content cells of a particular column can be customized.
-     *
-     * @default null
-     */
-    customAttributes: {
-        [x: string]: Object;
-    };
-    /**
-     * If `displayAsCheckBox` is set to true, it displays the column value as a check box instead of Boolean value.
-     *
-     * @default false
-     */
-    displayAsCheckBox: boolean;
-    /**
-     * If `allowReordering` set to false, then it disables reorder of a particular column.
-     * By default all columns can be reorder.
-     *
-     * @default true
-     */
-    allowReordering: boolean;
-    /**
-     * If `showColumnMenu` set to false, then it disable the column menu of a particular column.
-     * By default column menu will show for all columns
-     *
-     * @default true
-     */
-    showColumnMenu: boolean;
-    /**
-     * If `allowFiltering` set to false, then it disables filtering option and filter bar element of a particular column.
-     * By default all columns are filterable.
-     *
-     * @default true
-     */
-    allowFiltering: boolean;
-    /**
-     * If `allowSorting` set to false, then it disables sorting option of a particular column.
-     * By default all columns are sortable.
-     *
-     * @default true
-     */
-    allowSorting: boolean;
-    /**
-     * If `allowResizing` is set to false, it disables resize option of a particular column.
-     * By default all the columns can be resized.
-     *
-     * @default true
-     */
-    allowResizing: boolean;
-    /**
-     * Defines the method which is used to achieve custom formatting from an external function.
-     * This function triggers before rendering of each cell.
-     *
-     * @default null
-     */
-    formatter: {
-        new (): ITreeGridCellFormatter;
-    } | ITreeGridCellFormatter | Function;
-    /**
-     * Defines the method used to apply custom cell values from external function and display this on each cell rendered.
-     *
-     * @default null
-     */
-    valueAccessor: ValueAccessor | string;
-    /**
-     * Used to render multiple header rows(stacked headers) on the TreeGrid header.
-     *
-     * @default null
-     */
-    columns: Column[] | string[] | ColumnModel[];
-    /**
-     * Column visibility can change based on [`Media Queries`](http://cssmediaqueries.com/what-are-css-media-queries.html).
-     * `hideAtMedia` accepts only valid Media Queries.
-     *
-     * @default 'undefined'
-     */
-    hideAtMedia: string;
-    /**
-     * If `showInColumnChooser` set to false, then hide the particular column in column chooser.
-     *  By default all columns are displayed in column Chooser.
-     *
-     * @default true
-     */
-    showInColumnChooser?: boolean;
-    /**
-     * The `filterBarTemplate` is used to add a custom component instead of default input component for filter bar.
-     * It have create and read functions.
-     * * create: It is used for creating custom components.
-     * * read: It is used to perform custom filter action.
-     *
-     *
-     * @default null
-     */
-    filterBarTemplate: IFilterUI;
-    /**
-     *  It is used to customize the default filter options for a specific columns.
-     * * type -  Specifies the filter type as menu.
-     * * ui - to render custom component for specific column it has following functions.
-     * * ui.create – It is used for creating custom components.
-     * * ui.read -  It is used for read the value from the component.
-     * * ui.write - It is used to apply component model as dynamically.
-     *
-     *  @default null
-     */
-    filter: IFilter;
-    /**
-     * If `lockColumn` set to true, then it disables Reordering of a particular column.
-     * The locked column will be moved to first position.
-     *
-     * @default false
-     */
-    lockColumn: boolean;
-    /**
-     * defines which side the column need to freeze
-     * The available built-in freeze directions are
-     * * Left - Freeze the column at left side.
-     * * Right - Freeze the column at right side.
-     * * Fixed - Freeze the column at Center.
-     *
-     * @default null
-     */
-    freeze: freezeDirection;
-    private parent;
-    constructor(options: ColumnModel);
-    /**
-     * Update the State changes reflected for TreeGrid columndirective in react platform.
-     *
-     * @param {Column} column - specifies the column
-     * @returns {void}
-     * @hidden
-     */
-    private setProperties;
-}
-/**
- * Interface for a TreeGrid class Column
- */
-export interface ColumnModel {
-    /**
-     * Defines the field name of column which is mapped with mapping name of DataSource.
-     * The bounded columns can be sort, filter etc.,
-     * The `field` name must be a valid JavaScript identifier,
-     * the first character must be an alphabet and should not contain spaces and special characters.
-     *
-     * @default 'undefined'
-     */
-    field?: string;
-    /**
-     * Gets the unique identifier value of the column. It is used to get the object.
-     *
-     * @default 'undefined'
-     */
-    uid?: string;
-    /**
-     * Defines the header text of column which is used to display in column header.
-     * If `headerText` is not defined, then field name value will be assigned to header text.
-     *
-     * @default 'undefined'
-     */
-    headerText?: string;
-    /**
-     * Defines the width of the column in pixels or percentage.
-     *
-     * @default 'undefined'
-     */
-    width?: string | number;
-    /**
-     * Defines the minimum width of the column in pixels or percentage.
-     *
-     * @default 'undefined'
-     */
-    minWidth?: string | number;
-    /**
-     * Defines the sort comparer property.
-     *
-     * @default 'undefined'
-     */
-    sortComparer?: SortComparer | string;
-    /**
-     * Defines the maximum width of the column in pixels or percentage, which will restrict resizing beyond this pixels or percentage.
-     *
-     * @default 'undefined'
-     */
-    maxWidth?: string | number;
-    /**
-     * Defines the alignment of the column in both header and content cells.
-     *
-     * @default Syncfusion.EJ2.Grids.TextAlign.Left
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.TextAlign
-     */
-    textAlign?: TextAlign;
-    /**
-     * Used to render multiple header rows(stacked headers) on TreeGrid header.
-     *
-     * @default null
-     */
-    columns?: Column[] | string[] | ColumnModel[];
-    /**
-     * Defines the cell content's overflow mode. The available modes are
-     * ```props
-     * * Clip :- Truncates the cell content when it overflows its area.
-     * * Ellipsis :- Displays ellipsis when the cell content overflows its area.
-     * * EllipsisWithTooltip :- Displays ellipsis when the cell content overflows its area also it will display tooltip while hover on ellipsis applied cell.
-     * ```
-     * also it will display tooltip while hover on ellipsis applied cell.
-     *
-     * @default Syncfusion.EJ2.Grids.ClipMode.Ellipsis
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.ClipMode
-     */
-    clipMode?: ClipMode;
-    /**
-     * Define the alignment of column header which is used to align the text of column header.
-     *
-     * @default null
-     * @aspDefaultValueIgnore
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.TextAlign
-     */
-    headerTextAlign?: TextAlign;
-    /**
-     * If `disableHtmlEncode` is set to true, it encodes the HTML of the header and content cells.
-     *
-     * @default true
-     */
-    disableHtmlEncode?: boolean;
-    /**
-     * Defines the data type of the column.
-     *
-     * @default null
-     */
-    type?: string;
-    /**
-     * If `allowReordering` set to false, then it disables reorder of a particular column.
-     * By default all columns can be reorder.
-     *
-     * @default true
-     */
-    allowReordering?: boolean;
-    /**
-     * If `allowFiltering` set to false, then it disables filtering option and filter bar element of a particular column.
-     * By default all columns are filterable.
-     *
-     * @default true
-     */
-    allowFiltering?: boolean;
-    /**
-     * If `allowSorting` set to false, then it disables sorting option of a particular column.
-     * By default all columns are sortable.
-     *
-     * @default true
-     */
-    allowSorting?: boolean;
-    /**
-     * If `showColumnMenu` set to false, then it disable the column menu of a particular column.
-     * By default column menu will show for all columns
-     *
-     * @default true
-     */
-    showColumnMenu?: boolean;
-    /**
-     * If `allowResizing` set to false, it disables resize option of a particular column.
-     *
-     * @default true
-     */
-    allowResizing?: boolean;
-    /**
-     * It is used to change display value with the given format and does not affect the original data.
-     * Gets the format from the user which can be standard or custom
-     * [`number`](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string)
-     * and [`date`](https://ej2.syncfusion.com/documentation/common/internationalization/#supported-format-string-1) formats.
-     *
-     * @default null
-     * @aspType string
-     */
-    format?: string | NumberFormatOptions | DateFormatOptions;
-    /**
-     * If `visible` is set to false, hides the particular column. By default, columns are displayed.
-     *
-     * @default true
-     */
-    visible?: boolean;
-    /**
-     * @hidden
-     * Defines the commands column template as string or HTML element ID which is used to add
-     * customized command buttons in each cells of the column.
-     *
-     * @aspType string
-     */
-    commandsTemplate?: string | Function;
-    /**
-     * `commands` provides an option to display command buttons in every cell.
-     * The available built-in command buttons are
-     * * Edit - Edit the record.
-     * * Delete - Delete the record.
-     * * Save - Save the record.
-     * * Cancel - Cancel the edit state.
-     *
-     * The following code example implements the custom command column.
-     * ```html
-     * <style type="text/css" class="cssStyles">
-     * .details-icon:before
-     * {
-     *    content:"\e74d";
-     * }
-     * </style>
-     * <div id="TreeGrid"></div>
-     * ```
-     * ```typescript
-     * var gridObj = new TreeGrid({
-     * datasource: window.gridData,
-     * columns : [
-     *  { field: 'CustomerID', headerText: 'Customer ID' },
-     *  { field: 'CustomerName', headerText: 'Customer Name' },
-     *  {commands: [{buttonOption:{content: 'Details', click: onClick, cssClass: details-icon}}], headerText: 'Customer Details'}
-     * ]
-     * gridObj.appendTo("#TreeGrid");
-     * ```
-     *
-     * @default null
-     */
-    commands?: CommandModel[];
-    /**
-     * Defines the column template that renders customized element in each cell of the column.
-     * It accepts either [template string](https://ej2.syncfusion.com/documentation/common/template-engine/) or HTML element ID.
-     *
-     * @default null
-     * @aspType string
-     */
-    template?: string | Function;
-    /**
-     * Defines the header template as string or HTML element ID which is used to add customized element in the column header.
-     *
-     * @default null
-     * @aspType string
-     */
-    headerTemplate?: string | Function;
-    /**
-     * You can use this property to freeze selected columns in grid.
-     *
-     * @default false
-     */
-    isFrozen?: boolean;
-    /**
-     * The CSS styles and attributes of the content cells of a particular column can be customized.
-     *
-     * @default null
-     */
-    customAttributes?: {
-        [x: string]: Object;
-    };
-    /**
-     * If `displayAsCheckBox` is set to true, it displays the column value as a check box instead of Boolean value.
-     *
-     * @default false
-     */
-    displayAsCheckBox?: boolean;
-    /**
-     * Defines the method which is used to achieve custom formatting from an external function.
-     * This function triggers before rendering of each cell.
-     *
-     * @default null
-     */
-    formatter?: {
-        new (): ITreeGridCellFormatter;
-    } | ITreeGridCellFormatter | Function;
-    /**
-     * If `showInColumnChooser` set to false, then hide the particular column in column chooser.
-     *  By default all columns are displayed in column Chooser.
-     *
-     * @default true
-     */
-    showInColumnChooser?: boolean;
-    /**
-     * Defines the method used to apply custom cell values from external function and display this on each cell rendered.
-     *
-     * @default null
-     */
-    valueAccessor?: ValueAccessor | string;
-    /**
-     * Column visibility can change based on [`Media Queries`](http://cssmediaqueries.com/what-are-css-media-queries.html).
-     * `hideAtMedia` accepts only valid Media Queries.
-     *
-     * @default 'undefined'
-     */
-    hideAtMedia?: string;
-    /**
-     * The `filterBarTemplate` is used to add a custom component instead of default input component for filter bar.
-     * It have create and read functions.
-     * * create: It is used for creating custom components.
-     * * read: It is used to perform custom filter action.
-     *
-     * ```html
-     * <div id="TreeGrid"></div>
-     * ```
-     * ```typescript
-     * let gridObj: TreeGrid = new TreeGrid({
-     * dataSource: filterData,
-     * columns: [
-     *   { field: 'OrderID', headerText: 'Order ID' },
-     *   {
-     *      field: 'EmployeeID', filterBarTemplate: {
-     *         create: (args: { element: Element, column: Column }) => {
-     *              let input: HTMLInputElement = document.createElement('input');
-     *              input.id = 'EmployeeID';
-     *              input.type = 'text';
-     *              return input;
-     *         },
-     *         write: (args: { element: Element, column: Column }) => {
-     *             args.element.addEventListener('input', args.column.filterBarTemplate.read as EventListener);
-     *         },
-     *         read: (args: { element: HTMLInputElement, columnIndex: number, column: Column }) => {
-     *             gridObj.filterByColumn(args.element.id, 'equal', args.element.value);
-     *        }
-     *     }
-     *  }],
-     *   allowFiltering: true
-     * });
-     * gridObj.appendTo('#TreeGrid');
-     * ```
-     *
-     * @default null
-     */
-    filterBarTemplate?: IFilterUI;
-    /**
-     *  Defines the filter options to customize filtering for the particular column.
-     *
-     *  @default null
-     */
-    filter?: IFilter;
-    /**
-     * If `isPrimaryKey` is set to true, considers this column as the primary key constraint.
-     *
-     * @default false
-     */
-    isPrimaryKey?: boolean;
-    /**
-     * If `showCheckbox` set to true, then the checkboxes will be displayed in particular column.
-     *
-     * @default false
-     */
-    showCheckbox?: boolean;
-    /**
-     * Defines the type of component for editing.
-     *
-     * @default 'stringedit'
-     */
-    editType?: string;
-    /**
-     * Defines default values for the component when adding a new record to the TreeGrid.
-     *
-     * @default null
-     */
-    defaultValue?: string;
-    /**
-     * Defines the `IEditCell` object to customize default edit cell.
-     *
-     * @default {}
-     */
-    edit?: IEditCell;
-    /**
-     * Defines the cell edit template that used as editor for a particular column.
-     * It accepts either template string or HTML element ID.
-     *
-     * @aspIgnore
-     */
-    editTemplate?: string | Function;
-    /**
-     * Defines the filter template/UI that is used as filter for a particular column.
-     * It accepts either template string or HTML element ID.
-     *
-     * @aspIgnore
-     */
-    filterTemplate?: string | Function;
-    /**
-     * If `isIdentity` is set to true, then this column is considered as identity column.
-     *
-     * @default false
-     */
-    isIdentity?: boolean;
-    /**
-     * Defines rules to validate data before creating and updating.
-     *
-     * @default null
-     */
-    validationRules?: Object;
-    /**
-     * If `allowEditing` set to false, then it disables editing of a particular column.
-     * By default all columns are editable.
-     *
-     * @default true
-     */
-    allowEditing?: boolean;
-    /**
-     * If `lockColumn` set to true, then it disables Reordering of a particular column.
-     * The locked column will be moved to first position.
-     *
-     * @default false
-     */
-    lockColumn?: boolean;
-    /**
-     * Defines which side the column need to freeze
-     *
-     * @default Syncfusion.EJ2.Grids.FreezeDirection.None
-     * @isEnumeration true
-     * @aspType Syncfusion.EJ2.Grids.FreezeDirection
-     */
-    freeze?: freezeDirection;
-}
-/**
- * Defines TreeGrid column
- */
-export declare class TreeGridColumn extends Column {
-    /**
-     * Defines stacked columns
-     *
-     * @default null
-     */
-    columns: string[] | ColumnModel[];
-}
-/**
- * Interface for a class TreeGridColumn
- */
-export interface TreeGridColumnModel extends ColumnModel {
-    /**
-     * Defines stacked columns
-     *
-     * @default null
-     */
-    columns?: string[] | ColumnModel[];
-}
-/**
- * Defines stacked tree grid column
- */
-export declare class StackedColumn extends TreeGridColumn {
-}
-/**
- * Interface for a class stacked tree grid column
- */
-export interface StackedColumnModel extends TreeGridColumnModel {
-}