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

package/grids/lib/igc-pivot-grid-component.d.ts

@@ -52,19 +52,6 @@ import { IgcGridBaseDirectiveEventMap } from './igc-grid-base-directive';
 /* blazorIndirectRender */
 /**
  * Pivot Grid provides a way to present and manipulate data in a pivot table view.
- *
- * @igxModule IgxPivotGridModule
- * @igxGroup Grids & Lists
- * @igxKeywords pivot, grid, table
- * @igxTheme igx-grid-theme
- * @remarks
- * The Ignite UI Pivot Grid is used for grouping and aggregating simple flat data into a pivot table.  Once data
- * has been bound and the dimensions and values configured it can be manipulated via sorting and filtering.
- * @example
- * ```html
- * <igx-pivot-grid [data]="data" [pivotConfiguration]="configuration">
- * </igx-pivot-grid>
- * ```
  */
 
     export declare class IgcPivotGridComponent extends EventEmitterMixin<IgcPivotGridComponentEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)
@@ -81,11 +68,6 @@ import { IgcGridBaseDirectiveEventMap } from './igc-grid-base-directive';
 
     /**
      * Gets the sorting expressions generated for the dimensions.
-     *
-     * @example
-     * ```typescript
-     * const expressions = this.grid.dimensionsSortingExpressions;
-     * ```
      */
     public get dimensionsSortingExpressions(): IgcSortingExpression[];
         
@@ -93,11 +75,6 @@ import { IgcGridBaseDirectiveEventMap } from './igc-grid-base-directive';
 
     /**
      * Gets/Sets a custom template for the value chips.
-     *
-     * @example
-     * ```html
-     * <igx-pivot-grid [valueChipTemplate]="myTemplate"><igx-pivot-grid>
-     * ```
      */
     public set valueChipTemplate(value: IgcRenderFunction<IgcPivotGridValueTemplateContext>);
           public get valueChipTemplate(): IgcRenderFunction<IgcPivotGridValueTemplateContext>;
@@ -113,11 +90,6 @@ import { IgcGridBaseDirectiveEventMap } from './igc-grid-base-directive';
     /* @tsTwoWayProperty (true, "PivotConfigurationChange", "Detail.PivotConfiguration", false) */
     /**
      * Gets/Sets the pivot configuration with all related dimensions and values.
-     *
-     * @example
-     * ```html
-     * <igx-pivot-grid [pivotConfiguration]="config"></igx-pivot-grid>
-     * ```
      */
     /* @tsTwoWayProperty (true, "PivotConfigurationChange", "Detail.PivotConfiguration", false) */
         /* @blazorSynthesizeTwoWayBind */
@@ -128,13 +100,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
 
     /**
      * Gets/Sets whether to auto-generate the pivot configuration based on the provided data.
-     *
-     * @remarks
-     * The default value is false. When set to true, it will override all dimensions and values in the pivotConfiguration.
-     * @example
-     * ```html
-     * <igx-pivot-grid [data]="Data" [autoGenerateConfig]="true"></igx-pivot-grid>
-     * ```
      */
     public set autoGenerateConfig(value: boolean);
           public get autoGenerateConfig(): boolean;
@@ -148,12 +113,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
 
     /**
      * Enables a super compact theme for the component.
-     * @remarks
-     * Overrides the grid size option if one is set.
-     * @example
-     * ```html
-     * <igx-pivot-grid [superCompactMode]="true"></igx-pivot-grid>
-     * ```
      */
     public set superCompactMode(value: boolean);
           public get superCompactMode(): boolean;
@@ -175,11 +134,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
 
     /**
      * Gets the full list of dimensions.
-     *
-     * @example
-     * ```typescript
-     * const dimensions = this.grid.allDimensions;
-     * ```
      */
     public get allDimensions(): IgcPivotDimension[];
         
@@ -189,9 +143,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
     /* blazorAlternateType: object */
     /**
      * Gets/Sets the array of data that populates the component.
-     * ```html
-     * <igx-pivot-grid [data]="Data"></igx-pivot-grid>
-     * ```
      */
     public set data(value: any[]);
           public get data(): any[];
@@ -200,11 +151,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
 
     /**
      * Gets/Sets a custom template when pivot grid is empty.
-     *
-     * @example
-     * ```html
-     * <igx-pivot-grid [emptyPivotGridTemplate]="myTemplate"><igx-pivot-grid>
-     * ```
      */
     public set emptyPivotGridTemplate(value: IgcRenderFunction<void>);
           public get emptyPivotGridTemplate(): IgcRenderFunction<void>;
