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

package/grids/lib/igc-column-exporting-event-args.d.ts

@@ -7,11 +7,6 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
 
 /**
  * columnExporting event arguments
- * ```typescript
- * this.exporterService.columnExporting.subscribe((args: IColumnExportingEventArgs) => {
- * // set args properties here
- * });
- * ```
  */
 
     export declare class IgcColumnExportingEventArgs extends IgcBaseEventArgs

package/grids/lib/igc-column-group-component.d.ts

@@ -15,8 +15,6 @@ import { IgcColumnComponentEventMap } from './igc-column-component';
 /* blazorIndirectRender */
 /**
  * **Ignite UI for Angular Column Group**
- *
- * @igxParent IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxColumnGroupComponent, IgxRowIslandComponent
  */
 
     export declare class IgcColumnGroupComponent extends IgcColumnComponent
@@ -46,11 +44,6 @@ import { IgcColumnComponentEventMap } from './igc-column-component';
     /**
      * Set if the column group is collapsible.
      * Default value is `false`
-     * ```html
-     *  <igx-column-group [collapsible] = "true"></igx-column-group>
-     * ```
-     *
-     * @memberof IgxColumnGroupComponent
      */
     public set collapsible(value: boolean);
           public get collapsible(): boolean;
@@ -61,12 +54,6 @@ import { IgcColumnComponentEventMap } from './igc-column-component';
      * Set whether the group is expanded or collapsed initially.
      * Applied only if the collapsible property is set to `true`
      * Default value is `true`
-     * ```html
-     *  const state = false
-     *  <igx-column-group [(expand)] = "state"></igx-column-group>
-     * ```
-     *
-     * @memberof IgxColumnGroupComponent
      */
     public set expanded(value: boolean);
           public get expanded(): boolean;
@@ -75,22 +62,12 @@ import { IgcColumnComponentEventMap } from './igc-column-component';
 
     /**
      * Gets the column group `summaries`.
-     * ```typescript
-     * let columnGroupSummaries = this.columnGroup.summaries;
-     * ```
-     *
-     * @memberof IgxColumnGroupComponent
      */
     public get summaries(): any;
         
                 
     /**
      * Gets the column group `filters`.
-     * ```typescript
-     * let columnGroupFilters = this.columnGroup.filters;
-     * ```
-     *
-     * @memberof IgxColumnGroupComponent
      */
     public get filters(): any;
         
@@ -98,11 +75,6 @@ import { IgcColumnComponentEventMap } from './igc-column-component';
 
     /**
      * Returns if the column group is selectable
-     * ```typescript
-     * let columnGroupSelectable = this.columnGroup.selectable;
-     * ```
-     *
-     * @memberof IgxColumnGroupComponent
      */
     public get selectable(): boolean;
         
@@ -110,8 +82,6 @@ import { IgcColumnComponentEventMap } from './igc-column-component';
 
     /**
      * Allows you to define a custom template for expand/collapse indicator
-     *
-     * @memberof IgxColumnGroupComponent
      */
     public set collapsibleIndicatorTemplate(value: IgcRenderFunction<IgcColumnTemplateContext>);
           public get collapsibleIndicatorTemplate(): IgcRenderFunction<IgcColumnTemplateContext>;
@@ -119,11 +89,6 @@ import { IgcColumnComponentEventMap } from './igc-column-component';
                 
     /**
      * Gets whether the column group is hidden.
-     * ```typescript
-     * let isHidden = this.columnGroup.hidden;
-     * ```
-     *
-     * @memberof IgxColumnGroupComponent
      */
     public get hidden(): boolean;
         
@@ -131,11 +96,6 @@ import { IgcColumnComponentEventMap } from './igc-column-component';
 
     /**
      * Returns if the column group is selected.
-     * ```typescript
-     * let isSelected = this.columnGroup.selected;
-     * ```
-     *
-     * @memberof IgxColumnGroupComponent
      */
     public get selected(): boolean;
         
