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

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

@@ -0,0 +1,53 @@
+import { FilterSettings } from '../base/grid';
+import { IGrid, IFilterArgs, FilterUI } from '../base/interface';
+import { ServiceLocator } from '../services/service-locator';
+import { ExcelFilterBase } from '../common/excel-filter-base';
+import { CheckBoxFilter } from './checkbox-filter';
+import { Column } from '../models/column';
+/**
+ * @hidden
+ * `ExcelFilter` module is used to handle filtering action.
+ */
+export declare class ExcelFilter extends CheckBoxFilter {
+    protected parent: IGrid;
+    excelFilterBase: ExcelFilterBase;
+    isresetFocus: boolean;
+    /**
+     * Constructor for excelbox filtering module
+     *
+     * @param {IGrid} parent - specifies the IGrid
+     * @param {FilterSettings} filterSettings - specifies the Filtersettings
+     * @param {ServiceLocator} serviceLocator - specifies the serviceLocator
+     * @param {object} customFltrOperators - specifies the customFltrOperators
+     * @hidden
+     */
+    constructor(parent?: IGrid, filterSettings?: FilterSettings, serviceLocator?: ServiceLocator, customFltrOperators?: Object);
+    /**
+     * To destroy the excel filter.
+     *
+     * @returns {void}
+     * @hidden
+     */
+    destroy(): void;
+    openDialog(options: IFilterArgs): void;
+    closeDialog(): void;
+    protected clearCustomFilter(col: Column): void;
+    protected closeResponsiveDialog(isCustomFilter?: boolean): void;
+    protected applyCustomFilter(args?: {
+        col: Column;
+        isCustomFilter: boolean;
+    }): void;
+    filterByColumn(fieldName: string, firstOperator: string, firstValue: string | number | Date | boolean, predicate?: string, matchCase?: boolean, ignoreAccent?: boolean, secondOperator?: string, secondValue?: string | number | Date | boolean): void;
+    /**
+     * @returns {FilterUI} returns the filterUI
+     * @hidden
+     */
+    getFilterUIInfo(): FilterUI;
+    /**
+     * For internal use only - Get the module name.
+     *
+     * @returns {string} returns the module name
+     * @private
+     */
+    protected getModuleName(): string;
+}

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

@@ -0,0 +1,67 @@
+import { Column } from './../models/column';
+import { Row } from './../models/row';
+import { IGrid, ExportHelperArgs, ForeignKeyFormat } from '../base/interface';
+import { Query } from '@syncfusion/ej2-data';
+import { Data } from '../actions/data';
+import { Grid } from '../base/grid';
+/**
+ * @hidden
+ * `ExportHelper` for `PdfExport` & `ExcelExport`
+ */
+export declare class ExportHelper {
+    parent: IGrid;
+    private colDepth;
+    private hideColumnInclude;
+    private foreignKeyData;
+    constructor(parent: IGrid, foreignKeyData?: {
+        [key: string]: Object[];
+    });
+    static getQuery(parent: IGrid, data: Data): Query;
+    getFData(value: string, column: Column): Object;
+    getGridRowModel(columns: Column[], dataSource: Object[], gObj: IGrid, startIndex?: number): Row<Column>[];
+    private generateCells;
+    getColumnData(gridObj: Grid): Promise<Object>;
+    getHeaders(columns: Column[], isHideColumnInclude?: boolean): {
+        rows: Row<Column>[];
+        columns: Column[];
+    };
+    getConvertedWidth(input: string): number;
+    private generateActualColumns;
+    private processHeaderCells;
+    private appendGridCells;
+    private generateCell;
+    private processColumns;
+    private getCellCount;
+    checkAndExport(gridPool: Object, globalResolve: Function): void;
+    failureHandler(gridPool: Object, childGridObj: IGrid, resolve: Function): Function;
+    createChildGrid(gObj: IGrid, row: Row<Column>, exportType: string, gridPool: Object): {
+        childGrid: IGrid;
+        element: HTMLElement;
+    };
+    getGridExportColumns(columns: Column[]): Column[];
+    /**
+     * Gets the foreignkey data.
+     *
+     * @returns {ForeignKeyFormat} returns the foreignkey data
+     * @hidden
+     */
+    getForeignKeyData(): ForeignKeyFormat;
+}
+/**
+ * @hidden
+ * `ExportValueFormatter` for `PdfExport` & `ExcelExport`
+ */
+export declare class ExportValueFormatter {
+    private internationalization;
+    private valueFormatter;
+    constructor(culture: string);
+    private returnFormattedValue;
+    /**
+     * Used to format the exporting cell value
+     *
+     * @param  {ExportHelperArgs} args - Specifies cell details.
+     * @returns {string} returns formated value
+     * @hidden
+     */
+    formatCellValue(args: ExportHelperArgs): string;
+}

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

