@syncfusion/ej2-grids
Version:
Feature-rich JavaScript datagrid (datatable) control with built-in support for editing, filtering, grouping, paging, sorting, and exporting to Excel.
57 lines (56 loc) • 1.77 kB
TypeScript
import { Column } from '../models/column';
import { IGrid } from '../base/interface';
/**
* The `ShowHide` module is used to control column visibility.
*/
export declare class ShowHide {
private parent;
private colName;
private changedCol;
private isShowHide;
private evtHandlers;
private widthService;
/**
* Constructor for the show hide module.
*
* @param {IGrid} parent - specifies the IGrid
* @hidden
*/
constructor(parent: IGrid);
addEventListener(): void;
/**
* @returns {void}
* @hidden
*/
removeEventListener(): void;
private batchChanges;
/**
* Shows a column by column name.
*
* @param {string|string[]} columnName - Defines a single or collection of column names to show.
* @param {string} showBy - Defines the column key either as field name or header text.
* @returns {void}
*/
show(columnName: string | string[], showBy?: string): void;
/**
* Hides a column by column name.
*
* @param {string|string[]} columnName - Defines a single or collection of column names to hide.
* @param {string} hideBy - Defines the column key either as field name or header text.
* @returns {void}
*/
hide(columnName: string | string[], hideBy?: string): void;
private getToggleFields;
private getColumns;
private batchActionPrevent;
resetColumnState(): void;
/**
* Shows or hides columns by given column collection.
*
* @private
* @param {Column[]} columns - Specifies the columns.
* @param {Column[]} changedStateColumns - specifies the changedStateColumns
* @returns {void}
*/
setVisible(columns?: Column[], changedStateColumns?: Column[]): void;
}