@@ -150,33 +110,18 @@ import { IgcColumnComponentEventMap } from './igc-column-component';
                 
     /**
      * Returns a boolean indicating if the column is a `ColumnGroup`.
-     * ```typescript
-     * let isColumnGroup =  this.columnGroup.columnGroup
-     * ```
-     *
-     * @memberof IgxColumnGroupComponent
      */
     public get columnGroup(): boolean;
         
                 
     /**
      * Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout.
-     * ```typescript
-     * let columnGroup =  this.column.columnGroup;
-     * ```
-     *
-     * @memberof IgxColumnComponent
      */
     public get columnLayout(): boolean;
         
                 
     /**
      * Gets the width of the column group.
-     * ```typescript
-     * let columnGroupWidth = this.columnGroup.width;
-     * ```
-     *
-     * @memberof IgxColumnGroupComponent
      */
     public get width(): string;
         

package/grids/lib/igc-column-layout-component.d.ts

@@ -13,8 +13,6 @@ import { IgcColumnComponentEventMap } from './igc-column-component';
 /* jsonAPIManageCollectionInMarkup */
 /**
  * Column layout for declaration of Multi-row Layout
- *
- * @igxParent IgxGridComponent
  */
 
     export declare class IgcColumnLayoutComponent extends IgcColumnGroupComponent
@@ -28,11 +26,6 @@ import { IgcColumnComponentEventMap } from './igc-column-component';
                 
     /**
      * Gets the width of the column layout.
-     * ```typescript
-     * let columnGroupWidth = this.columnGroup.width;
-     * ```
-     *
-     * @memberof IgxColumnGroupComponent
      */
     public get width(): any;
         
@@ -41,11 +34,6 @@ import { IgcColumnComponentEventMap } from './igc-column-component';
     /**
      * Gets the column visible index.
      * If the column is not visible, returns `-1`.
-     * ```typescript
-     * let visibleColumnIndex =  this.column.visibleIndex;
-     * ```
-     *
-     * @memberof IgxColumnComponent
      */
     public get visibleIndex(): number;
         

package/grids/lib/igc-column-toggled-event-args.d.ts

@@ -7,7 +7,7 @@ import { IgcColumnComponent } from './igc-column-component';
 
 /**
  * Event emitted when a checkbox in the checkbox
- * list of an IgxColumnActions component is clicked.
+ * list of an column actions component is clicked.
  */
 
     export declare class IgcColumnToggledEventArgs extends IgcBaseEventArgs

package/grids/lib/igc-columns-auto-generated-event-args.d.ts

@@ -5,8 +5,6 @@ import { IgcColumnComponent } from './igc-column-component';
 
 
 
