Skip to content

Commit e1ae2be

Browse files
committed
chore(*): expose change events for analyzers
1 parent 4b378c9 commit e1ae2be

File tree

7 files changed

+161
-25
lines changed

7 files changed

+161
-25
lines changed

projects/igniteui-angular/src/lib/grids/columns/column.component.ts

Lines changed: 65 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -405,23 +405,67 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
405405
}
406406

407407
/**
408-
* @hidden
408+
* Emitted when the column is hidden or shown.
409+
*
410+
* ```html
411+
* <igx-column (hiddenChange)="hiddenChange($event)">
412+
* </igx-column>
413+
* ```
414+
*
415+
* @memberof IgxColumnComponent
409416
*/
410417
@Output()
411418
public hiddenChange = new EventEmitter<boolean>();
412419

413-
/** @hidden */
420+
/**
421+
* Emitted when the column expanded or collapsed.
422+
*
423+
* ```html
424+
* <igx-column (expandedChange)="expandedChange($event)">
425+
* </igx-column>
426+
* ```
427+
*
428+
* @memberof IgxColumnComponent
429+
*/
414430
@Output()
415431
public expandedChange = new EventEmitter<boolean>();
416432

417-
/** @hidden */
433+
/**
434+
* Emitted when the column property `collapsible` changes.
435+
*
436+
* ```html
437+
* <igx-column (collapsibleChange)="collapsibleChange($event)">
438+
* </igx-column>
439+
* ```
440+
*
441+
* @memberof IgxColumnComponent
442+
*/
418443
@Output()
419444
public collapsibleChange = new EventEmitter<boolean>();
420-
/** @hidden */
445+
446+
/**
447+
* Emitted when the column property `visibleWhenCollapsed` changes.
448+
*
449+
* ```html
450+
* <igx-column (visibleWhenCollapsedChange)="visibleWhenCollapsedChange($event)">
451+
* </igx-column>
452+
* ```
453+
*
454+
* @memberof IgxColumnComponent
455+
*/
421456
@Output()
422457
public visibleWhenCollapsedChange = new EventEmitter<boolean>();
423458

424-
/** @hidden */
459+
/**
460+
* Emitted when the column changed.
461+
*
462+
* ```html
463+
* <igx-column (columnChange)="columnChange($event)">
464+
* </igx-column>
465+
* ```
466+
*
467+
* @memberof IgxColumnComponent
468+
*/
425469
@Output()
426470
public columnChange = new EventEmitter<void>();
427471

@@ -861,13 +905,27 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
861905
public additionalTemplateContext: any;
862906

863907
/**
864-
* @hidden
908+
* Emitted when the column width changes.
909+
*
910+
* ```html
911+
* <igx-column (widthChange)="widthChange($event)">
912+
* </igx-column>
913+
* ```
914+
*
915+
* @memberof IgxColumnComponent
865916
*/
866917
@Output()
867918
public widthChange = new EventEmitter<string>();
868919

869920
/**
870-
* @hidden
921+
* Emitted when the column is pinned/unpinned.
922+
*
923+
* ```html
924+
* <igx-column (pinnedChange)="pinnedChange($event)">
925+
* </igx-column>
926+
* ```
927+
*
928+
* @memberof IgxColumnComponent
871929
*/
872930
@Output()
873931
public pinnedChange = new EventEmitter<boolean>();

projects/igniteui-angular/src/lib/grids/filtering/excel-style/excel-style-filtering.component.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,14 @@ export class IgxGridExcelStyleFilteringComponent extends BaseFilteringComponent
116116
public sortingChanged = new EventEmitter();
117117

118118
/**
119-
* @hidden @internal
119+
* Emitted when the column changed.
120+
*
121+
* ```html
122+
* <igx-grid-excel-style-filtering (columnChange)="columnChange($event)">
123+
* </igx-grid-excel-style-filtering>
124+
* ```
125+
*
126+
* @memberof IgxGridExcelStyleFilteringComponent
120127
*/
121128
@Output()
122129
public columnChange = new EventEmitter<ColumnType>();

