igniteui-webcomponents-grids 7.1.0 → 7.2.0-beta.1

package/grids/lib/igc-overlay-outlet-directive.d.ts

@@ -6,9 +6,6 @@
 /**
  * Mark an element as an igxOverlay outlet container.
  * Directive instance is exported as `overlay-outlet` to be assigned to templates variables:
- * ```html
- * <div igxOverlayOutlet #outlet="overlay-outlet"></div>
- * ```
  */
 
     export declare class IgcOverlayOutletDirective

package/grids/lib/igc-paginator-component.d.ts

@@ -19,7 +19,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
 /* jsonAPIManageCollectionInMarkup */
 /**
  * Paginator component description
- * @igxParent IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent, *
  */
 
     export declare class IgcPaginatorComponent extends EventEmitterMixin<IgcPaginatorComponentEventMap, Constructor<LitElement>>(LitElement)
@@ -44,11 +43,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
     /**
      * Gets/Sets the current page of the paginator.
      * The default is 0.
-     * ```typescript
-     * let page = this.paginator.page;
-     * ```
-     *
-     * @memberof IgxPaginatorComponent
      */
     public set page(value: number);
           public get page(): number;
@@ -58,11 +52,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
     /**
      * Gets/Sets the number of visible items per page in the paginator.
      * The default is 15.
-     * ```typescript
-     * let itemsPerPage = this.paginator.perPage;
-     * ```
-     *
-     * @memberof IgxPaginatorComponent
      */
     public set perPage(value: number);
           public get perPage(): number;
@@ -71,11 +60,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
 
     /**
      * Sets the total records.
-     * ```typescript
-     * let totalRecords = this.paginator.totalRecords;
-     * ```
-     *
-     * @memberof IgxPaginatorComponent
      */
     public set totalRecords(value: number);
           public get totalRecords(): number;
@@ -84,11 +68,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
 
     /**
      * Sets custom options in the select of the paginator
-     * ```typescript
-     * let options = this.paginator.selectOptions;
-     * ```
-     *
-     * @memberof IgxPaginatorComponent
      */
     public set selectOptions(value: number[]);
           public get selectOptions(): number[];
@@ -97,9 +76,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
 
     /**
      * Sets custom OverlaySettings.
-     * ```html
-     * <igx-paginator [overlaySettings] = "customOverlaySettings"></igx-paginator>
-     * ```
      */
     public set overlaySettings(value: IgcOverlaySettings);
           public get overlaySettings(): IgcOverlaySettings;
@@ -118,9 +94,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
 
     /**
      * Returns if the current page is the last page.
-     * ```typescript
-     * const lastPage = this.paginator.isLastPage;
-     * ```
      */
     public get isLastPage(): boolean;
         
@@ -128,44 +101,26 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
 
     /**
      * Returns if the current page is the first page.
-     * ```typescript
-     * const lastPage = this.paginator.isFirstPage;
-     * ```
      */
     public get isFirstPage(): boolean;
         
             
 
     /**
-     * Goes to the next page of the `IgxPaginatorComponent`, if the paginator is not already at the last page.
-     * ```typescript
-     * this.paginator.nextPage();
-     * ```
-     *
-     * @memberof IgxPaginatorComponent
+     * Goes to the next page of the paginator, if the paginator is not already at the last page.
      */
     public nextPage(): void;
 
             
     /**
-     * Goes to the previous page of the `IgxPaginatorComponent`, if the paginator is not already at the first page.
-     * ```typescript
-     * this.paginator.previousPage();
-     * ```
-     *
-     * @memberof IgxPaginatorComponent
+     * Goes to the previous page of the paginator, if the paginator is not already at the first page.
      */
     public previousPage(): void;
 
             
     /**
      * Goes to the desired page index.
-     * ```typescript
-     * this.paginator.paginate(1);
-     * ```
-     *
      * @param val
-     * @memberof IgxPaginatorComponent
      */
     public paginate(val: number): void;
 
