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

package/src/grid/base.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Base export
+ */
+export * from './base/grid';
+export * from './base/grid-model';
+export * from './base/enum';
+export * from './base/interface';
+export * from './base/util';
+export * from './base/type';
+export * from './base/constant';
+export * from './base/string-literals';

package/src/grid/column-chooser.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Column chooser export
+ */
+export * from './actions/column-chooser';

package/src/grid/column-menu.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Column menu export
+ */
+export * from './actions/column-menu';

package/src/grid/command-column.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Command column export
+ */
+export * from './actions/command-column';

package/src/grid/common/checkbox-filter-base.d.ts

@@ -0,0 +1,137 @@
+import { L10n } from '@syncfusion/ej2-base';
+import { Query, Predicate } from '@syncfusion/ej2-data';
+import { IFilterArgs, FilterSearchBeginEventArgs } from '../base/interface';
+import { PredicateModel } from '../base/grid-model';
+import { ValueFormatter } from '../services/value-formatter';
+import { Column } from '../models/column';
+import { Dialog } from '@syncfusion/ej2-popups';
+import { IXLFilter } from '../common/filter-interface';
+/**
+ * @hidden
+ * `CheckBoxFilterBase` module is used to handle filtering action.
+ */
+export declare class CheckBoxFilterBase {
+    protected sBox: HTMLElement;
+    protected isExcel: boolean;
+    protected id: string;
+    protected colType: string;
+    protected fullData: Object[];
+    protected filteredData: Object[];
+    protected isFiltered: boolean | number;
+    protected dlg: Element;
+    protected dialogObj: Dialog;
+    protected cBox: HTMLElement;
+    protected spinner: HTMLElement;
+    protected searchBox: Element;
+    protected sInput: HTMLInputElement;
+    protected sIcon: Element;
+    /** @hidden */
+    options: IFilterArgs;
+    protected customQuery: boolean;
+    protected existingPredicate: {
+        [key: string]: PredicateModel[];
+    };
+    protected foreignKeyData: Object[];
+    protected foreignKeyQuery: Query;
+    /** @hidden */
+    filterState: boolean;
+    protected values: Object;
+    private cBoxTrue;
+    private cBoxFalse;
+    private itemsCnt;
+    private result;
+    protected renderEmpty: boolean;
+    protected parent: IXLFilter;
+    protected localeObj: L10n;
+    protected valueFormatter: ValueFormatter;
+    private searchHandler;
+    private isMenuNotEqual;
+    private isBlanks;
+    private isCheckboxFilterTemplate;
+    /**
+     * Constructor for checkbox filtering module
+     *
+     * @param {IXLFilter} parent - specifies the IXLFilter
+     * @hidden
+     */
+    constructor(parent?: IXLFilter);
+    /**
+     * @returns {void}
+     * @hidden
+     */
+    destroy(): void;
+    private wireEvents;
+    private unWireEvents;
+    protected foreignKeyFilter(args: Object, fColl?: Object[], mPredicate?: Predicate): void;
+    private foreignFilter;
+    private searchBoxClick;
+    private searchBoxKeyUp;
+    private updateSearchIcon;
+    /**
+     * Gets the localized label by locale keyword.
+     *
+     * @param {string} key - Defines localization key
+     * @returns {string} - returns localization label
+     */
+    getLocalizedLabel(key: string): string;
+    private updateDataSource;
+    protected updateModel(options: IFilterArgs): void;
+    protected getAndSetChkElem(options: IFilterArgs): HTMLElement;
+    protected showDialog(options: IFilterArgs): void;
+    private renderResponsiveFilter;
+    private dialogCreated;
+    openDialog(options: IFilterArgs): void;
+    closeDialog(): void;
+    /**
+     * @param {Column} col - Defines column details
+     * @returns {void}
+     * @hidden
+     */
+    clearFilter(col?: Column): void;
+    private btnClick;
+    /**
+     * @returns {void}
+     * @hidden
+     */
+    fltrBtnHandler(): void;
+    /** @hidden */
+    static generateNullValuePredicates(defaults: {
+        predicate?: string;
+        field?: string;
+        type?: string;
+        uid?: string;
+        operator?: string;
+        matchCase?: boolean;
+        ignoreAccent?: boolean;
+    }): PredicateModel[];
+    /** @hidden */
+    initiateFilter(fColl: PredicateModel[]): void;
+    protected isForeignColumn(col: Column): boolean;
+    private refreshCheckboxes;
+    protected search(args: FilterSearchBeginEventArgs, query: Query): void;
+    private getPredicateFromCols;
+    protected getQuery(): Query;
+    private getAllData;
+    private addDistinct;
+    private filterEvent;
+    private processDataOperation;
+    private dataSuccess;
+    private queryGenerate;
+    private processDataSource;
+    private processSearch;
+    private updateResult;
+    private clickHandler;
+    private keyupHandler;
+    private setFocus;
+    private updateAllCBoxes;
+    private dialogOpen;
+    private createCheckbox;
+    private updateIndeterminatenBtn;
+    private createFilterItems;
+    private getCheckedState;
+    static getDistinct(json: Object[], field: string, column?: Column, foreignKeyData?: Object[]): Object;
+    static getPredicate(columns: PredicateModel[]): Predicate;
+    private static generatePredicate;
+    private static getCaseValue;
+    private static updateDateFilter;
+}

