@progress/kendo-angular-grid
Version:
Kendo UI Grid for Angular - high performance data grid with paging, filtering, virtualization, CRUD, and more.
60 lines (59 loc) • 2.82 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2025 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { EventEmitter, OnDestroy } from '@angular/core';
import { GridComponent } from '../grid.component';
import { GroupRowArgs } from '../grouping/group-rows-args.interface';
import * as i0 from "@angular/core";
/**
* Controls the expanded state of group rows in the Grid.
* Use this directive to manage which group rows are expanded or collapsed
* ([see example]({% slug groups_expanded_state_grid %}#toc-built-in-directive)).
*
* @example
* ```typescript
* <kendo-grid [kendoGridExpandGroupBy]="expandGroupBy" [expandedGroupKeys]="expandedGroupKeys"></kendo-grid>
* ```
* @remarks
* Applied to: {@link GridComponent}.
*/
export declare class ExpandGroupDirective implements OnDestroy {
protected grid: GridComponent;
/**
* Fires when the `expandedGroupKeys` collection changes.
*/
expandedGroupKeysChange: EventEmitter<any[]>;
/**
* Sets the item format stored in the `expandedGroupKeys` collection.
* Accepts a property name or a function that returns a unique key for each group
* ([see example]({% slug groups_expanded_state_grid %}#toc-custom-group-key-format)).
*/
get expandGroupBy(): string | ((group: GroupRowArgs) => any);
set expandGroupBy(key: string | ((group: GroupRowArgs) => any));
/**
* Holds the collection of expanded group keys.
* Set this property to control which group rows are expanded.
*/
get expandedGroupKeys(): any[];
set expandedGroupKeys(expandedGroups: any[]);
/**
* Specifies if group items are expanded by default.
* @default false
*/
groupsInitiallyExpanded: boolean;
private _expandGroupBy;
private _expandedGroupKeys;
private subscriptions;
constructor(grid: GridComponent);
ngOnDestroy(): void;
protected get keyGetter(): any;
/**
* @hidden
*/
isExpanded(groupArgs: GroupRowArgs): boolean;
private getItemIndex;
private toggleState;
static ɵfac: i0.ɵɵFactoryDeclaration<ExpandGroupDirective, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<ExpandGroupDirective, "[kendoGridExpandGroupBy]", ["kendoGridExpandGroupBy"], { "expandGroupBy": { "alias": "kendoGridExpandGroupBy"; "required": false; }; "expandedGroupKeys": { "alias": "expandedGroupKeys"; "required": false; }; "groupsInitiallyExpanded": { "alias": "groupsInitiallyExpanded"; "required": false; }; }, { "expandedGroupKeysChange": "expandedGroupKeysChange"; }, never, never, true, never>;
}