@@ -0,0 +1,253 @@
+import { FilterSettings } from '../base/grid';
+import { IGrid, IAction, NotifyArgs, IFilterOperator, FilterUI } from '../base/interface';
+import { PredicateModel } from '../base/grid-model';
+import { ServiceLocator } from '../services/service-locator';
+import { Column } from '../models/column';
+import { ResponsiveDialogRenderer } from '../renderer/responsive-dialog-renderer';
+/**
+ *
+ * The `Filter` module is used to handle filtering action.
+ */
+export declare class Filter implements IAction {
+    private filterSettings;
+    private element;
+    private value;
+    private predicate;
+    private operator;
+    private column;
+    private fieldName;
+    private matchCase;
+    private ignoreAccent;
+    private timer;
+    private filterStatusMsg;
+    private currentFilterObject;
+    private isRemove;
+    private contentRefresh;
+    private initialLoad;
+    private filterByMethod;
+    private refresh;
+    private values;
+    operators: Object;
+    private cellText;
+    private nextFlMenuOpen;
+    private refreshFilterValueFn;
+    private type;
+    /** @hidden */
+    filterModule: {
+        openDialog: Function;
+        closeDialog: Function;
+        destroy: Function;
+        isresetFocus: boolean;
+        getFilterUIInfo: Function;
+        clearCustomFilter: Function;
+        closeResponsiveDialog: Function;
+        applyCustomFilter: Function;
+        renderCheckBoxMenu?: Function;
+        afterRenderFilterUI?: Function;
+    };
+    /** @hidden */
+    filterOperators: IFilterOperator;
+    private fltrDlgDetails;
+    customOperators: Object;
+    /** @hidden */
+    skipNumberInput: string[];
+    skipStringInput: string[];
+    /** @hidden */
+    parent: IGrid;
+    /** @hidden */
+    serviceLocator: ServiceLocator;
+    private l10n;
+    private valueFormatter;
+    private actualPredicate;
+    prevFilterObject: PredicateModel;
+    filterObjIndex: number;
+    /** @hidden */
+    responsiveDialogRenderer: ResponsiveDialogRenderer;
+    menuOperator: {
+        [key: string]: Object;
+    }[];
+    private docClickHandler;
+    /**
+     * Constructor for Grid filtering module
+     *
+     * @param {IGrid} parent - specifies the IGrid
+     * @param {FilterSettings} filterSettings - specifies the filterSettings
+     * @param {ServiceLocator} serviceLocator - specifes the serviceLocator
+     * @hidden
+     */
+    constructor(parent?: IGrid, filterSettings?: FilterSettings, serviceLocator?: ServiceLocator);
+    /**
+     * To render filter bar when filtering enabled.
+     *
+     * @param {NotifyArgs} e - specifies the NotifyArgs
+     * @returns {void}
+     * @hidden
+     */
+    render(e?: NotifyArgs): void;
+    /**
+     * To show the responsive custom filter dialog
+     *
+     * @param {boolean} enable - specifes dialog open
+     * @returns {void}
+     * @hidden
+     */
+    showCustomFilter(enable: boolean): void;
+    /**
+     * To create the filter module.
+     *
+     * @param {Column} col - specifies the filtering column name
+     * @returns {void}
+     * @hidden
+     */
+    setFilterModel(col: Column): void;
+    /**
+     * To destroy the filter bar.
+     *
+     * @returns {void}
+     * @hidden
+     */
+    destroy(): void;
+    private setFullScreenDialog;
+    private generateRow;
+    private generateCells;
+    private generateCell;
+    /**
+     * To update filterSettings when applying filter.
+     *
+     * @returns {void}
+     * @hidden
+     */
+    updateModel(): void;
+    private getFilteredColsIndexByField;
+    /**
+     * To trigger action complete event.
+     *
+     * @param {NotifyArgs} e - specifies the NotifyArgs
+     * @returns {void}
+     * @hidden
+     */
+    onActionComplete(e: NotifyArgs): void;
+    private wireEvents;
+    private unWireEvents;
+    private enableAfterRender;
+    private refreshFilterValue;
+    private initialEnd;
+    /**
+     * @returns {void}
+     * @hidden
+     */
+    addEventListener(): void;
+    /**
+     * @returns {void}
+     * @hidden
+     */
+    removeEventListener(): void;
+    private refreshClearIcon;
+    private filterMenuClose;
+    /**
+     * Filters the Grid row by fieldName, filterOperator, and filterValue.
+     *
+     * @param  {string} fieldName - Defines the field name of the filter column.
+     * @param  {string} filterOperator - Defines the operator to filter records.
+     * @param  {string | number | Date | boolean} filterValue - Defines the value which is used to filter records.
+     * @param  {string} predicate - Defines the relationship of one filter query with another by using AND or OR predicate.
+     * @param  {boolean} matchCase - If match case is set to true, then the filter records
+     * the exact match or <br> filters records that are case insensitive (uppercase and lowercase letters treated the same).
+     * @param {boolean} ignoreAccent - If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
+     * @param  {string} actualFilterValue - Defines the actual filter value for the filter column.
+     * @param  {string} actualOperator - Defines the actual filter operator for the filter column.
+     * @returns {void}
+     */
+    filterByColumn(fieldName: string, filterOperator: string, filterValue: string | number | Date | boolean | number[] | string[] | Date[] | boolean[], predicate?: string, matchCase?: boolean, ignoreAccent?: boolean, actualFilterValue?: Object, actualOperator?: Object): void;
+    private applyColumnFormat;
+    private skipUid;
+    private onPropertyChanged;
+    private refreshFilterSettings;
+    private updateFilterIcon;
+    private getFilterBarElement;
+    /**
+     * @private
+     * @returns {void}
+     */
+    refreshFilter(): void;
+    /**
+     * Clears all the filtered rows of the Grid.
+     *
+     * @param {string[]} fields - returns the fields
+     * @returns {void}
+     */
+    clearFiltering(fields?: string[]): void;
+    private checkAlreadyColFiltered;
+    private columnMenuFilter;
+    private filterDialogOpen;
+    /**
+     * Create filter dialog options
+     *
+     * @param  {Column} col - Filtering column detail.
+     * @param  {Element} target -  Filter dialog target.
+     * @param  {number} left -  Filter dialog left position.
+     * @param  {number} top -  Filter dialog top position.
+     * @returns {Object} returns the created dialog options
+     * @hidden
+     */
+    createOptions(col: Column, target: Element, left?: number, top?: number): Object;
+    /**
+     * Removes filtered column by field name.
+     *
+     * @param  {string} field - Defines column field name to remove filter.
+     * @param  {boolean} isClearFilterBar - Specifies whether the filter bar value needs to be cleared.
+     * @returns {void}
+     * @hidden
+     */
+    removeFilteredColsByField(field: string, isClearFilterBar?: boolean): void;
+    /**
+     * For internal use only - Get the module name.
+     *
+     * @returns {string} returns the module name
+     * @private
+     */
+    protected getModuleName(): string;
+    private keyUpHandlerImmediate;
+    private keyUpHandler;
+    private updateCrossIcon;
+    private updateFilterMsg;
+    private setFormatForFlColumn;
+    private checkForSkipInput;
+    private processFilter;
+    private startTimer;
+    private stopTimer;
+    private onTimerTick;
+    private validateFilterValue;
+    private getOperator;
+    private columnPositionChanged;
+    private getLocalizedCustomOperators;
+    /**
+     * @param {string} field - specifies the field name
+     * @returns {void}
+     * @hidden
+     */
+    openMenuByField(field: string): void;
+    private filterIconClickHandler;
+    private clickHandler;
+    private filterHandler;
+    private updateFilter;
+    private refreshFilterIcon;
+    private addFilteredClass;
+    /**
+     * @hidden
+     * @returns {FilterUI} returns the FilterUI
+     */
+    getFilterUIInfo(): FilterUI;
+    /**
+     * @param {string} field - specifies the field name
+     * @returns {string} returns the operator name
+     * @hidden
+     */
+    private getOperatorName;
+    /**
+     * Renders checkbox items in Menu filter dialog.
+     *
+     * @returns {void}
+     */
+    renderCheckboxOnFilterMenu(): HTMLElement;
+}