package/src/grid/common/excel-filter-base.d.ts

@@ -0,0 +1,115 @@
+import { IFilterArgs, FilterUI } from '../base/interface';
+import { ContextMenu, MenuEventArgs } from '@syncfusion/ej2-navigations';
+import { CheckBoxFilterBase } from '../common/checkbox-filter-base';
+import { IXLFilter } from '../common/filter-interface';
+/**
+ * @hidden
+ * `ExcelFilter` module is used to handle filtering action.
+ */
+export declare class ExcelFilterBase extends CheckBoxFilterBase {
+    private dlgDiv;
+    private dlgObj;
+    private customFilterOperators;
+    private optrData;
+    private menuItem;
+    private menu;
+    private cmenu;
+    protected menuObj: ContextMenu;
+    private isCMenuOpen;
+    private firstOperator;
+    private secondOperator;
+    private childRefs;
+    private eventHandlers;
+    private isDevice;
+    /**
+     * Constructor for excel filtering module
+     *
+     * @param {IXLFilter} parent - parent details
+     * @param {Object} customFltrOperators - operator details
+     * @hidden
+     */
+    constructor(parent?: IXLFilter, customFltrOperators?: Object);
+    private getCMenuDS;
+    /**
+     * To destroy the filter bar.
+     *
+     * @returns {void}
+     * @hidden
+     */
+    destroy(): void;
+    private createMenu;
+    private createMenuElem;
+    private wireExEvents;
+    private unwireExEvents;
+    private clickExHandler;
+    private destroyCMenu;
+    private hoverHandler;
+    private ensureTextFilter;
+    private preventClose;
+    private getContextBounds;
+    private getCMenuYPosition;
+    openDialog(options: IFilterArgs): void;
+    closeDialog(): void;
+    private selectHandler;
+    /**
+     * @hidden
+     * @param {MenuEventArgs} e - event args
+     * @returns {void}
+     */
+    renderDialogue(e?: MenuEventArgs): void;
+    private renderResponsiveDialog;
+    /**
+     * @hidden
+     * @returns {void}
+     */
+    removeDialog(): void;
+    private createdDialog;
+    private renderCustomFilter;
+    /**
+     * @hidden
+     * @param {string} col - Defines column details
+     * @returns {void}
+     */
+    filterBtnClick(col: string): void;
+    /**
+     * @hidden
+     * Filters grid row by column name with given options.
+     *
+     * @param {string} fieldName - Defines the field name of the filter column.
+     * @param {string} firstOperator - Defines the first operator by how to filter records.
+     * @param {string | number | Date | boolean} firstValue - Defines the first value which is used to filter records.
+     * @param  {string} predicate - Defines the relationship between one filter query with another by using AND or OR predicate.
+     * @param {boolean} matchCase - If ignore case set to true, then filter records with exact match or else
+     * filter records with case insensitive(uppercase and lowercase letters treated as same).
+     * @param {boolean} ignoreAccent - If ignoreAccent set to true, then ignores the diacritic characters or accents when filtering.
+     * @param {string} secondOperator - Defines the second operator by how to filter records.
+     * @param {string | number | Date | boolean} secondValue - Defines the first value which is used to filter records.
+     * @returns {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;
+    private renderOperatorUI;
+    private removeHandlersFromComponent;
+    private dropDownOpen;
+    private dropDownValueChange;
+    /**
+     * @hidden
+     * @returns {FilterUI} returns filter UI
+     */
+    getFilterUIInfo(): FilterUI;
+    private getSelectedValue;
+    private dropSelectedVal;
+    private getSelectedText;
+    private renderFilterUI;
+    private renderRadioButton;
+    private removeObjects;
+    private renderFlValueUI;
+    private getExcelFilterData;
+    private renderMatchCase;
+    private renderDate;
+    private renderDateTime;
+    private completeAction;
+    private renderNumericTextBox;
+    private renderAutoComplete;
+    private acActionComplete;
+    private acFocus;
+}

