@syncfusion/ej2-grids 20.3.47-54738 → 20.3.47-54739

package/src/grid/actions/context-menu.d.ts

@@ -0,0 +1,102 @@
+import { ContextMenu as Menu } from '@syncfusion/ej2-navigations';
+import { IGrid, IAction, ContextMenuClickEventArgs } from '../base/interface';
+import { ServiceLocator } from '../services/service-locator';
+export declare const menuClass: CMenuClassList;
+export interface CMenuClassList {
+    header: string;
+    content: string;
+    edit: string;
+    batchEdit: string;
+    editIcon: string;
+    pager: string;
+    cancel: string;
+    save: string;
+    delete: string;
+    copy: string;
+    pdf: string;
+    group: string;
+    ungroup: string;
+    csv: string;
+    excel: string;
+    fPage: string;
+    lPage: string;
+    nPage: string;
+    pPage: string;
+    ascending: string;
+    descending: string;
+    groupHeader: string;
+    touchPop: string;
+}
+/**
+ * The `ContextMenu` module is used to handle context menu actions.
+ */
+export declare class ContextMenu implements IAction {
+    private element;
+    contextMenu: Menu;
+    private defaultItems;
+    private disableItems;
+    private hiddenItems;
+    private gridID;
+    private parent;
+    private serviceLocator;
+    private l10n;
+    private localeText;
+    private targetColumn;
+    private eventArgs;
+    isOpen: boolean;
+    row: HTMLTableRowElement;
+    cell: HTMLTableCellElement;
+    private targetRowdata;
+    constructor(parent?: IGrid, serviceLocator?: ServiceLocator);
+    /**
+     * @returns {void}
+     * @hidden
+     */
+    addEventListener(): void;
+    /**
+     * @returns {void}
+     * @hidden
+     */
+    removeEventListener(): void;
+    private keyDownHandler;
+    private render;
+    private enableAfterRenderMenu;
+    private getMenuItems;
+    private getLastPage;
+    private contextMenuOpen;
+    /**
+     * @param {ContextMenuClickEventArgs} args - specifies the ContextMenuClickEventArgs argument type
+     * @returns {void}
+     * @hidden
+     */
+    contextMenuItemClick(args: ContextMenuClickEventArgs): void;
+    private contextMenuOnClose;
+    private getLocaleText;
+    private updateItemStatus;
+    private contextMenuBeforeOpen;
+    private ensureTarget;
+    private ensureFrozenHeader;
+    private ensureDisabledStatus;
+    /**
+     * Gets the context menu element from the Grid.
+     *
+     * @returns {Element} returns the element
+     */
+    getContextMenu(): Element;
+    /**
+     * Destroys the context menu component in the Grid.
+     *
+     * @function destroy
+     * @returns {void}
+     * @hidden
+     */
+    destroy(): void;
+    private getModuleName;
+    private generateID;
+    private getKeyFromId;
+    private buildDefaultItems;
+    private getDefaultItems;
+    private setLocaleKey;
+    private getColumn;
+    private selectRow;
+}

package/src/grid/actions/data.d.ts