projects/igniteui-angular/src/lib/grids/grid-base.directive.ts

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ import {
2727
Optional,
2828
Output,
2929
QueryList,
30-
TemplateRef,
3130
ViewChild,
3231
ViewChildren,
3332
ViewContainerRef
@@ -992,13 +991,25 @@ export abstract class IgxGridBaseDirective implements GridType,
992991
public gridCopy = new EventEmitter<IGridClipboardEvent>();
993992

994993
/**
995-
* @hidden @internal
994+
* Emitted when the rows are expanded or collapsed.
995+
*
996+
* @example
997+
* ```html
998+
* <igx-grid [data]="employeeData" (selectedRowsChange)="selectedRowsChange($event)" [autoGenerate]="true"></igx-grid>
999+
* ```
9961000
*/
9971001
@Output()
9981002
public expansionStatesChange = new EventEmitter<Map<any, boolean>>();
9991003

10001004
/* blazorInclude */
1001-
/** @hidden @internal */
1005+
/**
1006+
* Emitted when the rows are selected or deselected.
1007+
*
1008+
* @example
1009+
* ```html
1010+
* <igx-grid [data]="employeeData" (selectedRowsChange)="selectedRowsChange($event)" [autoGenerate]="true"></igx-grid>
1011+
* ```
1012+
*/
10021013
@Output()
10031014
public selectedRowsChange = new EventEmitter<any[]>();
10041015

@@ -1036,7 +1047,7 @@ export abstract class IgxGridBaseDirective implements GridType,
10361047
public rowPinned = new EventEmitter<IPinRowEventArgs>();
10371048

10381049
/**
1039-
* Emmited when the active node is changed.
1050+
* Emitted when the active node is changed.
10401051
*
10411052
* @example
10421053
* ```
@@ -1089,7 +1100,12 @@ export abstract class IgxGridBaseDirective implements GridType,
10891100
public rendered = new EventEmitter<boolean>();
10901101

10911102
/**
1092-
* @hidden @internal
1103+
* Emitted when the locale of the grid is changed.
1104+
*
1105+
* @example
1106+
* ```html
1107+
* <igx-grid [data]="employeeData" (localeChange)="localeChange($event)" [autoGenerate]="true"></igx-grid>
1108+
* ```
10931109
*/
10941110
@Output()
10951111
public localeChange = new EventEmitter<boolean>();

projects/igniteui-angular/src/lib/grids/grid/grid.component.ts

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,13 +168,27 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
168168
public dataPreLoad = new EventEmitter<IForOfState>();
169169

170170
/**
171-
* @hidden
171+
* Emitted when grouping is performed.
172+
*
173+
* @remarks
174+
* Returns the grouping expressions.
175+
* @example
176+
* ```html
177+
* <igx-grid #grid [data]="localData" [autoGenerate]="true" (groupingExpressionsChange)="groupingExpressionsChange($event)"></igx-grid>
178+
* ```
172179
*/
173180
@Output()
174181
public groupingExpressionsChange = new EventEmitter<IGroupingExpression[]>();
175182

176183
/**
177-
* @hidden @internal
184+
* Emitted when groups are expanded/collapsed.
185+
*
186+
* @remarks
187+
* Returns the grouping expansion states.
188+
* @example
189+
* ```html
190+
* <igx-grid #grid [data]="localData" [autoGenerate]="true" (groupingExpansionStateChange)="groupingExpansionStateChange($event)"></igx-grid>
191+
* ```
178192
*/
179193
@Output()
180194
public groupingExpansionStateChange = new EventEmitter<IGroupByExpandState[]>();

projects/igniteui-angular/src/lib/grids/grouping/group-by-area.directive.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,14 @@ export abstract class IgxGroupByAreaDirective {
6767
this._dropAreaMessage = value;
6868
}
6969

70+
/**
71+
* Emitted when grouping is performed.
72+
*
73+
* @example
74+
* ```html
75+
* <igx-grid-group-by-area (expressionsChange)="expressionsChange($event)"></igx-grid-group-by-area>
76+
* ```
77+
*/
7078
@Output()
7179
public expressionsChange = new EventEmitter<IGroupingExpression[]>();
7280

projects/igniteui-angular/src/lib/grids/hierarchical-grid/row-island.component.ts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,16 @@ export class IgxRowIslandComponent extends IgxHierarchicalGridBaseDirective
184184
protected override actionStripComponents: QueryList<IgxActionStripToken>;
185185

186186
/**
187-
* @hidden
187+
* Event emitted when a layout of the row island is changed.
188+
* ```html
189+
* <igx-hierarchical-grid [data]="Data" [autoGenerate]="true">
190+
* <igx-row-island [key]="'childData'" (layoutChange)="layoutChange($event)" #rowIsland>
191+
* <!-- ... -->
192+
* </igx-row-island>
193+
* </igx-hierarchical-grid>
194+
* ```
195+
*
196+
* @memberof IgxRowIslandComponent
188197
*/
189198
@Output()
190199
public layoutChange = new EventEmitter<any>();

projects/igniteui-angular/src/lib/grids/pivot-grid/pivot-data-selector.component.ts

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,15 @@ export class IgxPivotDataSelectorComponent {
108108
public columnsExpanded = true;
109109

110110
/**
111-
* @hidden
112-
*/
111+
/**
112+
* Emitted when the columns panel is expanded or collapsed.
113+
*
114+
* @example
115+
* ```html
116+
* <igx-pivot-data-selector #grid [data]="localData" [height]="'305px'"
117+
* (columnsExpandedChange)="columnsExpandedChange($event)"></igx-pivot-data-selector>
118+
* ```
119+
*/
113120
@Output()
114121
public columnsExpandedChange = new EventEmitter<boolean>();
115122

@@ -133,8 +140,14 @@ export class IgxPivotDataSelectorComponent {
133140
public rowsExpanded = true;
134141

135142
/**
136-
* @hidden
137-
*/
143+
* Emitted when the rows panel is expanded or collapsed.
144+
*
145+
* @example
146+
* ```html
147+
* <igx-pivot-data-selector #grid [data]="localData" [height]="'305px'"
148+
* (rowsExpandedChange)="rowsExpandedChange($event)"></igx-pivot-data-selector>
149+
* ```
150+
*/
138151
@Output()
139152
public rowsExpandedChange = new EventEmitter<boolean>();
140153

@@ -158,8 +171,14 @@ export class IgxPivotDataSelectorComponent {
158171
public filtersExpanded = true;
159172

160173
/**
161-
* @hidden
162-
*/
174+
* Emitted when the filters panel is expanded or collapsed.
175+
*
176+
* @example
177+
* ```html
178+
* <igx-pivot-data-selector #grid [data]="localData" [height]="'305px'"
179+
* (filtersExpandedChange)="filtersExpandedChange($event)"></igx-pivot-data-selector>
180+
* ```
181+
*/
163182
@Output()
164183
public filtersExpandedChange = new EventEmitter<boolean>();
165184

@@ -183,9 +202,14 @@ export class IgxPivotDataSelectorComponent {
183202
public valuesExpanded = true;
184203

185204
/**
186-
* @hidden
187-
*/
188-
@Output()
205+
* Emitted when the values panel is expanded or collapsed.
206+
*
207+
* @example
208+
* ```html
209+
* <igx-pivot-data-selector #grid [data]="localData" [height]="'305px'"
210+
* (valuesExpandedChange)="valuesExpandedChange($event)"></igx-pivot-data-selector>
211+
* ```
212+
*/
189213
public valuesExpandedChange = new EventEmitter<boolean>();
190214

191215
private _grid: PivotGridType;

0 commit comments

Comments
 (0)