igniteui-webcomponents-grids 6.3.0-alpha.0 → 6.3.0-alpha.2

package/grids/lib/igc-grid-selection-range.d.ts

@@ -0,0 +1,48 @@
+
+
+
+/* jsonAPIPlainObject */
+
+
+/* tsPlainInterface */
+/* marshalByValue */
+/**
+ * Represents a range selection between certain rows and columns of the grid.
+ * Range selection can be made either through drag selection or through keyboard selection.
+ */
+
+    export declare class IgcGridSelectionRange
+    {
+
+          
+    /** The index of the starting row of the selection range. */
+    public set rowStart(value: number);
+          public get rowStart(): number;
+  
+          
+     /** The index of the ending row of the selection range. */
+    public set rowEnd(value: number);
+          public get rowEnd(): number;
+  
+          
+    /* blazorAlternateType: double */
+    /**
+     * The identifier or index of the starting column of the selection range.
+     * It can be either a string representing the column's field name or a numeric index.
+     */
+    public set columnStart(value: string);
+          public get columnStart(): string;
+  
+          
+    /* blazorAlternateType: double */
+    /**
+     * The identifier or index of the ending column of the selection range.
+     * It can be either a string representing the column's field name or a numeric index.
+     */
+    public set columnEnd(value: string);
+          public get columnEnd(): string;
+  
+    }
+
+
+        

package/grids/lib/igc-grid-sorting-strategy.d.ts

@@ -0,0 +1,30 @@
+
+import { IgcSortingExpression } from './igc-sorting-expression';
+import { IgcGridBaseDirective } from './igc-grid-base-directive';
+
+
+/* jsonAPIPlainObject */
+
+
+/**
+ * Represents a sorting strategy for the grid data
+ * Contains a single method sort that sorts the provided data based on the given sorting expressions
+ */
+
+    export declare class IgcGridSortingStrategy
+    {
+
+            
+    /* blazorCSSuppress */
+    /**
+    * `data`: The array of data to be sorted. Could be of any type.
+    * `expressions`: An array of sorting expressions that define the sorting rules. The expression contains information like file name, whether the letter case should be taken into account, etc.
+    * `grid`: (Optional) The instance of the grid where the sorting is applied.
+    * Returns a new array with the data sorted according to the sorting expressions.
+    */
+    public sort(data: any[], expressions: IgcSortingExpression[], grid?: IgcGridBaseDirective): any[];
+
+    }
+
+
+        

package/grids/lib/igc-grid-state-base-directive.d.ts

@@ -0,0 +1,31 @@
+
+import { IgcGridStateOptions } from './igc-grid-state-options';
+
+
+
+
+/* blazorElement */
+/* wcElementTag: igc-grid-state-base-directive */
+/* blazorIndirectRender */
+
+    export declare class IgcGridStateBaseDirective extends HTMLElement
+    {
+
+          
+
+    /**
+     *  An object with options determining if a certain feature state should be saved.
+     * ```html
+     * <igx-grid [igxGridState]="options"></igx-grid>
+     * ```
+     * ```typescript
+     * public options = {selection: false, advancedFiltering: false};
+     * ```
+     */
+    public set options(value: IgcGridStateOptions);
+          public get options(): IgcGridStateOptions;
+  
+    }
+
+
+        

package/grids/lib/igc-grid-state-collection.d.ts

@@ -0,0 +1,28 @@
+
+import { IgcGridStateComponent } from './igc-grid-state-component';
+
+
+/* jsonAPIPlainObject */
+
+
+/* marshalByValue */
+
+    export declare class IgcGridStateCollection
+    {
+
+          
+    public set id(value: string);
+          public get id(): string;
+  
+          
+    public set parentRowID(value: any);
+          public get parentRowID(): any;
+  
+          
+    public set state(value: IgcGridStateComponent);
+          public get state(): IgcGridStateComponent;
+  
+    }
+
+
+        

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

