igniteui-angular-wrappers
Version:
A packaged version of Ignite UI wrappers for Angular
75 lines (74 loc) • 5.24 kB
TypeScript
import { ElementRef } from '@angular/core';
import { Feature } from '../feature';
import * as i0 from "@angular/core";
export declare class IgGridSummariesFeature extends Feature<IgGridSummaries> {
constructor(el: ElementRef);
destroy(): void;
/**
* Returns whether summaries rows are hidden
*/
isSummariesRowsHidden(): void;
/**
* Calculate summaries
*/
calculateSummaries(): void;
/**
* Remove all summaries dropdown buttons.
*/
clearAllFooterIcons(): void;
/**
* Toggle drop down
*
* @param columnKey toggle drop down for the column with the specified key
* @param event event object. Its data should contain current columnKey, isAnimating, buttonId
*/
toggleDropDown(columnKey: string, event: object): void;
/**
* Show/Hide dialog
*
* @param $dialog jQuery object representation of dropdown div element
*/
showHideDialog($dialog: object): void;
/**
* Toggle summaries rows
*
* @param isToShow Specifies whether to show or not summaries
* @param isInternalCall Optional parameter.Specifies whether this function is called internally by the widget.
*/
toggleSummariesRows(isToShow: boolean, isInternalCall: boolean): void;
/**
* Toggles the checkstate of a checkbox if checkboxMode is not set to off, otherwise does nothing.
*
* @param $checkbox Specifies the jQuery object of the checkbox.
*/
toggleCheckstate($checkbox: object): void;
/**
* Select/Unselect specified checkbox
*
* @param $checkbox Specifies the jQuery object for checkbox
* @param isToSelect Specify whether to select or not checkbox
*/
selectCheckBox($checkbox: object, isToSelect: boolean): void;
/**
* Summary calculate the whole data for the specified column key,
* columnMethods and dataType (used when datasource is remote and dataType is date)
*
* @param ck ColumnKey
* @param columnMethods Array of column methods objects
* @param data object which represents result represents dataType for the current column
* @param dataType data type
*/
calculateSummaryColumn(ck: string, columnMethods: any[], data: object, dataType: object): void;
/**
* Return a JQUERY object which holds all summaries for all columns
*/
summaryCollection(): void;
/**
* Return a JQUERY object which holds all summaries for column with the specified column key
*
* @param columnKey column key
*/
summariesFor(columnKey: object): void;
static ɵfac: i0.ɵɵFactoryDeclaration<IgGridSummariesFeature, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<IgGridSummariesFeature, "summaries", never, { "disabled": { "alias": "disabled"; "required": false; }; "create": { "alias": "create"; "required": false; }; "type": { "alias": "type"; "required": false; }; "dialogButtonOKText": { "alias": "dialogButtonOKText"; "required": false; }; "dialogButtonCancelText": { "alias": "dialogButtonCancelText"; "required": false; }; "calculateRenderMode": { "alias": "calculateRenderMode"; "required": false; }; "featureChooserText": { "alias": "featureChooserText"; "required": false; }; "featureChooserTextHide": { "alias": "featureChooserTextHide"; "required": false; }; "compactRenderingMode": { "alias": "compactRenderingMode"; "required": false; }; "defaultDecimalDisplay": { "alias": "defaultDecimalDisplay"; "required": false; }; "showSummariesButton": { "alias": "showSummariesButton"; "required": false; }; "summariesResponseKey": { "alias": "summariesResponseKey"; "required": false; }; "summaryExprUrlKey": { "alias": "summaryExprUrlKey"; "required": false; }; "callee": { "alias": "callee"; "required": false; }; "dropDownHeight": { "alias": "dropDownHeight"; "required": false; }; "dropDownWidth": { "alias": "dropDownWidth"; "required": false; }; "showDropDownButton": { "alias": "showDropDownButton"; "required": false; }; "summaryExecution": { "alias": "summaryExecution"; "required": false; }; "dropDownDialogAnimationDuration": { "alias": "dropDownDialogAnimationDuration"; "required": false; }; "emptyCellText": { "alias": "emptyCellText"; "required": false; }; "summariesHeaderButtonTooltip": { "alias": "summariesHeaderButtonTooltip"; "required": false; }; "resultTemplate": { "alias": "resultTemplate"; "required": false; }; "isGridFormatter": { "alias": "isGridFormatter"; "required": false; }; "renderSummaryCellFunc": { "alias": "renderSummaryCellFunc"; "required": false; }; "columnSettings": { "alias": "columnSettings"; "required": false; }; "inherit": { "alias": "inherit"; "required": false; }; }, { "dropDownOpening": "dropDownOpening"; "dropDownOpened": "dropDownOpened"; "dropDownClosing": "dropDownClosing"; "dropDownClosed": "dropDownClosed"; "summariesCalculating": "summariesCalculating"; "summariesCalculated": "summariesCalculated"; "summariesMethodSelectionChanged": "summariesMethodSelectionChanged"; "summariesToggling": "summariesToggling"; "summariesToggled": "summariesToggled"; "dropDownOKClicked": "dropDownOKClicked"; "dropDownCancelClicked": "dropDownCancelClicked"; }, never, never, false, never>;
}