Skip to content

Commit fc3be31

Browse files
committed
docs(*): add API comments to the IgxFilteringOperand
1 parent d4d72a3 commit fc3be31

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

projects/igniteui-angular/src/lib/data-operations/filtering-condition.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,32 @@ export class IgxFilteringOperand {
3838
return this._instance || (this._instance = new this());
3939
}
4040

41+
/**
42+
* @hidden
43+
*/
4144
protected findValueInSet(target: any, searchVal: Set<any>) {
4245
return searchVal.has(target);
4346
}
4447

48+
/**
49+
* Returns an array of names of the conditions which are visible in the UI
50+
*/
4551
public conditionList(): string[] {
4652
return this.operations.filter(f => !f.hidden).map((element) => element.name);
4753
}
4854

55+
/**
56+
* Returns an instance of the condition with the specified name.
57+
* @param name The name of the condition.
58+
*/
4959
public condition(name: string): IFilteringOperation {
5060
return this.operations.find((element) => element.name === name);
5161
}
5262

63+
/**
64+
* Adds a new condition to the filtering operations.
65+
* @param operation The filtering operation.
66+
*/
5367
public append(operation: IFilteringOperation) {
5468
this.operations.push(operation);
5569
}

0 commit comments

Comments
 (0)