package/src/grid/common/filter-interface.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Defines the excel filter interface.
+ */
+import { Component } from '@syncfusion/ej2-base';
+import { DataManager, Deferred } from '@syncfusion/ej2-data';
+import { DataStateChangeEventArgs } from '../base/interface';
+import { LoadingIndicatorModel } from '../base/grid-model';
+/** @hidden */
+export interface XLColumn {
+    field?: string;
+}
+/** @hidden */
+export interface XLFilterSettings {
+    columns?: XLColumn[];
+}
+/** @hidden */
+export interface XLSearchSettings {
+    key?: string;
+}
+/** @hidden */
+export interface IXLFilter extends Component<HTMLElement> {
+    filterSettings?: XLFilterSettings;
+    destroyTemplate?: Function;
+    getQuery?: Function;
+    searchSettings?: XLSearchSettings;
+    getColumnByField?: Function;
+    getColumnHeaderByUid?: Function;
+    dataSource?: Object[] | DataManager;
+    getForeignKeyColumns?: Function;
+    isReact?: boolean;
+    isVue?: boolean;
+    renderTemplates?: Function;
+    allowSorting?: boolean;
+    cssClass?: string;
+    loadingIndicator?: LoadingIndicatorModel;
+    showMaskRow?: Function;
+}
+/** @hidden */
+export interface FilterStateObj {
+    state: DataStateChangeEventArgs;
+    deffered: Deferred;
+}

package/src/grid/common/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Excel filter Base
+ */
+export * from './excel-filter-base';
+export * from './checkbox-filter-base';

package/src/grid/common.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Common export
+ */
+export * from './common/checkbox-filter-base';
+export * from './common/excel-filter-base';
+export * from './common/filter-interface';

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

@@ -0,0 +1,4 @@
+/**
+ * Context menu export
+ */
+export * from './actions/context-menu';

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

@@ -0,0 +1,4 @@
+/**
+ * Detail row export
+ */
+export * from './actions/detail-row';

package/src/grid/edit.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Edit export
+ */
+export * from './actions/edit';

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

@@ -0,0 +1,4 @@
+/**
+ * Excel Export exports
+ */
+export * from './actions/excel-export';

package/src/grid/filter.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Filter export
+ */
+export * from './actions/filter';

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

@@ -0,0 +1,4 @@
+/**
+ * Foreign Key export
+ */
+export * from './actions/foreign-key';

package/src/grid/freeze.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Freeze export
+ */
+export * from './actions/freeze';

package/src/grid/group.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Group export
+ */
+export * from './actions/group';

package/src/grid/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Grid component exported items
+ */
+export * from './common';
+export * from './base';
+export * from './actions';
+export * from './models';
+export * from './renderer';
+export * from './services';

package/src/grid/infinite-scroll.d.ts

@@ -0,0 +1,4 @@
+/**
+ * infinite-scroll export
+ */
+export * from './actions/infinite-scroll';

package/src/grid/lazy-load-group.d.ts

@@ -0,0 +1,4 @@
+/**
+ * group-lazy-load export
+ */
+export * from './actions/lazy-load-group';

package/src/grid/logger.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Logger export
+ */
+export * from './actions/logger';

package/src/grid/models/aggregate.d.ts