package/src/grid/actions/foreign-key.d.ts

@@ -0,0 +1,20 @@
+import { IGrid } from '../base/interface';
+import { ServiceLocator } from '../services/service-locator';
+import { Data } from './data';
+/**
+ * `ForeignKey` module is used to handle foreign key column's actions.
+ */
+export declare class ForeignKey extends Data {
+    constructor(parent: IGrid, serviceLocator: ServiceLocator);
+    private initEvent;
+    private initForeignKeyColumns;
+    private eventfPromise;
+    private getForeignKeyData;
+    private generateQueryFormData;
+    private genarateQuery;
+    private genarateColumnQuery;
+    private isFiltered;
+    protected getModuleName(): string;
+    protected destroy(): void;
+    private destroyEvent;
+}

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

@@ -0,0 +1,17 @@
+import { IGrid, IAction } from '../base/interface';
+import { ServiceLocator } from '../services/service-locator';
+/**
+ * `Freeze` module is used to handle Frozen rows and columns.
+ *
+ * @hidden
+ */
+export declare class Freeze implements IAction {
+    private locator;
+    private parent;
+    constructor(parent: IGrid, locator?: ServiceLocator);
+    getModuleName(): string;
+    addEventListener(): void;
+    private instantiateRenderer;
+    removeEventListener(): void;
+    destroy(): void;
+}

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