-/* blazorInclude */
-/** @hidden @internal */
 
     export declare class IgcColumnsAutoGeneratedEventArgs extends IgcBaseEventArgs
     {

package/grids/lib/igc-csv-exporter-options.d.ts

@@ -17,11 +17,6 @@ import { CsvFileTypes } from './csv-file-types';
 
     /**
      * Gets the value delimiter which will be used for the exporting operation.
-     * ```typescript
-     * let delimiter = this.exportOptions.valueDelimiter;
-     * ```
-     *
-     * @memberof IgxCsvExporterOptions
      */
     public set valueDelimiter(value: any);
           public get valueDelimiter(): any;
@@ -30,11 +25,6 @@ import { CsvFileTypes } from './csv-file-types';
 
     /**
      * Gets the CSV export format.
-     * ```typescript
-     * let filetype = this.exportOptions.fileType;
-     * ```
-     *
-     * @memberof IgxCsvExporterOptions
      */
     public set fileType(value: any);
           public get fileType(): any;

package/grids/lib/igc-csv-exporter-service.d.ts

@@ -11,24 +11,9 @@ import { IgcBaseExporterEventMap } from './igc-base-exporter';
 /**
  * **Ignite UI for Angular CSV Exporter Service** -
  * [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/exporter-csv)
- *
  * The Ignite UI for Angular CSV Exporter service can export data in a Character Separated Values format from
- * both raw data (array) or from an `IgxGrid`.
- *
+ * both raw data (array) or from an grid.
  * Example:
- * ```typescript
- * public localData = [
- *   { Name: "Eric Ridley", Age: "26" },
- *   { Name: "Alanis Brook", Age: "22" },
- *   { Name: "Jonathan Morris", Age: "23" }
- * ];
- *
- * constructor(private csvExportService: IgxCsvExporterService) {
- * }
- *
- * const opt: IgxCsvExporterOptions = new IgxCsvExporterOptions("FileName", CsvFileTypes.CSV);
- * this.csvExportService.exportData(this.localData, opt);
- * ```
  */
 
     export declare class IgcCsvExporterService extends EventEmitterMixin<IgcCsvExporterServiceEventMap, AbstractConstructor<IgcBaseExporter>>(IgcBaseExporter)
@@ -41,13 +26,6 @@ export declare interface IgcCsvExporterServiceEventMap extends IgcBaseExporterEv
             
         		    /**
 		     * This event is emitted when the export process finishes.
-		     * ```typescript
-		     * this.exporterService.exportEnded.subscribe((args: ICsvExportEndedEventArgs) => {
-		     * // put event handler code here
-		     * });
-		     * ```
-		     *
-		     * @memberof IgxCsvExporterService
 		     */
 exportEnded: CustomEvent<IgcCsvExportEndedEventArgs>;
 

package/grids/lib/igc-data-clone-strategy.d.ts

@@ -12,7 +12,6 @@
     /**
      * Clones provided data
      * @param data primitive value, date and object to be cloned
-     * @returns deep copy of provided value
      */
     public clone(data: any): any;
 

package/grids/lib/igc-date-filtering-operand.d.ts

@@ -7,8 +7,6 @@ import { IgcBaseDateTimeFilteringOperand } from './igc-base-date-time-filtering-
 /* blazorCSSuppress */
 /**
  * Provides filtering operations for Dates
- *
- * @export
  */
 
     export declare class IgcDateFilteringOperand extends IgcBaseDateTimeFilteringOperand

package/grids/lib/igc-date-summary-operand.d.ts

@@ -16,11 +16,6 @@ import { IgcSummaryResult } from './igc-summary-result';
     /**
      * Returns the latest date value in the data records.
      * If filtering is applied, returns the latest date value in the filtered data records.
-     * ```typescript
-     * IgxDateSummaryOperand.latest(data);
-     * ```
-     *
-     * @memberof IgxDateSummaryOperand
      */
     public static latest(data: any[]): void;
 
@@ -28,44 +23,12 @@ import { IgcSummaryResult } from './igc-summary-result';
     /**
      * Returns the earliest date value in the data records.
      * If filtering is applied, returns the latest date value in the filtered data records.
-     * ```typescript
-     * IgxDateSummaryOperand.earliest(data);
-     * ```
-     *
-     * @memberof IgxDateSummaryOperand
      */
     public static earliest(data: any[]): void;
 
             
     /**
-     * Executes the static methods and returns `IgxSummaryResult[]`.
-     * ```typescript
-     * interface IgxSummaryResult {
-     *   key: string;
-     *   label: string;
-     *   summaryResult: any;
-     * }
-     * ```
-     * Can be overridden in the inherited classes to provide customization for the `summary`.
-     * ```typescript
-     * class CustomDateSummary extends IgxDateSummaryOperand {
-     *   constructor() {
-     *     super();
-     *   }
-     *   public operate(data: any[], allData: any[], fieldName: string, groupRecord: IGroupByRecord): IgxSummaryResult[] {
-     *     const result = super.operate(data, allData, fieldName, groupRecord);
-     *     result.push({
-     *       key: "deadline",
-     *       label: "Deadline Date",
-     *       summaryResult: this.calculateDeadline(data);
-     *     });
-     *     return result;
-     *   }
-     * }
-     * this.grid.getColumnByName('ColumnName').summaries = CustomDateSummary;
-     * ```
-     *
-     * @memberof IgxDateSummaryOperand
+     * Executes the static methods and returns summary result[]`.
      */
     public operate(data?: any[], allData?: any[], fieldName?: string, groupRecord?: IgcGroupByRecord): IgcSummaryResult[];
 

package/grids/lib/igc-dimensions-change.d.ts

@@ -19,6 +19,7 @@ import { PivotDimensionType } from './pivot-dimension-type';
           public get dimensions(): IgcPivotDimension[];
   
           
+    /* mustCoerceToInt */
     /** The dimension list type - Row, Column or Filter. */
     public set dimensionCollectionType(value: PivotDimensionType);
           public get dimensionCollectionType(): PivotDimensionType;

package/grids/lib/igc-excel-exporter-options.d.ts

@@ -16,12 +16,6 @@ import { IgcExporterOptionsBase } from './igc-exporter-options-base';
     /**
      * Specifies if column pinning should be ignored. If ignoreColumnsOrder is set to true,
      * this option will always be considered as set to true.
-     * ```typescript
-     * let ignorePinning = this.exportOptions.ignorePinning;
-     * this.exportOptions.ignorePinning = true;
-     * ```
-     *
-     * @memberof IgxExcelExporterOptions
      */
     public set ignorePinning(value: boolean);
           public get ignorePinning(): boolean;
@@ -30,12 +24,6 @@ import { IgcExporterOptionsBase } from './igc-exporter-options-base';
 
     /**
      * Specifies whether the exported data should be formatted as Excel table. (True by default)
-     * ```typescript
-     * let exportAsTable = this.exportOptions.exportAsTable;
-     * this.exportOptions.exportAsTable = false;
-     * ```
-     *
-     * @memberof IgxExcelExporterOptions
      */
     public set exportAsTable(value: boolean);
           public get exportAsTable(): boolean;
@@ -44,11 +32,6 @@ import { IgcExporterOptionsBase } from './igc-exporter-options-base';
 
     /**
      * Gets the width of the columns in the exported excel file.
-     * ```typescript
-     * let width = this.exportOptions.columnWidth;
-     * ```
-     *
-     * @memberof IgxExcelExporterOptions
      */
     public set columnWidth(value: number);
           public get columnWidth(): number;
@@ -57,11 +40,6 @@ import { IgcExporterOptionsBase } from './igc-exporter-options-base';
 
     /**
      * Gets the height of the rows in the exported excel file.
-     * ```typescript
-     * let height = this.exportOptions.rowHeight;
-     * ```
-     *
-     * @memberof IgxExcelExporterOptions
      */
     public set rowHeight(value: number);
           public get rowHeight(): number;
@@ -70,11 +48,6 @@ import { IgcExporterOptionsBase } from './igc-exporter-options-base';
 
     /**
      * Gets the name of the worksheet in the exported excel file.
-     * ```typescript
-     * let worksheetName = this.exportOptions.worksheetName;
-     * ```
-     *
-     * @memberof IgxExcelExporterOptions
      */
     public set worksheetName(value: string);
           public get worksheetName(): string;

package/grids/lib/igc-excel-exporter-service.d.ts

@@ -11,23 +11,9 @@ import { IgcBaseExporterEventMap } from './igc-base-exporter';
 /**
  * **Ignite UI for Angular Excel Exporter Service** -
  * [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/exporter_excel.html)
- *
  * The Ignite UI for Angular Excel Exporter service can export data in Microsoft® Excel® format from both raw data
- * (array) or from an `IgxGrid`.
- *
+ * (array) or from an grid.
  * Example:
- * ```typescript
- * public localData = [
- *   { Name: "Eric Ridley", Age: "26" },
- *   { Name: "Alanis Brook", Age: "22" },
- *   { Name: "Jonathan Morris", Age: "23" }
- * ];
- *
- * constructor(private excelExportService: IgxExcelExporterService) {
- * }
- *
- * this.excelExportService.exportData(this.localData, new IgxExcelExporterOptions("FileName"));
- * ```
  */
 
     export declare class IgcExcelExporterService extends EventEmitterMixin<IgcExcelExporterServiceEventMap, AbstractConstructor<IgcBaseExporter>>(IgcBaseExporter)
@@ -40,13 +26,6 @@ export declare interface IgcExcelExporterServiceEventMap extends IgcBaseExporter
             
         		    /**
 		     * This event is emitted when the export process finishes.
-		     * ```typescript
-		     * this.exporterService.exportEnded.subscribe((args: IExcelExportEndedEventArgs) => {
-		     * // put event handler code here
-		     * });
-		     * ```
-		     *
-		     * @memberof IgxExcelExporterService
 		     */
 exportEnded: CustomEvent<IgcExcelExportEndedEventArgs>;
 

package/grids/lib/igc-exporter-event-args.d.ts

@@ -12,23 +12,19 @@ import { IgcGridBaseDirective } from './igc-grid-base-directive';
     export declare class IgcExporterEventArgs
     {
 
-          
-    public set exporter(value: IgcBaseExporter);
-          public get exporter(): IgcBaseExporter;
-  
-          
+        
+    public exporter: IgcBaseExporter;
+
+        
     /* alternateType: ExporterOptionsBase */
-    public set options(value: IgcExporterOptionsBase);
-          public get options(): IgcExporterOptionsBase;
-  
-          
-    public set grid(value: IgcGridBaseDirective);
-          public get grid(): IgcGridBaseDirective;
-  
-          
-    public set cancel(value: boolean);
-          public get cancel(): boolean;
-  
+    public options: IgcExporterOptionsBase;
+
+        
+    public grid: IgcGridBaseDirective;
+
+        
+    public cancel: boolean;
+
     }
 
 

package/grids/lib/igc-exporter-options-base.d.ts

@@ -8,12 +8,6 @@
           
     /**
      * Specifies whether hidden columns should be exported.
-     * ```typescript
-     * let ignoreColumnsVisibility = this.exportOptions.ignoreColumnsVisibility;
-     * this.exportOptions.ignoreColumnsVisibility = true;
-     * ```
-     *
-     * @memberof IgxExporterOptionsBase
      */
     public set ignoreColumnsVisibility(value: boolean);
           public get ignoreColumnsVisibility(): boolean;
@@ -22,12 +16,6 @@
 
     /**
      * Specifies whether filtered out rows should be exported.
-     * ```typescript
-     * let ignoreFiltering = this.exportOptions.ignoreFiltering;
-     * this.exportOptions.ignoreFiltering = true;
-     * ```
-     *
-     * @memberof IgxExporterOptionsBase
      */
     public set ignoreFiltering(value: boolean);
           public get ignoreFiltering(): boolean;
@@ -35,13 +23,7 @@
           
 
     /**
-     * Specifies if the exporter should ignore the current column order in the IgxGrid.
-     * ```typescript
-     * let ignoreColumnsOrder = this.exportOptions.ignoreColumnsOrder;
-     * this.exportOptions.ignoreColumnsOrder = true;
-     * ```
-     *
-     * @memberof IgxExporterOptionsBase
+     * Specifies if the exporter should ignore the current column order in the grid.
      */
     public set ignoreColumnsOrder(value: boolean);
           public get ignoreColumnsOrder(): boolean;
@@ -49,15 +31,9 @@
           
 
     /**
-     * Specifies whether the exported data should be sorted as in the provided IgxGrid.
+     * Specifies whether the exported data should be sorted as in the provided grid.
      * When you export grouped data, setting ignoreSorting to true will cause
      * the grouping to fail because it relies on the sorting of the records.
-     * ```typescript
-     * let ignoreSorting = this.exportOptions.ignoreSorting;
-     * this.exportOptions.ignoreSorting = true;
-     * ```
-     *
-     * @memberof IgxExporterOptionsBase
      */
     public set ignoreSorting(value: boolean);
           public get ignoreSorting(): boolean;
@@ -65,13 +41,7 @@
           
 
     /**
-     * Specifies whether the exported data should be grouped as in the provided IgxGrid.
-     * ```typescript
-     * let ignoreGrouping = this.exportOptions.ignoreGrouping;
-     * this.exportOptions.ignoreGrouping = true;
-     * ```
-     *
-     * @memberof IgxExporterOptionsBase
+     * Specifies whether the exported data should be grouped as in the provided grid.
      */
     public set ignoreGrouping(value: boolean);
           public get ignoreGrouping(): boolean;
@@ -79,13 +49,7 @@
           
 
     /**
-     * Specifies whether the exported data should include multi column headers as in the provided IgxGrid.
-     * ```typescript
-     * let ignoreMultiColumnHeaders = this.exportOptions.ignoreMultiColumnHeaders;
-     * this.exportOptions.ignoreMultiColumnHeaders = true;
-     * ```
-     *
-     * @memberof IgxExporterOptionsBase
+     * Specifies whether the exported data should include multi column headers as in the provided grid.
      */
     public set ignoreMultiColumnHeaders(value: boolean);
           public get ignoreMultiColumnHeaders(): boolean;
@@ -94,12 +58,6 @@
 
     /**
      * Specifies whether the exported data should include column summaries.
-     * ```typescript
-     * let exportSummaries = this.exportOptions.exportSummaries;
-     * this.exportOptions.exportSummaries = true;
-     * ```
-     *
-     * @memberof IgxExporterOptionsBase
      */
     public set exportSummaries(value: boolean);
           public get exportSummaries(): boolean;
@@ -108,12 +66,6 @@
 
     /**
      * Specifies whether the exported data should have frozen headers.
-     * ```typescript
-     * let freezeHeaders = this.exportOptions.freezeHeaders;
-     * this.exportOptions.freezeHeaders = true;
-     * ```
-     *
-     * @memberof IgxExporterOptionsBase
      */
     public set freezeHeaders(value: boolean);
           public get freezeHeaders(): boolean;
@@ -122,12 +74,6 @@
 
     /**
      * Specifies whether the headers should be exported if there is no data.
-     * ```typescript
-     * let alwaysExportHeaders = this.exportOptions.alwaysExportHeaders;
-     * this.exportOptions.alwaysExportHeaders = false;
-     * ```
-     *
-     * @memberof IgxExporterOptionsBase
      */
      public set alwaysExportHeaders(value: boolean);
           public get alwaysExportHeaders(): boolean;
@@ -136,11 +82,6 @@
 
     /**
      * Gets the file name which will be used for the exporting operation.
-     * ```typescript
-     * let fileName = this.exportOptions.fileName;
-     * ```
-     *
-     * @memberof IgxExporterOptionsBase
      */
     public set fileName(value: string);
           public get fileName(): string;

package/grids/lib/igc-expression-tree.d.ts

@@ -16,6 +16,7 @@ import { IgcFilteringExpression } from './igc-filtering-expression';
           public get filteringOperands(): (IgcExpressionTree | IgcFilteringExpression)[];
   
           
+    /* mustCoerceToInt */
     public set operator(value: FilteringLogic);
           public get operator(): FilteringLogic;
   

package/grids/lib/igc-field-type.d.ts

@@ -84,10 +84,8 @@ import { IgcFieldPipeArgs } from './igc-field-pipe-args';
 
     /**
      * Optional formatter function to transform the value before display.
-     *
      * @param value - The value of the field.
      * @param rowData - Optional row data that contains this field.
-     * @returns The formatted value.
      */
     public formatter?(value: any, rowData?: any): any;
 

package/grids/lib/igc-filtering-expressions-tree.d.ts

@@ -20,6 +20,7 @@ import { FilteringLogic } from './filtering-logic';
   
           
     /* alternateName: treeType */
+    /* mustCoerceToInt */
     public type?: FilteringExpressionsTreeType;
   
           
@@ -29,6 +30,7 @@ import { FilteringLogic } from './filtering-logic';
     public owner?: any;
   
           
+    /* mustCoerceToInt */
     public set operator(value: FilteringLogic);
           public get operator(): FilteringLogic;
   

package/grids/lib/igc-filtering-operand.d.ts

@@ -5,8 +5,6 @@ import { IgcFilteringOperation } from './igc-filtering-operation';
 /**
  * Provides base filtering operations
  * Implementations should be Singleton
- *
- * @export
  */
 
     export declare class IgcFilteringOperand
@@ -31,7 +29,6 @@ import { IgcFilteringOperation } from './igc-filtering-operation';
 
     /**
      * Returns an instance of the condition with the specified name.
-     *
      * @param name The name of the condition.
      */
     public condition(name: string): IgcFilteringOperation;
@@ -40,7 +37,6 @@ import { IgcFilteringOperation } from './igc-filtering-operation';
 
     /**
      * Adds a new condition to the filtering operations.
-     *
      * @param operation The filtering operation.
      */
     public append(operation: IgcFilteringOperation): void;