@@ -175,55 +130,21 @@ export declare interface IgcPaginatorComponentEventMap {
             
         		    /**
 		     * Emitted when `perPage` property value of the paginator is changed.
-		     *
-		     * @example
-		     * ```html
-		     * <igx-paginator (perPageChange)="onPerPageChange($event)"></igx-paginator>
-		     * ```
-		     * ```typescript
-		     * public onPerPageChange(perPage: number) {
-		     *   this.perPage = perPage;
-		     * }
-		     * ```
 		     */
 perPageChange: CustomEvent<number>;
 
         		    /**
 		     * Emitted after the current page is changed.
-		     *
-		     * @example
-		     * ```html
-		     * <igx-paginator (pageChange)="onPageChange($event)"></igx-paginator>
-		     * ```
-		     * ```typescript
-		     * public onPageChange(page: number) {
-		     *   this.currentPage = page;
-		     * }
-		     * ```
 		     */
 pageChange: CustomEvent<number>;
 
         		    /**
 		     * Emitted before paging is performed.
-		     *
-		     * @remarks
-		     * Returns an object consisting of the current and next pages.
-		     * @example
-		     * ```html
-		     * <igx-paginator (paging)="pagingHandler($event)"></igx-paginator>
-		     * ```
 		     */
 paging: CustomEvent<IgcPageCancellableEventArgs>;
 
         		    /**
 		     * Emitted after paging is performed.
-		     *
-		     * @remarks
-		     * Returns an object consisting of the previous and current pages.
-		     * @example
-		     * ```html
-		     * <igx-paginator (pagingDone)="pagingDone($event)"></igx-paginator>
-		     * ```
 		     */
 pagingDone: CustomEvent<IgcPageEventArgs>;
 

package/grids/lib/igc-pinning-config.d.ts

@@ -16,9 +16,11 @@ import { RowPinningPosition } from './row-pinning-position';
     {
 
           
+    /* mustCoerceToInt */
     public columns?: ColumnPinningPosition;
   
           
+    /* mustCoerceToInt */
     public rows?: RowPinningPosition;
   
     }

package/grids/lib/igc-pivot-aggregation.d.ts

@@ -0,0 +1,19 @@
+
+
+
+
+
+/* csSuppress */
+/**
+* Interface describing a PivotAggregation function.
+* Accepts an array of extracted data members and an optional array of the original data records,
+* which can be omitted or undefined.
+*/
+
+    export declare class IgcPivotAggregation
+    {
+
+    }
+
+
+        

package/grids/lib/igc-pivot-aggregator.d.ts

@@ -1,5 +1,6 @@
 
 import { PivotAggregationType } from './pivot-aggregation-type';
+import { IgcPivotAggregation } from './igc-pivot-aggregation';
 
 
 /* jsonAPIPlainObject */
@@ -37,9 +38,9 @@ import { PivotAggregationType } from './pivot-aggregation-type';
     /* blazorOnlyScript */
     /**
      * Aggregator function can be a custom implementation of `PivotAggregation`, or
-     * use predefined ones from `IgxPivotAggregate` and its variants.
+     * use predefined ones from pivot aggregate and its variants.
      */
-    public aggregator?: any;
+    public aggregator?: IgcPivotAggregation;
   
     }
 

package/grids/lib/igc-pivot-data-selector-component.d.ts

@@ -10,21 +10,6 @@ import { IgcPivotGridComponent } from './igc-pivot-grid-component';
 /* wcElementTag: igc-pivot-data-selector */
 /**
  * Pivot Data Selector provides means to configure the pivot state of the Pivot Grid via a vertical panel UI
- *
- * @igxModule IgxPivotGridModule
- * @igxGroup Grids & Lists
- * @igxKeywords data selector, pivot, grid
- * @igxTheme pivot-data-selector-theme
- * @remarks
- * The Ignite UI Data Selector has a searchable list with the grid data columns,
- * there are also four expandable areas underneath for filters, rows, columns, and values
- * is used for grouping and aggregating simple flat data into a pivot table.
- * @example
- * ```html
- * <igx-pivot-grid #grid1 [data]="data" [pivotConfiguration]="configuration">
- * </igx-pivot-grid>
- * <igx-pivot-data-selector [grid]="grid1"></igx-pivot-data-selector>
- * ```
  */
 
     export declare class IgcPivotDataSelectorComponent extends EventEmitterMixin<IgcPivotDataSelectorComponentEventMap, Constructor<LitElement>>(LitElement)
@@ -42,18 +27,6 @@ import { IgcPivotGridComponent } from './igc-pivot-grid-component';
     /**
      * Gets/sets whether the columns panel is expanded
      * Get
-     * ```typescript
-     *  const columnsPanelState: boolean = this.dataSelector.columnsExpanded;
-     * ```
-     * Set
-     * ```html
-     * <igx-pivot-data-selector [grid]="grid1" [columnsExpanded]="columnsPanelState"></igx-pivot-data-selector>
-     * ```
-     *
-     * Two-way data binding:
-     * ```html
-     * <igx-pivot-data-selector [grid]="grid1" [(columnsExpanded)]="columnsPanelState"></igx-pivot-data-selector>
-     * ```
      */
     public set columnsExpanded(value: boolean);
           public get columnsExpanded(): boolean;