@@ -232,13 +178,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
 
     /**
      * Auto-sizes row dimension cells.
-     *
-     * @remarks
-     * Only sizes based on the dimension cells in view.
-     * @example
-     * ```typescript
-     * this.grid.autoSizeRowDimension(dimension);
-     * ```
      * @param dimension The row dimension to size.
      */
     public autoSizeRowDimension(dimension: IgcPivotDimension): void;
@@ -247,11 +186,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
 
     /**
      * Inserts dimension in target collection by type at specified index or at the collection's end.
-     *
-     * @example
-     * ```typescript
-     * this.grid.insertDimensionAt(dimension, PivotDimensionType.Row, 1);
-     * ```
      * @param dimension The dimension that will be added.
      * @param targetCollectionType The target collection type to add to. Can be Row, Column or Filter.
      * @param index The index in the collection at which to add.
@@ -263,11 +197,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
 
     /**
      * Move dimension from its currently collection to the specified target collection by type at specified index or at the collection's end.
-     *
-     * @example
-     * ```typescript
-     * this.grid.moveDimension(dimension, PivotDimensionType.Row, 1);
-     * ```
      * @param dimension The dimension that will be moved.
      * @param targetCollectionType The target collection type to move it to. Can be Row, Column or Filter.
      * @param index The index in the collection at which to add.
@@ -279,13 +208,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
 
     /**
      * Removes dimension from its currently collection.
-     * @remarks
-     * This is different than toggleDimension that enabled/disables the dimension.
-     * This completely removes the specified dimension from the collection.
-     * @example
-     * ```typescript
-     * this.grid.removeDimension(dimension);
-     * ```
      * @param dimension The dimension to be removed.
      */
     public removeDimension(dimension: IgcPivotDimension): void;
@@ -294,12 +216,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
 
     /**
      * Toggles the dimension's enabled state on or off.
-     * @remarks
-     * The dimension remains in its current collection. This just changes its enabled state.
-     * @example
-     * ```typescript
-     * this.grid.toggleDimension(dimension);
-     * ```
      * @param dimension The dimension to be toggled.
      */
     public toggleDimension(dimension: IgcPivotDimension): void;
@@ -308,11 +224,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
 
     /**
      * Inserts value at specified index or at the end.
-     *
-     * @example
-     * ```typescript
-     * this.grid.insertValueAt(value, 1);
-     * ```
      * @param value The value definition that will be added.
      * @param index The index in the collection at which to add.
      * This parameter is optional. If not set it will add it to the end of the collection.
@@ -323,11 +234,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
 
     /**
      * Move value from its currently at specified index or at the end.
-     *
-     * @example
-     * ```typescript
-     * this.grid.moveValue(value, 1);
-     * ```
      * @param value The value that will be moved.
      * @param index The index in the collection at which to add.
      * This parameter is optional. If not set it will add it to the end of the collection.
@@ -338,13 +244,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
 
     /**
      * Removes value from collection.
-     * @remarks
-     * This is different than toggleValue that enabled/disables the value.
-     * This completely removes the specified value from the collection.
-     * @example
-     * ```typescript
-     * this.grid.removeValue(dimension);
-     * ```
      * @param value The value to be removed.
      */
     public removeValue(value: IgcPivotValue): void;
@@ -353,12 +252,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
 
     /**
      * Toggles the value's enabled state on or off.
-     * @remarks
-     * The value remains in its current collection. This just changes its enabled state.
-     * @example
-     * ```typescript
-     * this.grid.toggleValue(value);
-     * ```
      * @param value The value to be toggled.
      */
     public toggleValue(value: IgcPivotValue): void;
@@ -367,10 +260,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
 
     /**
      * Sort the dimension and its children in the provided direction.
-     * @example
-     * ```typescript
-     * this.grid.sortDimension(dimension, SortingDirection.Asc);
-     * ```
      * @param value The value to be toggled.
      */
     public sortDimension(dimension: IgcPivotDimension, sortDirection: SortingDirection): void;