@@ -1,6 +1,6 @@
 
+import { IgcGridStateBaseDirective } from './igc-grid-state-base-directive';
 import { IgcGridStateInfo } from './igc-grid-state-info';
-import { IgcGridBaseDirective } from './igc-grid-base-directive';
 import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from './common';
 
 
@@ -18,7 +18,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
  * @igxParent IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent, *
  */
 
-    export declare class IgcGridStateComponent extends EventEmitterMixin<IgcGridStateComponentEventMap, Constructor<LitElement>>(LitElement)
+    export declare class IgcGridStateComponent extends EventEmitterMixin<IgcGridStateComponentEventMap, Constructor<IgcGridStateBaseDirective>>(IgcGridStateBaseDirective)
 
     {
 
@@ -27,17 +27,13 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
     /* blazorSuppress */
     static register(): void;
 
-          
-    public set grid(value: IgcGridBaseDirective);
-          public get grid(): IgcGridBaseDirective;
-  
             
     /**
      * Restores grid features' state based on the IGridStateInfo object passed as an argument.
      * @param state object to restore state from.
      * @param feature string or array of strings determining the features to be added in the state. If skipped, all features are added.
      */
-    public applyState(state: IgcGridStateInfo, features?: any): void;
+    public applyState(state: IgcGridStateInfo, features?: string[]): void;
 
             
 
@@ -46,7 +42,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
      * @param state string to restore state from.
      * @param feature string or array of strings determining the features to be added in the state. If skipped, all features are added.
      */
-    public applyStateFromString(state: string, features?: any): void;
+    public applyStateFromString(state: string, features?: string[]): void;
 
             
 
@@ -56,7 +52,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
      * @param feature string or array of strings determining the features to be added in the state. If skipped, all features are added.
      * @returns The state object.
      */
-    public getState(features?: any): IgcGridStateInfo;
+    public getState(features?: string[]): IgcGridStateInfo;
 
             
 
@@ -66,7 +62,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
      * @param feature array of strings determining the features to be added in the state. If skipped, all features are added.
      * @returns Returns the serialized to JSON string IGridStateInfo object.
      */
-    public getStateAsString(features?: any): string;
+    public getStateAsString(features?: string[]): string;
 
     }
 

package/grids/lib/igc-grid-state-info.d.ts

@@ -1,4 +1,13 @@
 
+import { IgcColumnState } from './igc-column-state';
+import { IgcFilteringExpressionsTree } from './igc-filtering-expressions-tree';
+import { IgcPagingState } from './igc-paging-state';
+import { IgcSortingExpression } from './igc-sorting-expression';
+import { IgcGroupingState } from './igc-grouping-state';
+import { IgcGridSelectionRange } from './igc-grid-selection-range';
+import { IgcPinningConfig } from './igc-pinning-config';
+import { IgcGridStateCollection } from './igc-grid-state-collection';
+import { IgcPivotConfiguration } from './igc-pivot-configuration';
 
 
 /* jsonAPIPlainObject */
@@ -14,13 +23,13 @@
     public columns?: IgcColumnState[];
   
           
-    public filtering?: any;
+    public filtering?: IgcFilteringExpressionsTree;
   
           
-    public advancedFiltering?: any;
+    public advancedFiltering?: IgcFilteringExpressionsTree;
   
           
-    public paging?: any;
+    public paging?: IgcPagingState;
   
           
     public moving?: boolean;
@@ -29,7 +38,7 @@
     public sorting?: IgcSortingExpression[];
   
           
-    public groupBy?: any;
+    public groupBy?: IgcGroupingState;
   
           
     public cellSelection?: IgcGridSelectionRange[];
@@ -46,7 +55,7 @@
     public rowPinning?: any[];
   
           
-    public pinningConfig?: any;
+    public pinningConfig?: IgcPinningConfig;
   
           
     /* blazorPrimitiveValue */
@@ -59,7 +68,7 @@
     public id?: string;
   
           