@@ -63,18 +36,6 @@ import { IgcPivotGridComponent } from './igc-pivot-grid-component';
     /**
      * Gets/sets whether the rows panel is expanded
      * Get
-     * ```typescript
-     *  const rowsPanelState: boolean = this.dataSelector.rowsExpanded;
-     * ```
-     * Set
-     * ```html
-     * <igx-pivot-data-selector [grid]="grid1" [rowsExpanded]="rowsPanelState"></igx-pivot-data-selector>
-     * ```
-     *
-     * Two-way data binding:
-     * ```html
-     * <igx-pivot-data-selector [grid]="grid1" [(rowsExpanded)]="rowsPanelState"></igx-pivot-data-selector>
-     * ```
      */
     public set rowsExpanded(value: boolean);
           public get rowsExpanded(): boolean;
@@ -84,18 +45,6 @@ import { IgcPivotGridComponent } from './igc-pivot-grid-component';
     /**
      * Gets/sets whether the filters panel is expanded
      * Get
-     * ```typescript
-     *  const filtersPanelState: boolean = this.dataSelector.filtersExpanded;
-     * ```
-     * Set
-     * ```html
-     * <igx-pivot-data-selector [grid]="grid1" [filtersExpanded]="filtersPanelState"></igx-pivot-data-selector>
-     * ```
-     *
-     * Two-way data binding:
-     * ```html
-     * <igx-pivot-data-selector [grid]="grid1" [(filtersExpanded)]="filtersPanelState"></igx-pivot-data-selector>
-     * ```
      */
     public set filtersExpanded(value: boolean);
           public get filtersExpanded(): boolean;
@@ -105,18 +54,6 @@ import { IgcPivotGridComponent } from './igc-pivot-grid-component';
     /**
      * Gets/sets whether the values panel is expanded
      * Get
-     * ```typescript
-     *  const valuesPanelState: boolean = this.dataSelector.valuesExpanded;
-     * ```
-     * Set
-     * ```html
-     * <igx-pivot-data-selector [grid]="grid1" [valuesExpanded]="valuesPanelState"></igx-pivot-data-selector>
-     * ```
-     *
-     * Two-way data binding:
-     * ```html
-     * <igx-pivot-data-selector [grid]="grid1" [(valuesExpanded)]="valuesPanelState"></igx-pivot-data-selector>
-     * ```
      */
     public set valuesExpanded(value: boolean);
           public get valuesExpanded(): boolean;
@@ -137,45 +74,21 @@ export declare interface IgcPivotDataSelectorComponentEventMap {
             
         		    /**
 		     * Emitted when the columns panel is expanded or collapsed.
-		     *
-		     * @example
-		     * ```html
-		     * <igx-pivot-data-selector #grid [data]="localData" [height]="'305px'"
-		     *              (columnsExpandedChange)="columnsExpandedChange($event)"></igx-pivot-data-selector>
-		     * ```
 		    */
 columnsExpandedChange: CustomEvent<boolean>;
 
         		    /**
 		     * Emitted when the rows panel is expanded or collapsed.
-		     *
-		     * @example
-		     * ```html
-		     * <igx-pivot-data-selector #grid [data]="localData" [height]="'305px'"
-		     *              (rowsExpandedChange)="rowsExpandedChange($event)"></igx-pivot-data-selector>
-		     * ```
 		    */
 rowsExpandedChange: CustomEvent<boolean>;
 
         		    /**
 		     * Emitted when the filters panel is expanded or collapsed.
-		     *
-		     * @example
-		     * ```html
-		     * <igx-pivot-data-selector #grid [data]="localData" [height]="'305px'"
-		     *              (filtersExpandedChange)="filtersExpandedChange($event)"></igx-pivot-data-selector>
-		     * ```
 		    */
 filtersExpandedChange: CustomEvent<boolean>;
 
         		    /**
 		     * Emitted when the values panel is expanded or collapsed.
-		     *
-		     * @example
-		     * ```html
-		     * <igx-pivot-data-selector #grid [data]="localData" [height]="'305px'"
-		     *              (valuesExpandedChange)="valuesExpandedChange($event)"></igx-pivot-data-selector>
-		     * ```
 		    */
 valuesExpandedChange: CustomEvent<boolean>;
 

package/grids/lib/igc-pivot-date-dimension.d.ts

@@ -56,9 +56,6 @@ import { IgcPivotDateDimensionOptions } from './igc-pivot-date-dimension-options
 
     /**
      * Gets/Sets the resource strings.
-     *
-     * @remarks
-     * By default it uses EN resources.
      */
     public set resourceStrings(value: IgcGridResourceStrings);
           public get resourceStrings(): IgcGridResourceStrings;