@@ -0,0 +1,178 @@
+import { GroupSettingsModel } from '../base/grid-model';
+import { ServiceLocator } from '../services/service-locator';
+import { IGrid, IAction, NotifyArgs } from '../base/interface';
+/**
+ *
+ * The `Group` module is used to handle group action.
+ */
+export declare class Group implements IAction {
+    private sortRequired;
+    /** @hidden */
+    groupSettings: GroupSettingsModel;
+    /** @hidden */
+    element: HTMLElement;
+    /** @hidden */
+    groupSortFocus: boolean;
+    /** @hidden */
+    groupCancelFocus: boolean;
+    private colName;
+    private column;
+    private isAppliedGroup;
+    private isAppliedUnGroup;
+    private reorderingColumns;
+    private groupGenerator;
+    private visualElement;
+    private helper;
+    private dragStart;
+    private drag;
+    private dragStop;
+    private animateDropper;
+    private addLabel;
+    private rearrangeGroup;
+    private drop;
+    private parent;
+    private serviceLocator;
+    private contentRefresh;
+    private sortedColumns;
+    private l10n;
+    private aria;
+    private focus;
+    /**
+     * Constructor for Grid group module
+     *
+     * @param {IGrid} parent - specifies the IGrid
+     * @param {GroupSettingsModel} groupSettings - specifies the GroupSettingsModel
+     * @param {string[]} sortedColumns - specifies the sortedColumns
+     * @param {ServiceLocator} serviceLocator - specifies the serviceLocator
+     * @hidden
+     */
+    constructor(parent?: IGrid, groupSettings?: GroupSettingsModel, sortedColumns?: string[], serviceLocator?: ServiceLocator);
+    private columnDrag;
+    private columnDragStart;
+    private columnDrop;
+    /**
+     * @returns {void}
+     * @hidden
+     */
+    addEventListener(): void;
+    /**
+     * @returns {void}
+     * @hidden
+     */
+    removeEventListener(): void;
+    private initialEnd;
+    private keyPressHandler;
+    /**
+     * @returns {Element[]} - Return the focusable grouping items
+     * @hidden */
+    getFocusableGroupedItems(): Element[];
+    private wireEvent;
+    private unWireEvent;
+    private onFocusIn;
+    private onFocusOut;
+    private addOrRemoveFocus;
+    private clickHandler;
+    private unGroupFromTarget;
+    private toogleGroupFromHeader;
+    private applySortFromTarget;
+    /**
+     * Expands or collapses grouped rows by target element.
+     *
+     * @param  {Element} target - Defines the target element of the grouped row.
+     * @returns {void}
+     */
+    expandCollapseRows(target: Element): void;
+    private updateVirtualRows;
+    private expandCollapse;
+    /**
+     * Expands all the grouped rows of the Grid.
+     *
+     * @returns {void}
+     */
+    expandAll(): void;
+    /**
+     * Collapses all the grouped rows of the Grid.
+     *
+     * @returns {void}
+     */
+    collapseAll(): void;
+    /**
+     * The function is used to render grouping
+     *
+     * @returns {void}
+     * @hidden
+     */
+    render(): void;
+    private renderGroupDropArea;
+    private updateGroupDropArea;
+    private initDragAndDrop;
+    private initializeGHeaderDrag;
+    private initializeGHeaderDrop;
+    /**
+     * Groups a column by column name.
+     *
+     * @param  {string} columnName - Defines the column name to group.
+     * @returns {void}
+     */
+    groupColumn(columnName: string): void;
+    /**
+     * Ungroups a column by column name.
+     *
+     * @param  {string} columnName - Defines the column name to ungroup.
+     * @returns {void}
+     */
+    ungroupColumn(columnName: string): void;
+    /**
+     * The function used to update groupSettings
+     *
+     * @returns {void}
+     * @hidden
+     */
+    updateModel(): void;
+    /**
+     * The function used to trigger onActionComplete
+     *
+     * @param {NotifyArgs} e - specifies the NotifyArgs
+     * @returns {void}
+     * @hidden
+     */
+    onActionComplete(e: NotifyArgs): void;
+    private groupAddSortingQuery;
+    private createElement;
+    private addColToGroupDrop;
+    private createSeparator;
+    private refreshToggleBtn;
+    private removeColFromGroupDrop;
+    private onPropertyChanged;
+    private updateGroupedColumn;
+    private updateButtonVisibility;
+    private enableAfterRender;
+    /**
+     * To destroy the reorder
+     *
+     * @returns {void}
+     * @hidden
+     */
+    destroy(): void;
+    /**
+     * Clears all the grouped columns of the Grid.
+     *
+     * @returns {void}
+     */
+    clearGrouping(): void;
+    /**
+     * For internal use only - Get the module name.
+     *
+     * @returns {string} returns the module name
+     * @private
+     */
+    protected getModuleName(): string;
+    private refreshSortIcons;
+    private getGHeaderCell;
+    private onGroupAggregates;
+    private iterateGroupAggregates;
+    updateExpand(args: {
+        uid?: string;
+        isExpand?: boolean;
+    }): void;
+}