@progress/kendo-angular-grid
Version:
Kendo UI Grid for Angular - high performance data grid with paging, filtering, virtualization, CRUD, and more.
87 lines (86 loc) • 3.49 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2026 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { NgZone, Renderer2, OnDestroy, ChangeDetectorRef } from '@angular/core';
import { PopupService } from '@progress/kendo-angular-popup';
import { ColumnInfoService } from '../common/column-info.service';
import { SVGIcon } from '@progress/kendo-svg-icons';
import { Button } from '@progress/kendo-angular-buttons';
import { ContextService } from '../common/provider.service';
import * as i0 from "@angular/core";
/**
* Represents the component for toggling visibility of the Grid columns visibility. [See example](https://www.telerik.com/kendo-angular-ui/components/grid/toolbar/toolbar-template).
* To show and hide the columns without including the column chooser item in the [Column Menu](https://www.telerik.com/kendo-angular-ui/components/grid/accessories/column-menu),
* add the component inside the [ToolbarTemplate](https://www.telerik.com/kendo-angular-ui/components/grid/toolbar/toolbar-template) directive.
*
* @example
* ```html
* <kendo-grid [data]="data">
* <ng-template kendoGridToolbarTemplate>
* <kendo-grid-column-chooser></kendo-grid-column-chooser>
* </ng-template>
* <kendo-grid-column field="ProductID"></kendo-grid-column>
* </kendo-grid>
* ```
*/
export declare class ColumnChooserComponent implements OnDestroy {
ctx: ContextService;
columnInfoService: ColumnInfoService;
private popupService;
private ngZone;
private renderer;
private changeDetector;
/**
* Specifies if the changes in the visibility of the column will be immediately applied.
*
* @default false
*/
autoSync: boolean;
/**
* Specifies if the column chooser displays a search box.
*
* @default true
*/
filterable: boolean;
/**
* Specifies if the column chooser displays a select all checkbox.
*
* @default true
*/
showSelectAll: boolean;
/**
* Specifies if all columns can be hidden.
*
* @default true
*/
allowHideAll: boolean;
private anchor;
get columns(): any[];
columnsIcon: SVGIcon;
popupRef: any;
popupId: string;
private closeClick;
private escapeListener;
constructor(ctx: ContextService, columnInfoService: ColumnInfoService, popupService: PopupService, ngZone: NgZone, renderer: Renderer2, changeDetector: ChangeDetectorRef);
ngOnDestroy(): void;
/**
* @hidden
*/
messageFor: (token: string) => string;
/**
* @hidden
*/
toggle(anchor: Button, template: any): void;
/**
* @hidden
*/
onChange(changed: any[]): void;
/**
* @hidden
*/
close(focusAnchor?: boolean): void;
private detachClose;
static ɵfac: i0.ɵɵFactoryDeclaration<ColumnChooserComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<ColumnChooserComponent, "kendo-grid-column-chooser", never, { "autoSync": { "alias": "autoSync"; "required": false; }; "filterable": { "alias": "filterable"; "required": false; }; "showSelectAll": { "alias": "showSelectAll"; "required": false; }; "allowHideAll": { "alias": "allowHideAll"; "required": false; }; }, {}, never, never, true, never>;
}