@@ -0,0 +1,110 @@
+import { Query, DataManager } from '@syncfusion/ej2-data';
+import { IDataProcessor, IGrid, PendingState } from '../base/interface';
+import { PredicateModel } from '../base/grid-model';
+import { ServiceLocator } from '../services/service-locator';
+import { Column } from '../models/column';
+/**
+ * Grid data module is used to generate query and data source.
+ *
+ * @hidden
+ */
+export declare class Data implements IDataProcessor {
+    dataManager: DataManager;
+    /** @hidden */
+    isQueryInvokedFromData: boolean;
+    protected parent: IGrid;
+    protected serviceLocator: ServiceLocator;
+    protected dataState: PendingState;
+    foreignKeyDataState: PendingState;
+    /**
+     * Constructor for data module.
+     *
+     * @param {IGrid} parent - specifies the IGrid
+     * @param {ServiceLocator} serviceLocator - specifies the service locator
+     * @hidden
+     */
+    constructor(parent?: IGrid, serviceLocator?: ServiceLocator);
+    private reorderRows;
+    protected getModuleName(): string;
+    /**
+     * The function used to initialize dataManager and external query
+     *
+     * @returns {void}
+     */
+    private initDataManager;
+    /**
+     * The function is used to generate updated Query from Grid model.
+     *
+     * @param {boolean} skipPage - specifies the boolean to skip the page
+     * @returns {Query} returns the Query
+     * @hidden
+     */
+    generateQuery(skipPage?: boolean): Query;
+    /**
+     * @param {Query} query - specifies the query
+     * @returns {Query} - returns the query
+     * @hidden
+     */
+    aggregateQuery(query: Query): Query;
+    protected virtualGroupPageQuery(query: Query): Query;
+    protected pageQuery(query: Query, skipPage?: boolean): Query;
+    protected groupQuery(query: Query): Query;
+    protected sortQuery(query: Query): Query;
+    protected searchQuery(query: Query, fcolumn?: Column, isForeignKey?: boolean): Query;
+    protected filterQuery(query: Query, column?: PredicateModel[], skipFoerign?: boolean): Query;
+    private fGeneratePredicate;
+    /**
+     * The function is used to get dataManager promise by executing given Query.
+     *
+     * @param {object} args - specifies the object
+     * @param {string} args.requestType - Defines the request type
+     * @param {string[]} args.foreignKeyData - Defines the foreignKeyData.string
+     * @param {Object} args.data - Defines the data.
+     * @param {number} args.index - Defines the index .
+     * @param {Query} query - Defines the query which will execute along with data processing.
+     * @returns {Promise<Object>} - returns the object
+     * @hidden
+     */
+    getData(args?: {
+        requestType?: string;
+        foreignKeyData?: string[];
+        data?: Object;
+        index?: number;
+    }, query?: Query): Promise<Object>;
+    private insert;
+    private executeQuery;
+    private formatGroupColumn;
+    private crudActions;
+    /**
+     * @param {object} changes - specifies the changes
+     * @param {string} key - specifies the key
+     * @param {object} original - specifies the original data
+     * @param {Query} query - specifies the query
+     * @returns {Promise<Object>} returns the object
+     * @hidden
+     */
+    saveChanges(changes: Object, key: string, original: Object, query?: Query): Promise<Object>;
+    private getKey;
+    /**
+     * @returns {boolean} returns whether its remote data
+     * @hidden
+     */
+    isRemote(): boolean;
+    private addRows;
+    private removeRows;
+    private getColumnByField;
+    protected destroy(): void;
+    getState(): PendingState;
+    setState(state: PendingState): Object;
+    getForeignKeyDataState(): PendingState;
+    setForeignKeyDataState(state: PendingState): void;
+    getStateEventArgument(query: Query): PendingState;
+    private eventPromise;
+    /**
+     * Gets the columns where searching needs to be performed from the Grid.
+     *
+     * @returns {string[]} returns the searched column field names
+     */
+    private getSearchColumnFieldNames;
+    private refreshFilteredCols;
+}

package/src/grid/actions/detail-row.d.ts

@@ -0,0 +1,73 @@
+import { IGrid } from '../base/interface';
+import { ServiceLocator } from '../services/service-locator';
+import { Row } from '../models/row';
+import { Column } from '../models/column';
+/**
+ * The `DetailRow` module is used to handle detail template and hierarchy Grid operations.
+ */
+export declare class DetailRow {
+    private aria;
+    private parent;
+    private focus;
+    private lastrowcell;
+    private childRefs;
+    /**
+     * Constructor for the Grid detail template module
+     *
+     * @param {IGrid} parent - specifies the IGrid
+     * @param {ServiceLocator} locator - specifes the serviceLocator
+     * @hidden
+     */
+    constructor(parent?: IGrid, locator?: ServiceLocator);
+    private clickHandler;
+    private toogleExpandcollapse;
+    /**
+     * @hidden
+     * @param {IGrid} gObj - specifies the grid Object
+     * @param {Row<Column>}rowObj - specifies the row object
+     * @param {string} printMode - specifies the printmode
+     * @returns {Object} returns the object
+     */
+    getGridModel(gObj: IGrid, rowObj: Row<Column>, printMode: string): Object;
+    private promiseResolve;
+    private isDetailRow;
+    private destroy;
+    private getTDfromIndex;
+    /**
+     * Expands a detail row with the given target.
+     *
+     * @param  {Element} target - Defines the collapsed element to expand.
+     * @returns {void}
+     */
+    expand(target: number | Element): void;
+    /**
+     * Collapses a detail row with the given target.
+     *
+     * @param  {Element} target - Defines the expanded element to collapse.
+     * @returns {void}
+     */
+    collapse(target: number | Element): void;
+    /**
+     * Expands all the detail rows of the Grid.
+     *
+     * @returns {void}
+     */
+    expandAll(): void;
+    /**
+     * Collapses all the detail rows of the Grid.
+     *
+     * @returns {void}
+     */
+    collapseAll(): void;
+    private expandCollapse;
+    private keyPressHandler;
+    private refreshColSpan;
+    private destroyChildGrids;
+    /**
+     * For internal use only - Get the module name.
+     *
+     * @returns {string} returns the module name
+     * @private
+     */
+    protected getModuleName(): string;
+}

