UNPKG

igniteui-angular-wrappers

Version:
498 lines (485 loc) 380 kB
import * as i0 from '@angular/core'; import { ElementRef, OnInit, AfterContentInit, DoCheck, OnChanges, OnDestroy, KeyValueDiffers, ChangeDetectorRef, Renderer2, IterableDiffers, SimpleChanges, QueryList, NgZone } from '@angular/core'; import { ControlValueAccessor, NgModel } from '@angular/forms'; declare class Column { _settings: any; private _el; constructor(el: ElementRef); createColumnsSetter(name: any): (value: any) => void; createColumnsGetter(name: any): () => any; static ɵfac: i0.ɵɵFactoryDeclaration<Column, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<Column, "column", never, { "headerText": { "alias": "headerText"; "required": false; }; "key": { "alias": "key"; "required": false; }; "formatter": { "alias": "formatter"; "required": false; }; "format": { "alias": "format"; "required": false; }; "dataType": { "alias": "dataType"; "required": false; }; "width": { "alias": "width"; "required": false; }; "hidden": { "alias": "hidden"; "required": false; }; "template": { "alias": "template"; "required": false; }; "unbound": { "alias": "unbound"; "required": false; }; "group": { "alias": "group"; "required": false; }; "rowspan": { "alias": "rowspan"; "required": false; }; "formula": { "alias": "formula"; "required": false; }; "unboundValues": { "alias": "unboundValues"; "required": false; }; "unboundValuesUpdateMode": { "alias": "unboundValuesUpdateMode"; "required": false; }; "headerCssClass": { "alias": "headerCssClass"; "required": false; }; "columnCssClass": { "alias": "columnCssClass"; "required": false; }; }, {}, never, never, false, never>; } declare class Feature<Model> implements OnInit { _el: any; _settings: any; initSettings: Model; name: string; private _events; private featureName; constructor(el: ElementRef); cloneObject(obj: any): any; ngOnInit(): void; createFeatureSetter(name: any): (value: any) => void; createFeatureGetter(name: any): () => any; createMethodGetter(name: any): () => any; normalizeName(str: any): any; static ɵfac: i0.ɵɵFactoryDeclaration<Feature<any>, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<Feature<any>, never, never, {}, {}, never, never, true, never>; } declare class IgGridMultiColumnHeadersFeature extends Feature<IgGridMultiColumnHeaders> { constructor(el: ElementRef); /** * Destroys the widget */ destroy(): void; /** * Collapses an expanded group. If the group is collapsed, the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. * This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. */ collapseGroup(groupKey: string, callback?: () => void): void; /** * Expands a collapsed group. If the group is expanded, the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. * This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. */ expandGroup(groupKey: string, callback?: () => void): void; /** * Returns multicolumn headers array. if there aren"t multicolumn headers returns undefined. */ getMultiColumnHeaders(): Array<Column>; /** * Toggles a collapsible group. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. * This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. */ toggleGroup(groupKey: string, callback?: () => void): void; static ɵfac: i0.ɵɵFactoryDeclaration<IgGridMultiColumnHeadersFeature, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<IgGridMultiColumnHeadersFeature, "multi-column-headers", never, { "inherit": { "alias": "inherit"; "required": false; }; }, { "groupCollapsing": "groupCollapsing"; "groupCollapsed": "groupCollapsed"; "groupExpanding": "groupExpanding"; "groupExpanded": "groupExpanded"; }, never, never, false, never>; } declare class IgGridSortingFeature extends Feature<IgGridSorting> { constructor(el: ElementRef); /** * Sorts the data in a grid column and updates the UI. * * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. * Specifies the column which we want to sort. If the mode is multiple, previous sorting states are not cleared. * @param direction Specifies sorting direction (ascending or descending) * @param header header */ sortColumn(index: object, direction: object, header: object): void; /** * Sorts the data in grid columns and updates the UI. */ sortMultiple(): void; /** * Removes current sorting(for all sorted columns) and updates the UI. */ clearSorting(): void; /** * Removes sorting for the grid column with the specified columnKey/columnIndex and updates the UI. * * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. * Specifies the column for which we want to remove sorting. If the mode is multiple, previous sorting states are not cleared. * @param header header */ unsortColumn(index: object, header: object): void; /** * Destroys the sorting feature. Unbinds events, removes added sorting elements, etc. */ destroy(): void; /** * Opens the multiple sorting dialog. */ openMultipleSortingDialog(): void; /** * Closes the multiple sorting dialog. */ closeMultipleSortingDialog(): void; /** * Renders content of multiple sorting dialog - sorted and unsorted columns. * * @param isToCallEvents - if specified client events should be fired */ renderMultipleSortingDialogContent(isToCallEvents: object): void; /** * Remove clear button for multiple sorting dialog */ removeDialogClearButton(): void; static ɵfac: i0.ɵɵFactoryDeclaration<IgGridSortingFeature, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<IgGridSortingFeature, "sorting", never, { "disabled": { "alias": "disabled"; "required": false; }; "create": { "alias": "create"; "required": false; }; "type": { "alias": "type"; "required": false; }; "caseSensitive": { "alias": "caseSensitive"; "required": false; }; "applySortedColumnCss": { "alias": "applySortedColumnCss"; "required": false; }; "sortUrlKey": { "alias": "sortUrlKey"; "required": false; }; "sortUrlKeyAscValue": { "alias": "sortUrlKeyAscValue"; "required": false; }; "sortUrlKeyDescValue": { "alias": "sortUrlKeyDescValue"; "required": false; }; "mode": { "alias": "mode"; "required": false; }; "customSortFunction": { "alias": "customSortFunction"; "required": false; }; "firstSortDirection": { "alias": "firstSortDirection"; "required": false; }; "sortedColumnTooltip": { "alias": "sortedColumnTooltip"; "required": false; }; "modalDialogSortOnClick": { "alias": "modalDialogSortOnClick"; "required": false; }; "modalDialogSortByButtonText": { "alias": "modalDialogSortByButtonText"; "required": false; }; "modalDialogResetButtonLabel": { "alias": "modalDialogResetButtonLabel"; "required": false; }; "modalDialogCaptionButtonDesc": { "alias": "modalDialogCaptionButtonDesc"; "required": false; }; "modalDialogCaptionButtonAsc": { "alias": "modalDialogCaptionButtonAsc"; "required": false; }; "modalDialogCaptionButtonUnsort": { "alias": "modalDialogCaptionButtonUnsort"; "required": false; }; "modalDialogWidth": { "alias": "modalDialogWidth"; "required": false; }; "modalDialogHeight": { "alias": "modalDialogHeight"; "required": false; }; "modalDialogAnimationDuration": { "alias": "modalDialogAnimationDuration"; "required": false; }; "featureChooserText": { "alias": "featureChooserText"; "required": false; }; "unsortedColumnTooltip": { "alias": "unsortedColumnTooltip"; "required": false; }; "columnSettings": { "alias": "columnSettings"; "required": false; }; "modalDialogCaptionText": { "alias": "modalDialogCaptionText"; "required": false; }; "modalDialogButtonApplyText": { "alias": "modalDialogButtonApplyText"; "required": false; }; "modalDialogButtonCancelText": { "alias": "modalDialogButtonCancelText"; "required": false; }; "featureChooserSortAsc": { "alias": "featureChooserSortAsc"; "required": false; }; "featureChooserSortDesc": { "alias": "featureChooserSortDesc"; "required": false; }; "persist": { "alias": "persist"; "required": false; }; "sortingDialogContainment": { "alias": "sortingDialogContainment"; "required": false; }; "dialogWidget": { "alias": "dialogWidget"; "required": false; }; "inherit": { "alias": "inherit"; "required": false; }; }, { "columnSorting": "columnSorting"; "columnSorted": "columnSorted"; "modalDialogOpening": "modalDialogOpening"; "modalDialogOpened": "modalDialogOpened"; "modalDialogMoving": "modalDialogMoving"; "modalDialogClosing": "modalDialogClosing"; "modalDialogClosed": "modalDialogClosed"; "modalDialogContentsRendering": "modalDialogContentsRendering"; "modalDialogContentsRendered": "modalDialogContentsRendered"; "modalDialogSortingChanged": "modalDialogSortingChanged"; "modalDialogButtonUnsortClick": "modalDialogButtonUnsortClick"; "modalDialogSortClick": "modalDialogSortClick"; "modalDialogButtonApplyClick": "modalDialogButtonApplyClick"; "modalDialogButtonResetClick": "modalDialogButtonResetClick"; }, never, never, false, never>; } declare class IgGridFilteringFeature extends Feature<IgGridFiltering> { constructor(el: ElementRef); /** * Destroys the filtering widget - remove fitler row, unbinds events, returns the grid to its previous state. */ destroy(): void; /** * Returns the count of data records that match filtering conditions */ getFilteringMatchesCount(): number; /** * Toggle filter row when mode is simple or * [advancedModeEditorsVisible](ui.iggridfiltering#options:advancedModeEditorsVisible) is true. Otherwise show/hide advanced dialog. * * @param event Column key */ toggleFilterRowByFeatureChooser(event: string): void; /** * Applies filtering programmatically and updates the UI by default. * * @param expressions An array of filtering expressions, each one having the format {fieldName: , expr: , cond: , logic: } * where fieldName is the key of the column, expr is the actual expression string with which we would like to filter, * logic is 'AND' or 'OR', and cond is one of the following strings: "equals", "doesNotEqual", "contains", "doesNotContain", * "greaterThan", "lessThan", "greaterThanOrEqualTo", "lessThanOrEqualTo", "true", "false", "null", "notNull", "empty", "notEmpty", * "startsWith", "endsWith", "today", "yesterday", "on", "notOn", "thisMonth", "lastMonth", "nextMonth", "before", "after", "thisYear", * "lastYear", "nextYear". The difference between the empty and null filtering conditions is that empty includes null, NaN, and * undefined, as well as the empty string. * @param updateUI specifies whether the filter row should be also updated once the grid is filtered * @param addedFromAdvanced specifies whether the filter is added from advanced filtering */ filter(expressions: any[], updateUI?: boolean, addedFromAdvanced?: boolean): void; /** * Check whether filterCondition requires or not filtering expression * e.g. if filterCondition is "lastMonth", "thisMonth", "null", "notNull", "true", "false", etc. * then filtering expression is NOT required * * @param filterCondition filtering condition - e.g. "true", "false", "yesterday", "empty", "null", etc. */ requiresFilteringExpression(filterCondition: string): boolean; static ɵfac: i0.ɵɵFactoryDeclaration<IgGridFilteringFeature, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<IgGridFilteringFeature, "filtering", never, { "disabled": { "alias": "disabled"; "required": false; }; "create": { "alias": "create"; "required": false; }; "caseSensitive": { "alias": "caseSensitive"; "required": false; }; "filterSummaryAlwaysVisible": { "alias": "filterSummaryAlwaysVisible"; "required": false; }; "renderFC": { "alias": "renderFC"; "required": false; }; "filterSummaryTemplate": { "alias": "filterSummaryTemplate"; "required": false; }; "filterDropDownAnimations": { "alias": "filterDropDownAnimations"; "required": false; }; "filterDropDownAnimationDuration": { "alias": "filterDropDownAnimationDuration"; "required": false; }; "filterDropDownWidth": { "alias": "filterDropDownWidth"; "required": false; }; "filterDropDownHeight": { "alias": "filterDropDownHeight"; "required": false; }; "filterExprUrlKey": { "alias": "filterExprUrlKey"; "required": false; }; "filterDropDownItemIcons": { "alias": "filterDropDownItemIcons"; "required": false; }; "columnSettings": { "alias": "columnSettings"; "required": false; }; "type": { "alias": "type"; "required": false; }; "filterDelay": { "alias": "filterDelay"; "required": false; }; "mode": { "alias": "mode"; "required": false; }; "advancedModeEditorsVisible": { "alias": "advancedModeEditorsVisible"; "required": false; }; "advancedModeHeaderButtonLocation": { "alias": "advancedModeHeaderButtonLocation"; "required": false; }; "filterDialogWidth": { "alias": "filterDialogWidth"; "required": false; }; "filterDialogHeight": { "alias": "filterDialogHeight"; "required": false; }; "filterDialogFilterDropDownDefaultWidth": { "alias": "filterDialogFilterDropDownDefaultWidth"; "required": false; }; "filterDialogExprInputDefaultWidth": { "alias": "filterDialogExprInputDefaultWidth"; "required": false; }; "filterDialogColumnDropDownDefaultWidth": { "alias": "filterDialogColumnDropDownDefaultWidth"; "required": false; }; "renderFilterButton": { "alias": "renderFilterButton"; "required": false; }; "filterButtonLocation": { "alias": "filterButtonLocation"; "required": false; }; "nullTexts": { "alias": "nullTexts"; "required": false; }; "labels": { "alias": "labels"; "required": false; }; "tooltipTemplate": { "alias": "tooltipTemplate"; "required": false; }; "filterDialogAddConditionTemplate": { "alias": "filterDialogAddConditionTemplate"; "required": false; }; "filterDialogAddConditionDropDownTemplate": { "alias": "filterDialogAddConditionDropDownTemplate"; "required": false; }; "filterDialogFilterTemplate": { "alias": "filterDialogFilterTemplate"; "required": false; }; "filterDialogFilterConditionTemplate": { "alias": "filterDialogFilterConditionTemplate"; "required": false; }; "filterDialogAddButtonWidth": { "alias": "filterDialogAddButtonWidth"; "required": false; }; "filterDialogOkCancelButtonWidth": { "alias": "filterDialogOkCancelButtonWidth"; "required": false; }; "filterDialogMaxFilterCount": { "alias": "filterDialogMaxFilterCount"; "required": false; }; "filterDialogContainment": { "alias": "filterDialogContainment"; "required": false; }; "showEmptyConditions": { "alias": "showEmptyConditions"; "required": false; }; "showNullConditions": { "alias": "showNullConditions"; "required": false; }; "featureChooserText": { "alias": "featureChooserText"; "required": false; }; "featureChooserTextHide": { "alias": "featureChooserTextHide"; "required": false; }; "featureChooserTextAdvancedFilter": { "alias": "featureChooserTextAdvancedFilter"; "required": false; }; "dialogWidget": { "alias": "dialogWidget"; "required": false; }; "persist": { "alias": "persist"; "required": false; }; "inherit": { "alias": "inherit"; "required": false; }; }, { "dataFiltering": "dataFiltering"; "dataFiltered": "dataFiltered"; "dropDownOpening": "dropDownOpening"; "dropDownOpened": "dropDownOpened"; "dropDownClosing": "dropDownClosing"; "dropDownClosed": "dropDownClosed"; "filterDialogOpening": "filterDialogOpening"; "filterDialogOpened": "filterDialogOpened"; "filterDialogMoving": "filterDialogMoving"; "filterDialogFilterAdding": "filterDialogFilterAdding"; "filterDialogFilterAdded": "filterDialogFilterAdded"; "filterDialogClosing": "filterDialogClosing"; "filterDialogClosed": "filterDialogClosed"; "filterDialogContentsRendering": "filterDialogContentsRendering"; "filterDialogContentsRendered": "filterDialogContentsRendered"; "filterDialogFiltering": "filterDialogFiltering"; }, never, never, false, never>; } declare class IgGridPagingFeature extends Feature<IgGridPaging> { constructor(el: ElementRef); /** * Gets/Sets the current page index, delegates data binding and paging to [$.ig.DataSource](ig.datasource). * * @param index The page index to go to. */ pageIndex(index?: number): number; /** * Gets/Sets the page size. If no parameter is specified, just returns the current page size. * * @param size The new page size. */ pageSize(size?: number): number; /** * Destroys the igGridPaging feature by removing all elements in the pager area, * unbinding events, and resetting data to discard data filtering on paging. */ destroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<IgGridPagingFeature, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<IgGridPagingFeature, "paging", never, { "disabled": { "alias": "disabled"; "required": false; }; "create": { "alias": "create"; "required": false; }; "pageSize": { "alias": "pageSize"; "required": false; }; "recordCountKey": { "alias": "recordCountKey"; "required": false; }; "pageSizeUrlKey": { "alias": "pageSizeUrlKey"; "required": false; }; "pageIndexUrlKey": { "alias": "pageIndexUrlKey"; "required": false; }; "currentPageIndex": { "alias": "currentPageIndex"; "required": false; }; "type": { "alias": "type"; "required": false; }; "showPageSizeDropDown": { "alias": "showPageSizeDropDown"; "required": false; }; "pageSizeDropDownLabel": { "alias": "pageSizeDropDownLabel"; "required": false; }; "pageSizeDropDownTrailingLabel": { "alias": "pageSizeDropDownTrailingLabel"; "required": false; }; "pageSizeDropDownLocation": { "alias": "pageSizeDropDownLocation"; "required": false; }; "showPagerRecordsLabel": { "alias": "showPagerRecordsLabel"; "required": false; }; "pagerRecordsLabelTemplate": { "alias": "pagerRecordsLabelTemplate"; "required": false; }; "nextPageLabelText": { "alias": "nextPageLabelText"; "required": false; }; "prevPageLabelText": { "alias": "prevPageLabelText"; "required": false; }; "firstPageLabelText": { "alias": "firstPageLabelText"; "required": false; }; "lastPageLabelText": { "alias": "lastPageLabelText"; "required": false; }; "showFirstLastPages": { "alias": "showFirstLastPages"; "required": false; }; "showPrevNextPages": { "alias": "showPrevNextPages"; "required": false; }; "currentPageDropDownLeadingLabel": { "alias": "currentPageDropDownLeadingLabel"; "required": false; }; "currentPageDropDownTrailingLabel": { "alias": "currentPageDropDownTrailingLabel"; "required": false; }; "currentPageDropDownTooltip": { "alias": "currentPageDropDownTooltip"; "required": false; }; "pageSizeDropDownTooltip": { "alias": "pageSizeDropDownTooltip"; "required": false; }; "pagerRecordsLabelTooltip": { "alias": "pagerRecordsLabelTooltip"; "required": false; }; "prevPageTooltip": { "alias": "prevPageTooltip"; "required": false; }; "nextPageTooltip": { "alias": "nextPageTooltip"; "required": false; }; "firstPageTooltip": { "alias": "firstPageTooltip"; "required": false; }; "lastPageTooltip": { "alias": "lastPageTooltip"; "required": false; }; "pageTooltipFormat": { "alias": "pageTooltipFormat"; "required": false; }; "pageSizeList": { "alias": "pageSizeList"; "required": false; }; "pageCountLimit": { "alias": "pageCountLimit"; "required": false; }; "visiblePageCount": { "alias": "visiblePageCount"; "required": false; }; "defaultDropDownWidth": { "alias": "defaultDropDownWidth"; "required": false; }; "delayOnPageChanged": { "alias": "delayOnPageChanged"; "required": false; }; "persist": { "alias": "persist"; "required": false; }; "inherit": { "alias": "inherit"; "required": false; }; }, { "pageIndexChanging": "pageIndexChanging"; "pageIndexChanged": "pageIndexChanged"; "pageSizeChanging": "pageSizeChanging"; "pageSizeChanged": "pageSizeChanged"; "pagerRendering": "pagerRendering"; "pagerRendered": "pagerRendered"; }, never, never, false, never>; } declare class IgGridUpdatingFeature extends Feature<IgGridUpdating> { constructor(el: ElementRef); /** * Sets a cell value for the specified cell. It also creates a transaction and updates the UI. * If the specified cell is currently in edit mode, the function will set the desired value in the cell's editor instead. * * @param rowId The primary key of the row the cell is a child of. * @param colKey The column key of the cell. * @param value The new value for the cell. */ setCellValue(rowId: object, colKey: string, value: object): void; /** * Sets values for specified cells in a row. It also creates a transaction and updates the UI. * If the specified row is currently in edit mode, the function will set the desired values in the row's editors instead. * * @param rowId The primary key of the row to update. * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . */ updateRow(rowId: any, values: object): void; /** * Adds a new row to the grid. It also creates a transaction and updates the UI. * * @param values Pairs of values in the format { column1Key: value1, column2Key: value2, ... } . */ addRow(values: object): void; /** * Deletes a row from the grid. It also creates a transaction and updates the UI. * * @param rowId The primary key of the row to delete. */ deleteRow(rowId: any): void; /** * Starts editing for the row or cell specified (depending on the [editMode](ui.iggridupdating#options:editMode)). * * @param rowId The row id. * @param column The column key or index. * @param raiseEvents Specifies whether or not updating events should be raised for this operation. */ startEdit(rowId: object, column: object, raiseEvents?: boolean): boolean; /** * Starts editing for adding a new row. * * @param raiseEvents Specifies whether or not updating events should be raised for this operation. */ startAddRowEdit(raiseEvents?: boolean): boolean; /** * Ends the currently active edit mode. * * @param update Specifies if the edit process should accept the current changes. Default is 'false'. * @param raiseEvents Specifies whether or not updating events should be raised for this operation. */ endEdit(update?: boolean, raiseEvents?: boolean): boolean; /** * Finds and returns the key of the first column the editor for which has invalid value. */ findInvalid(): string; /** * Checks if the grid is in edit mode. */ isEditing(): boolean; /** * Gets the editor for a column by the column key. That method can be used only after the editor has been created. * * @param key The key of the column. */ editorForKey(key: string): object; /** * Gets the editor for a column by the cell it resides in. If allowed the function can create the editor if it has not been created yet. * * @param cell Reference to the jQuery-wrapped TD object of the grid that the editor belongs to. * @param create Requests to create the editor if it has not been created yet. */ editorForCell(cell: string, create?: boolean): object; /** * Destroys igGridUpdating. */ destroy(): object; /** * Shows the delete button for specific row. * * @param row A jQuery object of the targeted row. */ showDeleteButtonFor(row: object): void; /** * Hides the delete button. */ hideDeleteButton(): void; static ɵfac: i0.ɵɵFactoryDeclaration<IgGridUpdatingFeature, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<IgGridUpdatingFeature, "updating", never, { "disabled": { "alias": "disabled"; "required": false; }; "create": { "alias": "create"; "required": false; }; "columnSettings": { "alias": "columnSettings"; "required": false; }; "editMode": { "alias": "editMode"; "required": false; }; "enableDeleteRow": { "alias": "enableDeleteRow"; "required": false; }; "enableAddRow": { "alias": "enableAddRow"; "required": false; }; "validation": { "alias": "validation"; "required": false; }; "doneLabel": { "alias": "doneLabel"; "required": false; }; "doneTooltip": { "alias": "doneTooltip"; "required": false; }; "cancelLabel": { "alias": "cancelLabel"; "required": false; }; "cancelTooltip": { "alias": "cancelTooltip"; "required": false; }; "addRowLabel": { "alias": "addRowLabel"; "required": false; }; "addRowTooltip": { "alias": "addRowTooltip"; "required": false; }; "deleteRowLabel": { "alias": "deleteRowLabel"; "required": false; }; "deleteRowTooltip": { "alias": "deleteRowTooltip"; "required": false; }; "showDoneCancelButtons": { "alias": "showDoneCancelButtons"; "required": false; }; "enableDataDirtyException": { "alias": "enableDataDirtyException"; "required": false; }; "startEditTriggers": { "alias": "startEditTriggers"; "required": false; }; "horizontalMoveOnEnter": { "alias": "horizontalMoveOnEnter"; "required": false; }; "excelNavigationMode": { "alias": "excelNavigationMode"; "required": false; }; "saveChangesSuccessHandler": { "alias": "saveChangesSuccessHandler"; "required": false; }; "saveChangesErrorHandler": { "alias": "saveChangesErrorHandler"; "required": false; }; "swipeDistance": { "alias": "swipeDistance"; "required": false; }; "wrapAround": { "alias": "wrapAround"; "required": false; }; "rowEditDialogOptions": { "alias": "rowEditDialogOptions"; "required": false; }; "dialogWidget": { "alias": "dialogWidget"; "required": false; }; "inherit": { "alias": "inherit"; "required": false; }; }, { "editRowStarting": "editRowStarting"; "editRowStarted": "editRowStarted"; "editRowEnding": "editRowEnding"; "editRowEnded": "editRowEnded"; "editCellStarting": "editCellStarting"; "editCellStarted": "editCellStarted"; "editCellEnding": "editCellEnding"; "editCellEnded": "editCellEnded"; "rowAdding": "rowAdding"; "rowAdded": "rowAdded"; "rowDeleting": "rowDeleting"; "rowDeleted": "rowDeleted"; "dataDirty": "dataDirty"; "generatePrimaryKeyValue": "generatePrimaryKeyValue"; "rowEditDialogBeforeOpen": "rowEditDialogBeforeOpen"; "rowEditDialogAfterOpen": "rowEditDialogAfterOpen"; "rowEditDialogBeforeClose": "rowEditDialogBeforeClose"; "rowEditDialogAfterClose": "rowEditDialogAfterClose"; "rowEditDialogContentsRendered": "rowEditDialogContentsRendered"; }, never, never, false, never>; } declare class IgGridGroupByFeature extends Feature<IgGridGroupBy> { constructor(el: ElementRef); /** * Open groupby modal dialog */ openGroupByDialog(): void; /** * Close groupby modal dialog */ closeGroupByDialog(): void; /** * Render groupby modal dialog and its content */ renderGroupByModalDialog(): void; /** * Open layouts dropdown */ openDropDown(): void; /** * Close layouts dropdown */ closeDropDown(): void; /** * Check whether column with specified key and layout is grouped * * @param key key of the column * @param layout layout name */ checkColumnIsGrouped(key: string, layout: string): void; /** * Get grouped data by value for the specific column. * NOTE: Before calling this function the data(that is passed as an argument) should be sorted by colKey. * * @param data data (sorted by colKey) that is used to get the records from. * @param colKey key of the column for which grouping will be applied. * @param idval value of the column by which grouping will be applied. */ getGroupedData(data: any[], colKey: string, idval?: string): any[]; /** * Adds a column to the group by columns list, executes the group by operation and updates the view. */ groupByColumns(): object; /** * Groups by a column * * @param key Column Key - group by the column with the specified key * @param layout layout is an optional parameter. * If set it means the grouped column is not in the root level but is a child layout column * @param sortingDirection if not set it is taken from option defaultSortingDirection */ groupByColumn(key: string, layout?: string, sortingDirection?: object): void; /** * Removes the specified column from the group by columns list, executes the group by operation and updates the view. * * @param key Column Key - ungroup by the column with the specified key * @param layout Layout is an optional parameter. * If set it means the grouped column is not in the root level but is a child layout column. */ ungroupByColumn(key: string, layout?: string): void; /** * Expand group row with specified id * * @param rowId data-id attribute of the group row in the DOM */ expand(rowId: string): void; /** * Expand group row with specified id * * @param rowId data-id attribute of the group row in the DOM */ collapse(rowId: string): void; /** * Clears the group by columns list and updates the view. */ ungroupAll(): void; /** * Destroys the group by feature object. */ destroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<IgGridGroupByFeature, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<IgGridGroupByFeature, "group-by", never, { "disabled": { "alias": "disabled"; "required": false; }; "create": { "alias": "create"; "required": false; }; "groupByAreaVisibility": { "alias": "groupByAreaVisibility"; "required": false; }; "initialExpand": { "alias": "initialExpand"; "required": false; }; "emptyGroupByAreaContent": { "alias": "emptyGroupByAreaContent"; "required": false; }; "emptyGroupByAreaContentSelectColumns": { "alias": "emptyGroupByAreaContentSelectColumns"; "required": false; }; "expansionIndicatorVisibility": { "alias": "expansionIndicatorVisibility"; "required": false; }; "groupByLabelWidth": { "alias": "groupByLabelWidth"; "required": false; }; "labelDragHelperOpacity": { "alias": "labelDragHelperOpacity"; "required": false; }; "indentation": { "alias": "indentation"; "required": false; }; "defaultSortingDirection": { "alias": "defaultSortingDirection"; "required": false; }; "groupedColumns": { "alias": "groupedColumns"; "required": false; }; "resultResponseKey": { "alias": "resultResponseKey"; "required": false; }; "groupedRowTextTemplate": { "alias": "groupedRowTextTemplate"; "required": false; }; "type": { "alias": "type"; "required": false; }; "groupByUrlKey": { "alias": "groupByUrlKey"; "required": false; }; "groupByUrlKeyAscValue": { "alias": "groupByUrlKeyAscValue"; "required": false; }; "groupByUrlKeyDescValue": { "alias": "groupByUrlKeyDescValue"; "required": false; }; "summarySettings": { "alias": "summarySettings"; "required": false; }; "columnSettings": { "alias": "columnSettings"; "required": false; }; "expandTooltip": { "alias": "expandTooltip"; "required": false; }; "collapseTooltip": { "alias": "collapseTooltip"; "required": false; }; "removeButtonTooltip": { "alias": "removeButtonTooltip"; "required": false; }; "modalDialogGroupByOnClick": { "alias": "modalDialogGroupByOnClick"; "required": false; }; "modalDialogGroupByButtonText": { "alias": "modalDialogGroupByButtonText"; "required": false; }; "modalDialogCaptionButtonDesc": { "alias": "modalDialogCaptionButtonDesc"; "required": false; }; "modalDialogCaptionButtonAsc": { "alias": "modalDialogCaptionButtonAsc"; "required": false; }; "modalDialogCaptionButtonUngroup": { "alias": "modalDialogCaptionButtonUngroup"; "required": false; }; "modalDialogCaptionText": { "alias": "modalDialogCaptionText"; "required": false; }; "modalDialogDropDownLabel": { "alias": "modalDialogDropDownLabel"; "required": false; }; "modalDialogRootLevelHierarchicalGrid": { "alias": "modalDialogRootLevelHierarchicalGrid"; "required": false; }; "modalDialogDropDownButtonCaption": { "alias": "modalDialogDropDownButtonCaption"; "required": false; }; "modalDialogClearAllButtonLabel": { "alias": "modalDialogClearAllButtonLabel"; "required": false; }; "emptyGroupByAreaContentSelectColumnsCaption": { "alias": "emptyGroupByAreaContentSelectColumnsCaption"; "required": false; }; "modalDialogDropDownWidth": { "alias": "modalDialogDropDownWidth"; "required": false; }; "modalDialogDropDownAreaWidth": { "alias": "modalDialogDropDownAreaWidth"; "required": false; }; "modalDialogAnimationDuration": { "alias": "modalDialogAnimationDuration"; "required": false; }; "modalDialogWidth": { "alias": "modalDialogWidth"; "required": false; }; "modalDialogHeight": { "alias": "modalDialogHeight"; "required": false; }; "modalDialogButtonApplyText": { "alias": "modalDialogButtonApplyText"; "required": false; }; "modalDialogButtonCancelText": { "alias": "modalDialogButtonCancelText"; "required": false; }; "useGridColumnFormatter": { "alias": "useGridColumnFormatter"; "required": false; }; "persist": { "alias": "persist"; "required": false; }; "groupByDialogContainment": { "alias": "groupByDialogContainment"; "required": false; }; "dialogWidget": { "alias": "dialogWidget"; "required": false; }; "inherit": { "alias": "inherit"; "required": false; }; }, { "groupedColumnsChanging": "groupedColumnsChanging"; "groupedColumnsChanged": "groupedColumnsChanged"; "modalDialogMoving": "modalDialogMoving"; "modalDialogClosing": "modalDialogClosing"; "modalDialogClosed": "modalDialogClosed"; "modalDialogOpening": "modalDialogOpening"; "modalDialogOpened": "modalDialogOpened"; "modalDialogContentsRendering": "modalDialogContentsRendering"; "modalDialogContentsRendered": "modalDialogContentsRendered"; "modalDialogButtonApplyClick": "modalDialogButtonApplyClick"; "modalDialogButtonResetClick": "modalDialogButtonResetClick"; "modalDialogGroupingColumn": "modalDialogGroupingColumn"; "modalDialogGroupColumn": "modalDialogGroupColumn"; "modalDialogUngroupingColumn": "modalDialogUngroupingColumn"; "modalDialogUngroupColumn": "modalDialogUngroupColumn"; "modalDialogSortGroupedColumn": "modalDialogSortGroupedColumn"; }, never, never, false, never>; } declare class IgGridColumnMovingFeature extends Feature<IgGridColumnMoving> { constructor(el: ElementRef); /** * Restoring overwritten functions */ destroy(): void; /** * Moves a visible column at a specified place, in front or behind a target column or at a target index * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. * This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param column An identifier of the column to be moved. * It can be a key, a Multi-Column Header identificator, or an index in a number format. * The latter is not supported when the grid contains multi-column headers. * @param target An identifier of a column where the moved column should move to or an index at which the moved column should * be moved to. In the case of a column identifier the column will be moved after it by default. * @param after Specifies whether the column moved should be moved after or before the target column. * @param inDom Specifies whether the column moving will be enacted through DOM manipulation or through rerendering of the grid. * @param callback Specifies a custom function to be called when the column is moved. */ moveColumn(column: object, target: object, after?: boolean, inDom?: boolean, callback?: () => void): void; static ɵfac: i0.ɵɵFactoryDeclaration<IgGridColumnMovingFeature, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<IgGridColumnMovingFeature, "column-moving", never, { "disabled": { "alias": "disabled"; "required": false; }; "create": { "alias": "create"; "required": false; }; "columnSettings": { "alias": "columnSettings"; "required": false; }; "mode": { "alias": "mode"; "required": false; }; "moveType": { "alias": "moveType"; "required": false; }; "addMovingDropdown": { "alias": "addMovingDropdown"; "required": false; }; "movingDialogWidth": { "alias": "movingDialogWidth"; "required": false; }; "movingDialogHeight": { "alias": "movingDialogHeight"; "required": false; }; "movingDialogAnimationDuration": { "alias": "movingDialogAnimationDuration"; "required": false; }; "movingAcceptanceTolerance": { "alias": "movingAcceptanceTolerance"; "required": false; }; "movingScrollTolerance": { "alias": "movingScrollTolerance"; "required": false; }; "scrollSpeedMultiplier": { "alias": "scrollSpeedMultiplier"; "required": false; }; "scrollDelta": { "alias": "scrollDelta"; "required": false; }; "hideHeaderContentsDuringDrag": { "alias": "hideHeaderContentsDuringDrag"; "required": false; }; "dragHelperOpacity": { "alias": "dragHelperOpacity"; "required": false; }; "movingDialogCaptionButtonDesc": { "alias": "movingDialogCaptionButtonDesc"; "required": false; }; "movingDialogCaptionButtonAsc": { "alias": "movingDialogCaptionButtonAsc"; "required": false; }; "movingDialogCaptionText": { "alias": "movingDialogCaptionText"; "required": false; }; "movingDialogDisplayText": { "alias": "movingDialogDisplayText"; "required": false; }; "movingDialogDropTooltipText": { "alias": "movingDialogDropTooltipText"; "required": false; }; "movingDialogDropTooltipMarkup": { "alias": "movingDialogDropTooltipMarkup"; "required": false; }; "dropDownMoveLeftText": { "alias": "dropDownMoveLeftText"; "required": false; }; "dropDownMoveRightText": { "alias": "dropDownMoveRightText"; "required": false; }; "dropDownMoveFirstText": { "alias": "dropDownMoveFirstText"; "required": false; }; "dropDownMoveLastText": { "alias": "dropDownMoveLastText"; "required": false; }; "movingToolTipMove": { "alias": "movingToolTipMove"; "required": false; }; "featureChooserSubmenuText": { "alias": "featureChooserSubmenuText"; "required": false; }; "columnMovingDialogContainment": { "alias": "columnMovingDialogContainment"; "required": false; }; "dialogWidget": { "alias": "dialogWidget"; "required": false; }; "inherit": { "alias": "inherit"; "required": false; }; }, { "columnDragStart": "columnDragStart"; "columnDragEnd": "columnDragEnd"; "columnDragCanceled": "columnDragCanceled"; "columnMoving": "columnMoving"; "columnMoved": "columnMoved"; "movingDialogOpening": "movingDialogOpening"; "movingDialogOpened": "movingDialogOpened"; "movingDialogDragged": "movingDialogDragged"; "movingDialogClosing": "movingDialogClosing"; "movingDialogClosed": "movingDialogClosed"; "movingDialogContentsRendering": "movingDialogContentsRendering"; "movingDialogContentsRendered": "movingDialogContentsRendered"; "movingDialogMoveUpButtonPressed": "movingDialogMoveUpButtonPressed"; "movingDialogMoveDownButtonPressed": "movingDialogMoveDownButtonPressed"; "movingDialogDragColumnMoving": "movingDialogDragColumnMoving"; "movingDialogDragColumnMoved": "movingDialogDragColumnMoved"; }, never, never, false, never>; } declare class IgGridHidingFeature extends Feature<IgGridHiding> { constructor(el: ElementRef); /** * Destroys the hiding widget */ destroy(): void; /** * Shows the Column Chooser dialog. If it is visible the method does nothing. */ showColumnChooser(): void; /** * Hides the Column Chooser dialog. If it is not visible the method does nothing. */ hideColumnChooser(): void; /** * Shows a hidden column. If the column is not hidden the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. * This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param column An identifier for the column. * If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. * @param isMultiColumnHeader If it is true then the column is of type multicolumnheader. * An identifier for the column should be of type string. * @param callback Specifies a custom function to be called when the column(s) is shown(optional) */ showColumn(column: object, isMultiColumnHeader?: boolean, callback?: () => void): void; /** * Hides a visible column. If the column is hidden the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. * This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param column An identifier for the column. * If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. * @param isMultiColumnHeader If it is true then the column is of type multicolumnheader. * An identifier for the column should be of type string. * @param callback Specifies a custom function to be called when the column is hidden(optional) */ hideColumn(column: object, isMultiColumnHeader?: boolean, callback?: () => void): void; /** * Hides visible columns specified by the array. If the column is hidden the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. * This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param columns An array of identifiers for the columns. * If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. * @param callback Specifies a custom function to be called when all columns are hidden(optional) */ hideMultiColumns(columns: any[], callback?: () => void): void; /** * Show visible columns specified by the array. If the column is shown the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. * This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. * * @param columns An array of identifiers for the columns. * If a number is provided it will be used as a column index else if a strings is provided it will be used as a column key. * @param callback Specifies a custom function to be called when all columns are shown(optional) */ showMultiColumns(columns: any[], callback?: () => void): void; /** * Gets whether the reset button in the column chooser dialog is to be rendered or not. */ isToRenderButtonReset(): void; /** * Reset hidden/shown column to initial state of dialog(when it is opened) */ resetHidingColumnChooser(): void; /** * Renders the Reset button in the Column Chooser dialog. */ renderColumnChooserResetButton(): void; /** * Remove Reset button in column chooser modal dialog */ removeColumnChooserResetButton(): void; static ɵfac: i0.ɵɵFactoryDeclaration<IgGridHidingFeature, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<IgGridHidingFeature, "hiding", never, { "disabled": { "alias": "disabled"; "required": false; }; "create": { "alias": "create"; "required": false; }; "columnSettings": { "alias": "columnSettings"; "required": false; }; "hiddenColumnIndicatorHeaderWidth": { "alias": "hiddenColumnIndicatorHeaderWidth"; "required": false; }; "columnChooserContainment": { "alias": "columnChooserContainment"; "required": false; }; "columnChooserWidth": { "alias": "columnChooserWidth"; "required": false; }; "columnChooserHeight": { "alias": "columnChooserHeight"; "required": false; }; "dropDownAnimationDuration": { "alias": "dropDownAnimationDuration"; "required": false; }; "columnChooserCaptionText": { "alias": "columnChooserCaptionText"; "required": false; }; "columnChooserDisplayText": { "alias": "columnChooserDisplayText"; "required": false; }; "hiddenColumnIndicatorTooltipText": { "alias": "hiddenColumnIndicatorTooltipText"; "required": false; }; "columnHideText": { "alias": "columnHideText"; "required": false; }; "columnChooserShowText": { "alias": "columnChooserShowText"; "required": false; }; "columnChooserHideText": { "alias": "columnChooserHideText"; "required": false; }; "columnChooserHideOnClick": { "alias": "columnChooserHideOnClick"; "required": false; }; "columnChooserResetButtonLabel": { "alias": "columnChooserResetButtonLabel"; "required": false; }; "columnChooserAnimationDuration": { "alias": "columnChooserAnimationDuration"; "required": false; }; "columnChooserButtonApplyText": { "alias": "columnChooserButtonApplyText"; "required": false; }; "columnChooserButtonCancelText": { "alias": "columnChooserButtonCancelText"; "required": false; }; "dialogWidget": { "alias": "dialogWidget"; "required": false; }; "inherit": { "alias": "inherit"; "required": false; }; }, { "columnHiding": "columnHiding"; "columnHidingRefused": "columnHidingRefused"; "columnShowingRefused": "columnShowingRefused"; "multiColumnHiding": "multiColumnHiding"; "columnHidden": "columnHidden"; "columnShowing": "columnShowing"; "columnShown": "columnShown"; "columnChooserOpening": "columnChooserOpening"; "columnChooserOpened": "columnChooserOpened"; "columnChooserMoving": "columnChooserMoving"; "columnChooserClosing": "columnChooserClosing"; "columnChooserClosed": "columnChooserClosed"; "columnChooserContentsRendering": "columnChooserContentsRendering"; "columnChooserContentsRendered": "columnChooserContentsRendered"; "columnChooserButtonApplyClick": "columnChooserButtonApplyClick"; "columnChooserButtonResetClick": "columnChooserButtonResetClick"; }, never, never, false, never>; } declare class IgGridCellMergingFeature extends Feature<IgGridCellMerging> { constructor(el: ElementRef); destroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<IgGridCellMergingFeature, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<IgGridCellMergingFeature, "cell-merging", never, { "disabled": { "alias": "disabled"; "required": false; }; "create": { "alias": "create"; "required": false; }; "initialState": { "alias": "initialState"; "required": false; }; "inherit": { "alias": "inherit"; "required": false; }; }, { "cellsMerging": "cellsMerging"; "cellsMerged": "cellsMerged"; }, never, never, false, never>; } declare class IgGridResponsiveFeature extends Feature<IgGridResponsive> { constructor(el: ElementRef); /** * Destroys the responsive widget. */ destroy(): void; /** * Returns the currently active responsive mode. */ getCurrentResponsiveMode(): void; static ɵfac: i0.ɵɵFactoryDeclaration<IgGridResponsiveFeature, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<IgGridResponsiveFeature, "responsive", never, { "disabled": { "alias": "disabled"; "required": false; }; "create": { "alias": "create"; "required": false; }; "columnSettings": { "alias": "columnSettings"; "required": false; }; "reactOnContainerWidthChanges": { "alias": "reactOnContainerWidthChanges"; "required": false; }; "forceResponsiveGridWidth": { "alias": "forceResponsiveGridWidth"; "required": false; }; "responsiveSensitivity": { "alias": "responsiveSensitivity"; "required": false; }; "responsiveModes": { "alias": "responsiveModes"; "required": false; }; "enableVerticalRendering": { "alias": "enableVerticalRendering"; "required": false; }; "windowWidthToRenderVertically": { "alias": "windowWidthToRenderVertically"; "required": false; }; "propertiesColumnWidth": { "alias": "propertiesColumnWidth"; "required": false; }; "valuesColumnWidth": { "alias": "valuesColumnWidth"; "required": false; }; "allowedColumnWidthPerType": { "alias": "allowedColumnWidthPerType"; "required": false; }; "singleColumnTemplate": { "alias": "singleColumnTemplate"; "required": false; }; "inherit": { "alias": "inherit"; "required": false; }; }, { "responsiveColumnHiding": "responsiveColumnHiding"; "responsiveColumnHidden": "responsiveColumnHidden"; "responsiveColumnShowing": "responsiveColumnShowing"; "responsiveColumnShown": "responsiveColumnShown"; "responsiveModeChanged": "responsiveModeChanged"; }, never, never, false, never>; } declare class IgGridResizingFeature extends Feature<IgGridResizing> { constructor(el: ElementRef); /** * Destroys the resizing widget */ destroy(): void; /** * Resizes a column to a specified width in pixels, percents or auto if no width is specified. * * @param column An identifier for the column. * If a number is provided it will be used as a columnIndex else if a strings is provided it will be used as a columnKey. * @param width Width of the column in pixels or percents. * If no width or "*" is specified the column will be auto-sized to the width of the data in it (including header and footer cells). */ resize(column: object, width?: object): void; static ɵfac: i0.ɵɵFactoryDeclaration<IgGridResizingFeature, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<IgGridResizingFeature, "resizing", never, { "disabled": { "alias": "disabled"; "required": false; }; "create": { "alias": "create"; "required": false; }; "allowDoubleClickToResize": { "alias": "allowDoubleClickToResize"; "required": false; }; "deferredRes