Merge pull request #12875 from IgniteUI/dpetev/grid-public-api-cleanup

Grids public API cleanup initial pass

Author: ChronosSF

projects/igniteui-angular/src/lib/grids/common/grid.interface.ts

@@ -285,7 +285,7 @@ export interface GridServiceType {
     sort_multiple(expressions: ISortingExpression[]): void;
     clear_sort(fieldName: string): void;
 
-    get_pin_row_event_args(rowID: any, index?: number, row?: RowType , pinned?: boolean): IPinRowEventArgs;
+    get_pin_row_event_args(rowID: any, index?: number, row?: RowType, pinned?: boolean): IPinRowEventArgs;
 
     filterDataByExpressions(expressionsTree: IFilteringExpressionsTree): any[];
     sortDataByExpressions(data: any[], expressions: ISortingExpression[]): any[];
@@ -325,6 +325,7 @@ export interface GridType extends IGridDataBindable {
     pipeTrigger: number;
     summaryPipeTrigger: number;
     filteringPipeTrigger: number;
+    /** @hidden @internal */
     hasColumnLayouts: boolean;
     moving: boolean;
     isLoading: boolean;
@@ -335,16 +336,26 @@ export interface GridType extends IGridDataBindable {
     filterMode: FilterMode;
 
     // TYPE
+    /** @hidden @internal */
     theadRow: any;
+    /** @hidden @internal */
     groupArea: any;
+    /** @hidden @internal */
     filterCellList: any[];
+    /** @hidden @internal */
     filteringRow: any;
+    /** @hidden @internal */
     actionStrip: any;
+    /** @hidden @internal */
     resizeLine: any;
 
+    /** @hidden @internal */
     tfoot: ElementRef<HTMLElement>;
+    /** @hidden @internal */
     paginator: IgxPaginatorComponent;
+    /** @hidden @internal */
     paginatorList?: QueryList<IgxPaginatorComponent>;
+    /** @hidden @internal */
     crudService: any;
     summaryService: any;
 
@@ -356,12 +367,15 @@ export interface GridType extends IGridDataBindable {
     navigation: any;
     filteringService: any;
     outlet: any;
+    /** @hidden @internal */
     hasMovableColumns: boolean;
     isRowSelectable: boolean;
     showRowSelectors: boolean;
     isPinningToStart: boolean;
     columnInDrag: any;
+    /** @hidden @internal */
     pinnedWidth: number;
+    /** @hidden @internal */
     unpinnedWidth: number;
     summariesMargin: number;
     headSelectorBaseAriaLabel: string;
@@ -415,17 +429,22 @@ export interface GridType extends IGridDataBindable {
     visibleColumns: ColumnType[];
     unpinnedColumns: ColumnType[];
     pinnedColumns: ColumnType[];
+    /** @hidden @internal */
     headerCellList: any[];
+    /** @hidden @internal */
     headerGroups: any[];
+    /** @hidden @internal */
     headerGroupsList: any[];
     summariesRowList: any;
+    /** @hidden @internal */
     headerContainer: any;
     isCellSelectable: boolean;
     isMultiRowSelectionEnabled: boolean;
     hasPinnedRecords: boolean;
     pinnedRecordsCount: number;
     pinnedRecords: any[];
     unpinnedRecords: any[];
+    /** @hidden @internal */
     pinnedDataView: any[];
     pinnedRows: any[];
     dataView: any[];
@@ -448,6 +467,7 @@ export interface GridType extends IGridDataBindable {
     lastSearchInfo: ISearchInfo;
     page: number;
     perPage: number;
+    /** @hidden @internal */
     dragRowID: any;
     rowDragging: boolean;
     evenRowCSS: string;
@@ -457,8 +477,11 @@ export interface GridType extends IGridDataBindable {
     lastEditableColumnIndex: number;
     isRowPinningToTop: boolean;
     hasDetails: boolean;
+    /** @hidden @internal */
     hasSummarizedColumns: boolean;
+    /** @hidden @internal */
     hasColumnGroups: boolean;
+    /** @hidden @internal */
     hasEditableColumns: boolean;
     uniqueColumnValuesStrategy: (column: ColumnType, tree: FilteringExpressionsTree, done: (values: any[]) => void) => void;
     getHeaderCellWidth: (element: HTMLElement) => ISizeInfo;
@@ -478,7 +501,9 @@ export interface GridType extends IGridDataBindable {
 
     // XXX: Work around till we fixed the injection tokens
     lastChildGrid?: GridType;
+    /** @hidden @internal */
     toolbarOutlet?: ViewContainerRef;
+    /** @hidden @internal */
     paginatorOutlet?: ViewContainerRef;
     flatData?: any[] | null;
     childRow?: any;
@@ -571,7 +596,9 @@ export interface GridType extends IGridDataBindable {
     groupingMetadata?: any[];
     selectedCells?: CellType[];
     selectedRows: any[];
+    /** @hidden @internal */
     activeDescendant?: string;
+    /** @hidden @internal */
     isPivot?: boolean;
 
     toggleGroup?(groupRow: IGroupByRecord): void;
@@ -686,17 +713,22 @@ export interface PivotGridType extends GridType {
     pivotConfiguration: IPivotConfiguration;
     allDimensions: IPivotDimension[],
     showPivotConfigurationUI: boolean;
+    /** @hidden @internal */
     columnDimensions: IPivotDimension[];
+    /** @hidden @internal */
     rowDimensions: IPivotDimension[];
     rowDimensionResizing: boolean;
+    /** @hidden @internal */
     values: IPivotValue[];
+    /** @hidden @internal */
     filterDimensions: IPivotDimension[];
+    /** @hidden @internal */
     dimensionDataColumns: ColumnType[];
     pivotRowWidths: number;
     setupColumns(): void;
     toggleRow(rowID: any): void;
     resolveDataTypes(field: any): GridColumnDataType;
-    moveDimension(dimension: IPivotDimension, targetCollectionType: PivotDimensionType, index? : number);
+    moveDimension(dimension: IPivotDimension, targetCollectionType: PivotDimensionType, index?: number);
     getDimensionsByType(dimension: PivotDimensionType);
     toggleDimension(dimension: IPivotDimension);
     sortDimension(dimension: IPivotDimension, sortDirection: SortingDirection);
@@ -705,6 +737,7 @@ export interface PivotGridType extends GridType {
     rowDimensionWidthToPixels(dim: IPivotDimension): number;
     dimensionsChange: EventEmitter<IDimensionsChange>;
     valuesChange: EventEmitter<IValuesChange>;
+    /** @hidden @internal */
     pivotKeys: IPivotKeys;
     hasMultipleValues: boolean;
     excelStyleFilterMaxHeight: string;
@@ -751,7 +784,7 @@ export interface IgxGridEmptyTemplateContext {
 export interface IgxGridRowEditTemplateContext {
     $implicit: undefined,
     rowChangesCount: number,
-    endEdit:  (commit: boolean, event?: Event) => void
+    endEdit: (commit: boolean, event?: Event) => void
 }
 
 export interface IgxGridRowEditTextTemplateContext {