Skip to content

Commit 160895a

Browse files
MKirovaMKirova
authored andcommitted
chore(*): Minor api docs changes.
1 parent 417cc8c commit 160895a

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1040,7 +1040,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
10401040
}
10411041

10421042
/**
1043-
* Gets the pinning direction of the column.
1043+
* Gets the pinning position of the column.
10441044
* ```typescript
10451045
* let pinningPosition = this.column.pinningPosition;
10461046
*/
@@ -1052,9 +1052,9 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
10521052
}
10531053

10541054
/**
1055-
* Sets the pinning direction of the column.
1055+
* Sets the pinning position of the column.
10561056
*```html
1057-
* <igx-column [pinningPosition]="ColumnPinningPosition.End"></igx-column>
1057+
* <igx-column [pinningPosition]="1"></igx-column>
10581058
* ```
10591059
*/
10601060
public set pinningPosition(value: ColumnPinningPosition) {
@@ -2207,13 +2207,12 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
22072207
}
22082208

22092209
/**
2210-
* Pins the column at the provided index in the pinned area.
2210+
* Pins the column in the specified position at the provided index in that pinned area.
22112211
* Defaults to index `0` if not provided, or to the initial index in the pinned area.
22122212
* Returns `true` if the column is successfully pinned. Returns `false` if the column cannot be pinned.
22132213
* Column cannot be pinned if:
22142214
* - Is already pinned
22152215
* - index argument is out of range
2216-
* - The pinned area exceeds 80% of the grid width
22172216
* ```typescript
22182217
* let success = this.column.pin();
22192218
* ```

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5181,6 +5181,7 @@ export abstract class IgxGridBaseDirective implements GridType,
51815181
* ```
51825182
* @param columnName
51835183
* @param index
5184+
* @param pinningPosition
51845185
*/
51855186
public pinColumn(columnName: string | IgxColumnComponent, index?: number, pinningPosition?: ColumnPinningPosition): boolean {
51865187
const col = columnName instanceof IgxColumnComponent ? columnName : this.getColumnByName(columnName);

0 commit comments

Comments
 (0)