@@ -0,0 +1,138 @@
+import { CustomSummaryType } from '../base/type';
+import { AggregateType, CellType } from '../base/enum';
+import { ChildProperty, NumberFormatOptions, DateFormatOptions } from '@syncfusion/ej2-base';
+import { AggregateColumnModel } from './aggregate-model';
+/**
+ * Configures the Grid's aggregate column.
+ */
+export declare class AggregateColumn extends ChildProperty<AggregateColumn> {
+    private formatFn;
+    private templateFn;
+    /**
+     * Defines the aggregate type of a particular column.
+     * To use multiple aggregates for single column, specify the `type` as array.
+     * Types of aggregate are,
+     * * sum
+     * * average
+     * * max
+     * * min
+     * * count
+     * * truecount
+     * * falsecount
+     * * custom
+     * > Specify the `type` value as `custom` to use custom aggregation.
+     *
+     * @aspType string
+     * @default null
+     */
+    type: AggregateType | AggregateType[] | string;
+    /**
+     * Defines the column name to perform aggregation.
+     *
+     * @default null
+     */
+    field: string;
+    /**
+     * Defines the column name to display the aggregate value. If `columnName` is not defined,
+     * then `field` name value will be assigned to the `columnName` property.
+     *
+     * @default null
+     */
+    columnName: string;
+    /**
+     * Format is applied to a calculated value before it is displayed.
+     * Gets the format from the user, which can be standard or custom
+     * [`number`](../../common/internationalization/#number-formatting/)
+     * and [`date`](../../common/internationalization/#number-formatting/) formats.
+     *
+     * @aspType string
+     * @blazorType string
+     * @default null
+     */
+    format: string | NumberFormatOptions | DateFormatOptions;
+    /**
+     * Defines the footer cell template as a string for the aggregate column.
+     * The `type` name should be used to access aggregate values inside the template.
+     *
+     * {% codeBlock src="grid/footer-template-api/index.ts" %}{% endcodeBlock %}
+     *
+     * @default null
+     */
+    footerTemplate: string;
+    /**
+     * Defines the group footer cell template as a string for the aggregate column.
+     * The `type` name should be used to access aggregate values inside the template.
+     * Additionally, the following fields can be accessed in the template.
+     * * **field**: The current grouped field.
+     * * **key**: The current grouped value.
+     *
+     * {% codeBlock src="grid/group-footer-api/index.ts" %}{% endcodeBlock %}
+     *
+     * @default null
+     */
+    groupFooterTemplate: string;
+    /**
+     * Defines the group caption cell template as a string for the aggregate column.
+     * The `type` name should be used to access aggregate values inside the template.
+     * Additionally, the following fields can be accessed in the template.
+     * * **field**: The current grouped field name.
+     * * **key**: The current grouped field value.
+     *
+     * {% codeBlock src="grid/group-caption-api/index.ts" %}{% endcodeBlock %}
+     *
+     * @default null
+     */
+    groupCaptionTemplate: string;
+    /**
+     * Defines a function to calculate custom aggregate value. The `type` value should be set to `custom`.
+     * To use custom aggregate value in the template, use the key as `${custom}`.
+     * **Total aggregation**: The custom function will be called with the whole data and the current `AggregateColumn` object.
+     * **Group aggregation**: This will be called with the current group details and the `AggregateColumn` object.
+     *
+     * @default null
+     */
+    customAggregate: CustomSummaryType | string;
+    /**
+     * @param {Function} value - specifies the value
+     * @returns {void}
+     * @hidden
+     */
+    setFormatter(value: Function): void;
+    /**
+     * @returns {Function} returns the Function
+     * @hidden
+     */
+    getFormatter(): Function;
+    /**
+     * @param {Object} helper - specifies the helper
+     * @returns {void}
+     * @hidden
+     */
+    setTemplate(helper?: Object): void;
+    /**
+     * @param {CellType} type - specifies the cell type
+     * @returns {Object} returns the object
+     * @hidden
+     */
+    getTemplate(type: CellType): {
+        fn: Function;
+        property: string;
+    };
+    /**
+     * @param {Object} prop - returns the Object
+     * @returns {void}
+     * @hidden
+     */
+    setPropertiesSilent(prop: Object): void;
+}
+/**
+ * Configures the aggregate rows.
+ */
+export declare class AggregateRow extends ChildProperty<AggregateRow> {
+    /**
+     * Configures the aggregate columns.
+     *
+     * @default []
+     */
+    columns: AggregateColumnModel[];
+}

package/src/grid/models/cell.d.ts

@@ -0,0 +1,38 @@
+import { CellType } from '../base/enum';
+import { CommandModel } from '../base/interface';
+/**
+ * Cell
+ *
+ * @hidden
+ */
+export declare class Cell<T> {
+    colSpan: number;
+    rowSpan: number;
+    cellType: CellType;
+    visible: boolean;
+    isTemplate: boolean;
+    isDataCell: boolean;
+    isSelected: boolean;
+    isColumnSelected: boolean;
+    column: T;
+    rowID: string;
+    index: number;
+    colIndex: number;
+    className: string;
+    attributes: {
+        [a: string]: Object;
+    };
+    isSpanned: boolean;
+    cellSpan: number;
+    isRowSpanned: boolean;
+    rowSpanRange: number;
+    colSpanRange: number;
+    spanText: string | number | boolean | Date;
+    commands: CommandModel[];
+    isForeignKey: boolean;
+    foreignKeyData: Object;
+    constructor(options: {
+        [x: string]: Object;
+    });
+    clone(): Cell<T>;
+}

package/src/grid/models/column-chooser-settings.d.ts

@@ -0,0 +1,20 @@
+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;
+}