-    public pivotConfiguration?: any;
+    public pivotConfiguration?: IgcPivotConfiguration;
   
     }
 

package/grids/lib/igc-grid-state-options.d.ts

@@ -0,0 +1,59 @@
+
+
+
+/* jsonAPIPlainObject */
+
+
+
+    export declare class IgcGridStateOptions
+    {
+
+          
+    public columns?: boolean;
+  
+          
+    public filtering?: boolean;
+  
+          
+    public advancedFiltering?: boolean;
+  
+          
+    public sorting?: boolean;
+  
+          
+    public groupBy?: boolean;
+  
+          
+    public paging?: boolean;
+  
+          
+    public cellSelection?: boolean;
+  
+          
+    public rowSelection?: boolean;
+  
+          
+    public columnSelection?: boolean;
+  
+          
+    public rowPinning?: boolean;
+  
+          
+    public pinningConfig?: boolean;
+  
+          
+    public expansion?: boolean;
+  
+          
+    public rowIslands?: boolean;
+  
+          
+    public moving?: boolean;
+  
+          
+    public pivotConfiguration?: boolean;
+  
+    }
+
+
+        

package/grids/lib/igc-grid-template-context.d.ts

@@ -0,0 +1,19 @@
+
+import { IgcGridBaseDirective } from './igc-grid-base-directive';
+
+
+
+
+
+    export declare class IgcGridTemplateContext
+    {
+
+          
+    /* @wcWidgetMemberName: $implicit */
+public set implicit(value: IgcGridBaseDirective);
+          public get implicit(): IgcGridBaseDirective;
+  
+    }
+
+
+        

package/grids/lib/igc-grid-toolbar-actions-component.d.ts

@@ -0,0 +1,36 @@
+
+
+
+
+
+/* blazorElement */
+/* blazorIndirectRender */
+/* blazorAlternateBaseType: GridToolbarContent */
+/* wcElementTag: igc-grid-toolbar-actions */
+/* singleInstanceIdentifier */
+/**
+ * Provides a way to template the action portion of the toolbar in the grid.
+ *
+ * @igxModule IgxGridToolbarModule
+ * @igxParent IgxGridToolbarComponent
+ *
+ * @example
+ * ```html
+ * <igx-grid-toolbar-actions>
+ *  <some-toolbar-action-here />
+ * </igx-grid-toolbar-actions>
+ * ```
+ */
+
+    export declare class IgcGridToolbarActionsComponent extends HTMLElement
+    {
+
+    /* blazorSuppress */
+    static readonly tagName: string;
+    /* blazorSuppress */
+    static register(): void;
+
+    }
+
+
+        

package/grids/lib/igc-grid-toolbar-advanced-filtering-component.d.ts

@@ -0,0 +1,43 @@
+
+import { IgcOverlaySettings } from './igc-overlay-settings';
+
+
+
+
+/* blazorElement */
+/* wcElementTag: igc-grid-toolbar-advanced-filtering */
+/* blazorIndirectRender */
+/* blazorAlternateBaseType: GridToolbarBaseAction */
+/* jsonAPIManageItemInMarkup */
+/* singleInstanceIdentifier */
+/**
+ * Provides a pre-configured button to open the advanced filtering dialog of the grid.
+ *
+ *
+ * @igxModule IgxGridToolbarModule
+ * @igxParent IgxGridToolbarComponent, IgxGridToolbarActionsComponent
+ *
+ * @example
+ * ```html
+ * <igx-grid-toolbar-advanced-filtering></igx-grid-toolbar-advanced-filtering>
+ * <igx-grid-toolbar-advanced-filtering>Custom text</igx-grid-toolbar-advanced-filtering>
+ * ```
+ */
+
+    export declare class IgcGridToolbarAdvancedFilteringComponent extends HTMLElement
+    {
+
+    /* blazorSuppress */
+    static readonly tagName: string;
+    /* blazorSuppress */
+    static register(): void;
+
+          
+
+    public set overlaySettings(value: IgcOverlaySettings);
+          public get overlaySettings(): IgcOverlaySettings;
+  
+    }
+
+
+        

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