package/src/grid/actions/dialog-edit.d.ts

@@ -0,0 +1,21 @@
+import { IGrid } from '../base/interface';
+import { EditRender } from '../renderer/edit-renderer';
+import { ServiceLocator } from '../services/service-locator';
+import { NormalEdit } from './normal-edit';
+/**
+ * `DialogEdit` module is used to handle dialog editing actions.
+ *
+ * @hidden
+ */
+export declare class DialogEdit extends NormalEdit {
+    protected parent: IGrid;
+    protected serviceLocator: ServiceLocator;
+    protected renderer: EditRender;
+    constructor(parent?: IGrid, serviceLocator?: ServiceLocator, renderer?: EditRender);
+    closeEdit(): void;
+    addRecord(data?: Object, index?: number): void;
+    endEdit(): void;
+    updateRow(index: number, data?: Object): void;
+    deleteRecord(fieldname?: string, data?: Object): void;
+    protected startEdit(tr?: Element): void;
+}

package/src/grid/actions/edit.d.ts

@@ -0,0 +1,271 @@
+import { L10n } from '@syncfusion/ej2-base';
+import { IGrid, IAction, NotifyArgs, IEdit } from '../base/interface';
+import { EditRender } from '../renderer/edit-renderer';
+import { ServiceLocator } from '../services/service-locator';
+import { Column } from '../models/column';
+import { FormValidator } from '@syncfusion/ej2-inputs';
+/**
+ * The `Edit` module is used to handle editing actions.
+ */
+export declare class Edit implements IAction {
+    protected renderer: EditRender;
+    /** @hidden */
+    editModule: IEdit;
+    /** @hidden */
+    formObj: FormValidator;
+    /** @hidden */
+    mFormObj: FormValidator;
+    /** @hidden */
+    frFormObj: FormValidator;
+    /** @hidden */
+    virtualFormObj: FormValidator;
+    private static editCellType;
+    private editType;
+    protected parent: IGrid;
+    protected serviceLocator: ServiceLocator;
+    protected l10n: L10n;
+    private dialogObj;
+    private alertDObj;
+    private actionBeginFunction;
+    private actionCompleteFunction;
+    private preventObj;
+    private eventDetails;
+    isLastRow?: boolean;
+    deleteRowUid: string;
+    editCellDialogClose: boolean;
+    /**
+     * Constructor for the Grid editing module
+     *
+     * @param {IGrid} parent - specifies the IGrid
+     * @param {ServiceLocator} serviceLocator - specifies the servicelocator
+     * @hidden
+     */
+    constructor(parent?: IGrid, serviceLocator?: ServiceLocator);
+    private updateColTypeObj;
+    /**
+     * For internal use only - Get the module name.
+     *
+     * @returns {string} returns the module name
+     * @private
+     */
+    protected getModuleName(): string;
+    /**
+     * @param {NotifyArgs} e - specifies the notifyargs
+     * @returns {void}
+     * @hidden
+     */
+    onPropertyChanged(e: NotifyArgs): void;
+    private updateEditObj;
+    private initialEnd;
+    /**
+     * Edits any bound record in the Grid by TR element.
+     *
+     * @param {HTMLTableRowElement} tr - Defines the table row to be edited.
+     * @returns {void}
+     */
+    startEdit(tr?: HTMLTableRowElement): void;
+    /**
+     * @param {Element} tr - specifies the tr element
+     * @param {object} args - specifies the object
+     * @param {Element} args.row -specfifes the row
+     * @param {string} args.requestType - specifies the request type
+     * @returns {void}
+     * @hidden
+     */
+    checkLastRow(tr: Element, args?: {
+        row?: Element;
+        requestType?: string;
+    }): void;
+    /**
+     * Cancels edited state.
+     *
+     * @returns {void}
+     */
+    closeEdit(): void;
+    protected refreshToolbar(): void;
+    /**
+     * To adds a new row at the top with the given data. When data is not passed, it will add empty rows.
+     * > `editSettings.allowEditing` should be true.
+     *
+     * @param {Object} data - Defines the new add record data.
+     * @param {number} index - Defines the row index to be added
+     * @returns {void}
+     */
+    addRecord(data?: Object, index?: number): void;
+    /**
+     * Deletes a record with the given options. If fieldname and data are not given, the Grid will delete the selected record.
+     * > `editSettings.allowDeleting` should be true.
+     *
+     * @param {string} fieldname - Defines the primary key field name of the column.
+     * @param {Object} data - Defines the JSON data record to be deleted.
+     * @returns {void}
+     */
+    deleteRecord(fieldname?: string, data?: Object): void;
+    /**
+     * Deletes a visible row by TR element.
+     *
+     * @param {HTMLTableRowElement} tr - Defines the table row element.
+     * @returns {void}
+     */
+    deleteRow(tr: HTMLTableRowElement): void;
+    /**
+     * If Grid is in editable state, you can save a record by invoking endEdit.
+     *
+     * @returns {void}
+     */
+    endEdit(): void;
+    /**
+     * To update the specified cell by given value without changing into edited state.
+     *
+     * @param {number} rowIndex Defines the row index.
+     * @param {string} field Defines the column field.
+     * @param {string | number | boolean | Date} value - Defines the value to be changed.
+     * @returns {void}
+     */
+    updateCell(rowIndex: number, field: string, value: string | number | boolean | Date): void;
+    /**
+     * To update the specified row by given values without changing into edited state.
+     *
+     * @param {number} index Defines the row index.
+     * @param {Object} data Defines the data object to be updated.
+     * @returns {void}
+     */
+    updateRow(index: number, data: Object): void;
+    /**
+     * Resets added, edited, and deleted records in the batch mode.
+     *
+     * @returns {void}
+     */
+    batchCancel(): void;
+    /**
+     * Bulk saves added, edited, and deleted records in the batch mode.
+     *
+     * @returns {void}
+     */
+    batchSave(): void;
+    /**
+     * Changes a particular cell into edited state based on the row index and field name provided in the `batch` mode.
+     *
+     * @param {number} index - Defines row index to edit a particular cell.
+     * @param {string} field - Defines the field name of the column to perform batch edit.
+     * @returns {void}
+     */
+    editCell(index: number, field: string): void;
+    /**
+     * Checks the status of validation at the time of editing. If validation is passed, it returns true.
+     *
+     * @returns {boolean} returns whether the form is validated
+     */
+    editFormValidate(): boolean;
+    /**
+     * Gets the added, edited,and deleted data before bulk save to the DataSource in batch mode.
+     *
+     * @returns {Object} returns the Object
+     */
+    getBatchChanges(): Object;
+    /**
+     * Gets the current value of the edited component.
+     *
+     * @returns {Object} returns the Object
+     */
+    getCurrentEditCellData(): Object;
+    /**
+     * Saves the cell that is currently edited. It does not save the value to the DataSource.
+     *
+     * @returns {void}
+     */
+    saveCell(): void;
+    private endEditing;
+    private showDialog;
+    getValueFromType(col: Column, value: string | Date | boolean): number | string | Date | boolean;
+    private destroyToolTip;
+    private createConfirmDlg;
+    private createAlertDlg;
+    private alertClick;
+    private dlgWidget;
+    private dlgCancel;
+    private dlgOk;
+    private destroyEditComponents;
+    /**
+     * @returns {void}
+     * @hidden
+     */
+    addEventListener(): void;
+    /**
+     * @returns {void}
+     * @hidden
+     */
+    removeEventListener(): void;
+    private actionComplete;
+    /**
+     * @param {Element} form - specifies the element
+     * @param {Object} editedData - specifies the edited data
+     * @returns {Object} returns the object
+     * @hidden
+     */
+    getCurrentEditedData(form: Element, editedData: Object): Object;
+    private getValue;
+    /**
+     * @param {NotifyArgs} e - specifies the NotifyArgs
+     * @returns {void}
+     * @hidden
+     */
+    onActionBegin(e: NotifyArgs): void;
+    /**
+     * @param {Column[]} cols - specfies the column
+     * @returns {void}
+     * @hidden
+     */
+    destroyWidgets(cols?: Column[]): void;
+    /**
+     * @returns {void}
+     * @hidden
+     */
+    destroyForm(): void;
+    /**
+     * To destroy the editing.
+     *
+     * @returns {void}
+     * @hidden
+     */
+    destroy(): void;
+    private keyPressHandler;
+    private curretRowFocus;
+    private preventBatch;
+    private executeAction;
+    /**
+     * @param {Column[]} cols - specifies the column
+     * @returns {void}
+     * @hidden
+     */
+    applyFormValidation(cols?: Column[]): void;
+    /**
+     * @param {HTMLFormElement} form - Defined Form element
+     * @param {Object} rules - Defines form rules
+     * @returns {FormValidator} Returns formvalidator instance
+     * @hidden
+     */
+    createFormObj(form: HTMLFormElement, rules: Object): FormValidator;
+    private valErrorPlacement;
+    private getElemTable;
+    resetElemPosition(elem: HTMLElement, args: {
+        status: string;
+        inputName: string;
+        element: HTMLElement;
+        message: string;
+    }): void;
+    private validationComplete;
+    private createTooltip;
+    /**
+     * @param {Column} col - specfies the column
+     * @returns {boolean} returns the whether column is grouped
+     * @hidden
+     */
+    checkColumnIsGrouped(col: Column): boolean;
+    /**
+     * @param {object} editors -specfies the editors
+     * @returns {void}
+     * @hidden
+     */
+    static AddEditors(editors: object): void;
+}

