Skip to content

Commit 4586332

Browse files
MKirovaMKirova
authored andcommitted
chore(*): Adding better documentation for IPinRowEventArgs.
1 parent f52bd1b commit 4586332

File tree

1 file changed

+12
-1
lines changed
  • projects/igniteui-angular/src/lib/grids/common

1 file changed

+12
-1
lines changed

projects/igniteui-angular/src/lib/grids/common/events.ts

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,9 +119,20 @@ export interface IRowToggleEventArgs extends IBaseEventArgs {
119119
cancel: boolean;
120120
}
121121

122+
/**
123+
* Event emitted when a row's pin state changes.
124+
*/
122125
export interface IPinRowEventArgs extends IBaseEventArgs {
123-
row: IgxRowDirective<IgxGridBaseDirective & GridType>;
126+
/** The row component instance, that was pinned/unpinned.
127+
* May be undefined if row does not exist in the current visible data.
128+
*/
129+
row?: IgxRowDirective<IgxGridBaseDirective & GridType>;
130+
/** The ID of the row, that was pinned/unpinned.
131+
* ID is either the primaryKey value or the data record instance.
132+
*/
124133
rowID: any;
134+
/** The index at which to pin the row in the pinned rows collection. */
125135
insertAtIndex?: number;
136+
/** Whether or noy the row is pinned or unpinned. */
126137
isPinned: boolean;
127138
}

0 commit comments

Comments
 (0)