@progress/kendo-angular-grid
Version:
Kendo UI Grid for Angular - high performance data grid with paging, filtering, virtualization, CRUD, and more.
57 lines (56 loc) • 2.37 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 { OnDestroy, SimpleChanges, OnChanges } from '@angular/core';
import { ContextService } from '../common/provider.service';
import { HighlightItem } from './highlight-item';
import { RowArgs } from '../rendering/common/row-args';
import * as i0 from "@angular/core";
/**
* Stores the row and cell highlight state of the Grid.
*
* @example
* ```typescript
* <kendo-grid kendoGridHighlight="ProductID"></kendo-grid>
*
* <kendo-grid [kendoGridHighlight]="myKey"></kendo-grid>
* ```
* @remarks
* Applied to: {@link GridComponent}.
*/
export declare class HighlightDirective implements OnChanges, OnDestroy {
private ctx;
/**
* Stores the highlighted items keys.
* @default []
*/
highlightedKeys: HighlightItem[];
/**
* Sets the item key to store in `highlightedKeys`. The Grid uses the row index as the default item key.
*/
highlightItemKey: string | ((context: RowArgs) => any);
/**
* Sets the column key for a data cell. The Grid uses the column index as the default column key.
*/
highlightColumnKey: string | ((column: any, columnIndex: number) => any);
private rowHighlightState;
private cellHighlightState;
constructor(ctx: ContextService);
ngOnChanges(changes: SimpleChanges): void;
ngOnDestroy(): void;
/**
* @hidden
*/
isRowHighlighted(row: RowArgs): boolean;
/**
* @hidden
*/
isCellHighlighted(row: any, column: any, colIndex: number): boolean;
private getItemKey;
private getHighlightItem;
private setState;
private reset;
static ɵfac: i0.ɵɵFactoryDeclaration<HighlightDirective, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<HighlightDirective, "[kendoGridHighlight]", never, { "highlightedKeys": { "alias": "highlightedKeys"; "required": false; }; "highlightItemKey": { "alias": "kendoGridHighlight"; "required": false; }; "highlightColumnKey": { "alias": "highlightColumnKey"; "required": false; }; }, {}, never, never, true, never>;
}