@@ -0,0 +1,64 @@
+
+import { IgcGridBaseDirective } from './igc-grid-base-directive';
+
+
+/* jsonAPIManageCollectionInMarkup */
+
+
+/* blazorElement */
+/* mustUseNGParentAnchor */
+/* wcElementTag: igc-grid-toolbar */
+/* blazorIndirectRender */
+/* singleInstanceIdentifier */
+/* contentParent: GridBaseDirective */
+/* contentParent: RowIsland */
+/* contentParent: HierarchicalGrid */
+/* jsonAPIManageItemInMarkup */
+/**
+ * Provides a context-aware container component for UI operations for the grid components.
+ *
+ * @igxModule IgxGridToolbarModule
+ * @igxParent IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent
+ *
+ */
+
+    export declare class IgcGridToolbarComponent extends HTMLElement
+    {
+
+    /* blazorSuppress */
+    static readonly tagName: string;
+    /* blazorSuppress */
+    static register(): void;
+
+          
+
+
+    /**
+     * When enabled, shows the indeterminate progress bar.
+     *
+     * @remarks
+     * By default this will be toggled, when the default exporter component is present
+     * and an exporting is in progress.
+     */
+    public set showProgress(value: boolean);
+          public get showProgress(): boolean;
+  
+          
+
+    /**
+     * Gets/sets the grid component for the toolbar component.
+     *
+     * @deprecated No longer required to be set for the Hierarchical Grid child grid template
+     *
+     * @remarks
+     * Usually you should not set this property in the context of the default grid/tree grid.
+     * The only grids that demands this to be set are the hierarchical child grids. For additional
+     * information check the toolbar topic.
+     */
+    public set grid(value: IgcGridBaseDirective);
+          public get grid(): IgcGridBaseDirective;
+  
+    }
+
+
+        

package/grids/lib/igc-grid-toolbar-export-event-args.d.ts

@@ -0,0 +1,52 @@
+
+import { IgcBaseEventArgs } from './igc-base-event-args';
+import { IgcGridBaseDirective } from './igc-grid-base-directive';
+import { IgcBaseExporter } from './igc-base-exporter';
+import { IgcExporterOptionsBase } from './igc-exporter-options-base';
+
+
+
+
+/* jsonAPIPlainObject */
+/*  tsPlainInterface */
+/**
+ * Represents the arguments for the grid toolbar export event.
+ * It provides information about the grid instance, exporter service, export options,
+ * and allows the event to be canceled.
+ */
+
+    export declare class IgcGridToolbarExportEventArgs extends IgcBaseEventArgs
+    {
+
+        
+    /** `grid` represents a reference to the instance of the grid te event originated from */
+    public grid: IgcGridBaseDirective;
+
+        
+    /**
+     * The `exporter` is a base service.
+     * The type (an abstract class `IgxBaseExporter`) has it's own properties and methods
+     * It is used to define the format and options of the export, the exported element
+     * and methods for preparing the data from the elements for exporting
+     */
+    public exporter: IgcBaseExporter;
+
+        
+    /**
+     * Represents the different settings, that can be given to an export
+     * The type (an abstract class `IgxExporterOptionsBase`) has properties for column settings
+     * (whether they should be ignored) as well as method for generating a file name
+     */
+    public options: IgcExporterOptionsBase;
+
+        
+    /**
+     * `cancel` returns whether the event has been intercepted and stopped
+     * If the value becomes "true", it returns/exits from the method, instantiating the interface
+     */
+    public cancel: boolean;
+
+    }
+
+
+        

package/grids/lib/igc-grid-toolbar-exporter-component.d.ts