@@ -379,16 +268,6 @@ public set pivotConfiguration(value: IgcPivotConfiguration);
 
     /**
      * Filters a single `IPivotDimension`.
-     *
-     * @example
-     * ```typescript
-     * public filter() {
-     *      const set = new Set();
-     *      set.add('Value 1');
-     *      set.add('Value 2');
-     *      this.grid1.filterDimension(this.pivotConfigHierarchy.rows[0], set, IgxStringFilteringOperand.instance().condition('in'));
-     * }
-     * ```
      */
     public filterDimension(dimension: IgcPivotDimension, value: any, conditionOrExpressionTree?: IgcFilteringExpressionsTree | IgcFilteringOperation): void;
 
@@ -398,73 +277,31 @@ export declare interface IgcPivotGridComponentEventMap extends IgcGridBaseDirect
             
         		    /**
 		     * Emitted when the dimension collection is changed via the grid chip area.
-		     *
-		     * @remarks
-		     * Returns the new dimension collection and its type:
-		     * @example
-		     * ```html
-		     * <igx-pivot-grid #grid [data]="localData" [height]="'305px'"
-		     *              (dimensionsChange)="dimensionsChange($event)"></igx-grid>
-		     * ```
 		     */
 dimensionsChange: CustomEvent<IgcDimensionsChange>;
 
         		    /**
 		     * Emitted when any of the pivotConfiguration properties is changed via the grid chip area.
-		     *
-		     * @example
-		     * ```html
-		     * <igx-pivot-grid #grid [data]="localData" [height]="'305px'"
-		     *              (pivotConfigurationChanged)="configurationChanged($event)"></igx-grid>
-		     * ```
 		     */
 pivotConfigurationChange: CustomEvent<IgcPivotConfigurationChangedEventArgs>;
 
         		    /**
 		     * Emitted when the dimension is initialized.
-		     * @remarks
-		     * Emits the dimension that is about to be initialized.
-		     * @example
-		     * ```html
-		     * <igx-pivot-grid #grid [data]="localData" [height]="'305px'"
-		     *              (dimensionInit)="dimensionInit($event)"></igx-pivot-grid>
-		     * ```
 		     */
 dimensionInit: CustomEvent<IgcPivotDimension>;
 
         		    /**
 		     * Emitted when the value is initialized.
-		     * @remarks
-		     * Emits the value that is about to be initialized.
-		     * @example
-		     * ```html
-		     * <igx-pivot-grid #grid [data]="localData" [height]="'305px'"
-		     *              (valueInit)="valueInit($event)"></igx-pivot-grid>
-		     * ```
 		     */
 valueInit: CustomEvent<IgcPivotValue>;
 
         		    /**
 		     * Emitted when a dimension is sorted.
-		     *
-		     * @example
-		     * ```html
-		     * <igx-pivot-grid #grid [data]="localData" [height]="'305px'"
-		     *              (dimensionsSortingExpressionsChange)="dimensionsSortingExpressionsChange($event)"></igx-pivot-grid>
-		     * ```
 		     */
 dimensionsSortingExpressionsChange: CustomEvent<IgcSortingExpression[]>;
 
         		    /**
 		     * Emitted when the values collection is changed via the grid chip area.
-		     *
-		     * @remarks
-		     * Returns the new dimension
-		     * @example
-		     * ```html
-		     * <igx-pivot-grid #grid [data]="localData" [height]="'305px'"
-		     *              (valuesChange)="valuesChange($event)"></igx-grid>
-		     * ```
 		    */
 valuesChange: CustomEvent<IgcValuesChange>;
 

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

@@ -42,7 +42,7 @@ import { GridColumnDataType } from './grid-column-data-type';
           public get enabled(): boolean;
   
           
-    /**  Allow conditionally styling of the IgxPivotGrid cells. */
+    /**  Allow conditionally styling of the pivot grid cells. */
     public styles?: any;
   
           

package/grids/lib/igc-position-settings.d.ts