package/src/grid/actions/excel-export.d.ts

@@ -0,0 +1,89 @@
+import { IGrid, ExcelExportProperties } from '../base/interface';
+import { Workbook } from '@syncfusion/ej2-excel-export';
+import { ServiceLocator } from '../services/service-locator';
+/**
+ * @hidden
+ * `ExcelExport` module is used to handle the Excel export action.
+ */
+export declare class ExcelExport {
+    private parent;
+    private isExporting;
+    private theme;
+    private book;
+    private workSheet;
+    private rows;
+    private columns;
+    private styles;
+    private data;
+    private rowLength;
+    private footer;
+    private expType;
+    private includeHiddenColumn;
+    private isCsvExport;
+    private isBlob;
+    private blobPromise;
+    private exportValueFormatter;
+    private isElementIdChanged;
+    private helper;
+    private groupedColLength;
+    private globalResolve;
+    private gridPool;
+    private locator;
+    private l10n;
+    private sheet;
+    /**
+     * Constructor for the Grid Excel Export module.
+     *
+     * @param {IGrid} parent - specifies the IGrid
+     * @param {ServiceLocator} locator - specifies the ServiceLocator
+     * @hidden
+     */
+    constructor(parent?: IGrid, locator?: ServiceLocator);
+    /**
+     * For internal use only - Get the module name.
+     *
+     * @returns {string} returns the module name
+     */
+    private getModuleName;
+    private init;
+    /**
+     * Export Grid to Excel file.
+     *
+     * @param {IGrid} grid - Defines the grid.
+     * @param  {exportProperties} exportProperties - Defines the export properties of the Grid.
+     * @param  {isMultipleExport} isMultipleExport - Defines is multiple Grid's are exported.
+     * @param  {Workbook} workbook - Defined the Workbook if multiple Grid is exported.
+     * @param  {boolean} isCsv - true if export to CSV.
+     * @param {boolean} isBlob - true if isBlob is enabled.
+     * @returns {Promise<any>} - Returns the map for export.
+     */
+    Map(grid: IGrid, exportProperties: ExcelExportProperties, isMultipleExport: boolean, workbook: Workbook, isCsv: boolean, isBlob: boolean): Promise<any>;
+    private exportingSuccess;
+    private processRecords;
+    private processInnerRecords;
+    private organiseRows;
+    private processGridExport;
+    private processRecordContent;
+    private processGroupedRows;
+    private processRecordRows;
+    private setImage;
+    private childGridCell;
+    private processAggregates;
+    private fillAggregates;
+    private aggregateStyle;
+    private getAggreateValue;
+    private mergeOptions;
+    private getColumnStyle;
+    private headerRotation;
+    private processHeaderContent;
+    private getHeaderThemeStyle;
+    private updateThemeStyle;
+    private getCaptionThemeStyle;
+    private getRecordThemeStyle;
+    private processExcelHeader;
+    private updatedCellIndex;
+    private processExcelFooter;
+    private getIndex;
+    private parseStyles;
+    destroy(): void;
+}