@@ -0,0 +1,95 @@
+
+import { IgcBaseToolbarDirective } from './igc-base-toolbar-directive';
+import { IgcExporterEventArgs } from './igc-exporter-event-args';
+import { GridToolbarExporterType } from './grid-toolbar-exporter-type';
+import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from './common';
+import { IgcBaseToolbarDirectiveEventMap } from './igc-base-toolbar-directive';
+
+
+
+
+
+/* blazorElement */
+/* wcElementTag: igc-grid-toolbar-exporter */
+/* blazorIndirectRender */
+/* jsonAPIManageItemInMarkup */
+/* singleInstanceIdentifier */
+/**
+ * Provides a pre-configured exporter component for the grid.
+ *
+ * @remarks
+ * This component still needs the actual exporter service(s) provided in the DI chain
+ * in order to export something.
+ *
+ * @igxModule IgxGridToolbarModule
+ * @igxParent IgxGridToolbarComponent, IgxGridToolbarActionsComponent
+ *
+ */
+
+    export declare class IgcGridToolbarExporterComponent extends EventEmitterMixin<IgcGridToolbarExporterComponentEventMap, AbstractConstructor<IgcBaseToolbarDirective>>(IgcBaseToolbarDirective)
+
+    {
+
+    /* blazorSuppress */
+    static readonly tagName: string;
+    /* blazorSuppress */
+    static register(): void;
+
+          
+
+    /**
+     * Show entry for CSV export.
+     */
+    public set exportCSV(value: boolean);
+          public get exportCSV(): boolean;
+  
+          
+
+    /**
+     * Show entry for Excel export.
+     */
+    public set exportExcel(value: boolean);
+          public get exportExcel(): boolean;
+  
+          
+
+    /**
+     * Show entry for PDF export.
+     */
+    public set exportPDF(value: boolean);
+          public get exportPDF(): boolean;
+  
+          
+
+    /**
+     * The name for the exported file.
+     */
+    public set filename(value: string);
+          public get filename(): string;
+  
+            
+
+    /* alternateName: exportGrid */
+    /**
+     * Export the grid's data
+     * @param type File type to export
+     */
+    public export(type: GridToolbarExporterType): void;
+
+    }
+
+export declare interface IgcGridToolbarExporterComponentEventMap extends IgcBaseToolbarDirectiveEventMap {
+            
+        		    /**
+		     * Emitted when starting an export operation. Re-emitted additionally
+		     * by the grid itself.
+		     */
+exportStarted: CustomEvent<IgcExporterEventArgs>;
+
+        		    /**
+		     * Emitted on successful ending of an export operation.
+		     */
+exportEnded: CustomEvent<void>;
+
+}
+        

package/grids/lib/igc-grid-toolbar-hiding-component.d.ts

@@ -0,0 +1,38 @@
+
+import { IgcBaseToolbarColumnActionsDirective } from './igc-base-toolbar-column-actions-directive';
+import { IgcBaseToolbarDirectiveEventMap } from './igc-base-toolbar-directive';
+
+
+
+
+
+/* blazorElement */
+/* wcElementTag: igc-grid-toolbar-hiding */
+/* blazorIndirectRender */
+/* jsonAPIManageItemInMarkup */
+/* singleInstanceIdentifier */
+/**
+ * Provides a pre-configured column hiding component for the grid.
+ *
+ *
+ * @igxModule IgxGridToolbarModule
+ * @igxParent IgxGridToolbarComponent, IgxGridToolbarActionsComponent
+ *
+ * @example
+ * ```html
+ *  <igx-grid-toolbar-hiding></igx-grid-toolbar-hiding>
+ * ```
+ */
+
+    export declare class IgcGridToolbarHidingComponent extends IgcBaseToolbarColumnActionsDirective
+    {
+
+    /* blazorSuppress */
+    static readonly tagName: string;
+    /* blazorSuppress */
+    static register(): void;
+
+    }
+
+export type IgcGridToolbarHidingComponentEventMap = IgcBaseToolbarDirectiveEventMap
+