@@ -12,18 +12,22 @@ import { IgcSize } from './igc-size';
     {
 
           
+    /* mustCoerceToInt */
     /** Direction in which the component should show */
     public horizontalDirection?: HorizontalAlignment;
   
           
+    /* mustCoerceToInt */
     /** Direction in which the component should show */
     public verticalDirection?: VerticalAlignment;
   
           
+    /* mustCoerceToInt */
     /** Target's starting point */
     public horizontalStartPoint?: HorizontalAlignment;
   
           
+    /* mustCoerceToInt */
     /** Target's starting point */
     public verticalStartPoint?: VerticalAlignment;
   

package/grids/lib/igc-position-strategy.d.ts

@@ -7,7 +7,7 @@ import { IgcPositionSettings } from './igc-position-settings';
 
 /**
  * [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay-position)
- * Position strategies determine where to display the component in the provided IgxOverlayService.
+ * Position strategies determine where to display the component in the provided overlay.
  */
 
     export declare class IgcPositionStrategy
@@ -24,9 +24,6 @@ import { IgcPositionSettings } from './igc-position-settings';
 
     /**
      * Clone the strategy instance.
-     * ```typescript
-     * settings.positionStrategy.clone();
-     * ```
      */
      public clone(): IgcPositionStrategy;
 

package/grids/lib/igc-query-builder-component.d.ts

@@ -16,12 +16,6 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
  * A component used for operating with complex filters by creating or editing conditions
  * and grouping them using AND/OR logic.
  * It is used internally in the Advanced Filtering of the Grid.
- *
- * @example
- * ```html
- * <igx-query-builder [entities]="this.entities">
- * </igx-query-builder>
- * ```
  */
 
     export declare class IgcQueryBuilderComponent extends EventEmitterMixin<IgcQueryBuilderComponentEventMap, Constructor<LitElement>>(LitElement)
@@ -45,12 +39,9 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
           
 
     /**
-     * Gets the list of entities available for the IgxQueryBuilderComponent.
-     *
+     * Gets the list of entities available for the query builder.
      * Each entity describes a logical group of fields that can be used in queries.
      * An entity can optionally have child entities, allowing nested sub-queries.
-     *
-     * @returns An array of {@link EntityType} objects.
      */
     public set entities(value: IgcEntityType[]);
           public get entities(): IgcEntityType[];
@@ -146,10 +137,6 @@ export declare interface IgcQueryBuilderComponentEventMap {
             
         		    /**
 		     * Event fired as the expression tree is changed.
-		     *
-		     * ```html
-		     *  <igx-query-builder (expressionTreeChange)='onExpressionTreeChange()'></igx-query-builder>
-		     * ```
 		     */
 expressionTreeChange: CustomEvent<IgcExpressionTree>;
 

package/grids/lib/igc-query-builder-header-component.d.ts

@@ -12,7 +12,6 @@ import { IgcQueryBuilderResourceStrings } from './igc-query-builder-resource-str
 /* singleInstanceIdentifier */
 /* contentParent: QueryBuilder */
 /**
-* @igxParent IgxQueryBuilderComponent
 */
 
     export declare class IgcQueryBuilderHeaderComponent extends HTMLElement
@@ -26,12 +25,7 @@ import { IgcQueryBuilderResourceStrings } from './igc-query-builder-resource-str
           
 
     /**
-     * Sets the title of the `IgxQueryBuilderHeaderComponent`.
-     *
-     * @example
-     * ```html
-     * <igx-query-builder-header title="Sample Query Builder"></igx-query-builder-header>
-     * ```
+     * Sets the title of the query builder header.
      */
     public set title(value: string);
           public get title(): string;
@@ -40,11 +34,6 @@ import { IgcQueryBuilderResourceStrings } from './igc-query-builder-resource-str
 
     /**
      * Show/hide the legend.
-     *
-     * @example
-     * ```html
-     * <igx-query-builder-header [showLegend]="false"></igx-query-builder-header>
-     * ```
      * @deprecated 
      */
     public set showLegend(value: boolean);
@@ -55,7 +44,6 @@ import { IgcQueryBuilderResourceStrings } from './igc-query-builder-resource-str
     /**
      * Sets the resource strings.
      * By default it uses EN resources.
-     *
      * @deprecated 
      */
     public set resourceStrings(value: IgcQueryBuilderResourceStrings);

package/grids/lib/igc-row-data-cancelable-event-args.d.ts

@@ -1,5 +1,6 @@
 
 import { IgcGridBaseDirective } from './igc-grid-base-directive';
+import { IgcColumnComponent } from './igc-column-component';
 
 
 
@@ -55,6 +56,33 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
         
     public rowKey: any;
 
+        
+    /**
+     * Provides the ability to cancel the event.
+     */
+    public cancel: boolean;
+
+        
+    /**
+     * @deprecated Use the `rowKey` property instead.
+     */
+    public rowID: any;
+
+        
+    /**
+     * Optional
+     * Represents the column information of the edited cell
+     */
+    public column?: IgcColumnComponent;
+
+        
+    /**
+     * Optional
+     * Indicates if the new value would be valid.
+     * It can be set to return the result of the methods for validation of the grid
+     */
+    public valid?: boolean;
+
     }
 
 

package/grids/lib/igc-row-directive.d.ts

@@ -13,23 +13,14 @@ import { IgcCellType } from './igc-cell-type';
 
     /**
      *  The data passed to the row component.
-     *
-     * ```typescript
-     * // get the row data for the first selected row
-     * let selectedRowData = this.grid.selectedRows[0].data;
-     * ```
      */
     public set data(value: any);
           public get data(): any;
   
           
+
     /**
      * The index of the row.
-     *
-     * ```typescript
-     * // get the index of the second selected row
-     * let selectedRowIndex = this.grid.selectedRows[1].index;
-     * ```
      */
     public set index(value: number);
           public get index(): number;
@@ -39,9 +30,6 @@ import { IgcCellType } from './igc-cell-type';
     /**
      * Sets whether this specific row has disabled functionality for editing and row selection.
      * Default value is `false`.
-     * ```typescript
-     * this.grid.selectedRows[0].pinned = true;
-     * ```
      */
     public set disabled(value: boolean);
           public get disabled(): boolean;
@@ -51,9 +39,6 @@ import { IgcCellType } from './igc-cell-type';
     /**
      * Sets whether the row is pinned.
      * Default value is `false`.
-     * ```typescript
-     * this.grid.selectedRows[0].pinned = true;
-     * ```
      */
     public set pinned(value: boolean);
           public get pinned(): boolean;
@@ -66,9 +51,6 @@ import { IgcCellType } from './igc-cell-type';
 
     /**
      * Gets the expanded state of the row.
-     * ```typescript
-     * let isExpanded = row.expanded;
-     * ```
      */
     public set expanded(value: boolean);
           public get expanded(): boolean;
@@ -85,11 +67,6 @@ import { IgcCellType } from './igc-cell-type';
 
     /**
      * Gets the rendered cells in the row component.
-     *
-     * ```typescript
-     * // get the cells of the third selected row
-     * let selectedRowCells = this.grid.selectedRows[2].cells;
-     * ```
      */
     public get cells(): IgcCellType[];
         
@@ -109,10 +86,6 @@ import { IgcCellType } from './igc-cell-type';
      * A row in the grid is identified either by:
      * - primaryKey data value,
      * - the whole data, if the primaryKey is omitted.
-     *
-     * ```typescript
-     * let rowID = this.grid.selectedRows[2].key;
-     * ```
      */
     public get key(): any;
         
@@ -120,12 +93,6 @@ import { IgcCellType } from './igc-cell-type';
 
     /**
      * Updates the specified row object and the data source record with the passed value.
-     *
-     * ```typescript
-     * // update the second selected row's value
-     * let newValue = "Apple";
-     * this.grid.selectedRows[1].update(newValue);
-     * ```
      */
     public update(value: any): void;
 
@@ -134,11 +101,6 @@ import { IgcCellType } from './igc-cell-type';
     /**
      * Removes the specified row from the grid's data source.
      * This method emits `rowDeleted` event.
-     *
-     * ```typescript
-     * // delete the third selected row from the grid
-     * this.grid.selectedRows[2].delete();
-     * ```
      */
     public delete(): void;
 
@@ -151,11 +113,6 @@ import { IgcCellType } from './igc-cell-type';
     /**
      * Pins the specified row.
      * This method emits `rowPinning`\`rowPinned` event.
-     *
-     * ```typescript
-     * // pin the selected row from the grid
-     * this.grid.selectedRows[0].pin();
-     * ```
      */
     public pin(): void;
 
@@ -164,11 +121,6 @@ import { IgcCellType } from './igc-cell-type';
     /**
      * Unpins the specified row.
      * This method emits `rowPinning`\`rowPinned` event.
-     *
-     * ```typescript
-     * // unpin the selected row from the grid
-     * this.grid.selectedRows[0].unpin();
-     * ```
      */
     public unpin(): void;
 
@@ -176,12 +128,6 @@ import { IgcCellType } from './igc-cell-type';
 
     /**
      * Spawns the add row UI for the specific row.
-     *
-     * @example
-     * ```typescript
-     * const row = this.grid1.getRowByIndex(1);
-     * row.beginAddRow();
-     * ```
      */
     public beginAddRow(): void;