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

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

@@ -0,0 +1,231 @@
+
+import { IgcPageCancellableEventArgs } from './igc-page-cancellable-event-args';
+import { IgcPageEventArgs } from './igc-page-event-args';
+import { IgcOverlaySettings } from './igc-overlay-settings';
+import { IgcPrefixedResourceStrings } from './igc-prefixed-resource-strings';
+import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from './common';
+
+
+
+
+/* blazorElement */
+/* mustUseNGParentAnchor */
+/* wcElementTag: igc-paginator */
+/* blazorIndirectRender */
+/* singleInstanceIdentifier */
+/* contentParent: GridBaseDirective */
+/* contentParent: RowIsland */
+/* contentParent: HierarchicalGrid */
+/* jsonAPIManageCollectionInMarkup */
+/**
+ * Paginator component description
+ * @igxParent IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent, *
+ */
+
+    export declare class IgcPaginatorComponent extends EventEmitterMixin<IgcPaginatorComponentEventMap, Constructor<LitElement>>(LitElement)
+
+    {
+
+    /* blazorSuppress */
+    static readonly tagName: string;
+    /* blazorSuppress */
+    static register(): void;
+
+          
+
+    /**
+     * Total pages calculated from totalRecords and perPage
+     */
+    public set totalPages(value: number);
+          public get totalPages(): number;
+  
+          
+
+    /**
+     * 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;
+  
+          
+
+    /**
+     * 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;
+  
+          
+
+    /**
+     * Sets the total records.
+     * ```typescript
+     * let totalRecords = this.paginator.totalRecords;
+     * ```
+     *
+     * @memberof IgxPaginatorComponent
+     */
+    public set totalRecords(value: number);
+          public get totalRecords(): number;
+  
+          
+
+    /**
+     * 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[];
+  
+          
+
+    /**
+     * Sets custom OverlaySettings.
+     * ```html
+     * <igx-paginator [overlaySettings] = "customOverlaySettings"></igx-paginator>
+     * ```
+     */
+    public set overlaySettings(value: IgcOverlaySettings);
+          public get overlaySettings(): IgcOverlaySettings;
+  
+          
+
+    /* mustSetInCodePlatforms: WebComponents;Blazor;React */
+    /**
+     * An accessor that sets the resource strings.
+     * By default it uses EN resources.
+     */
+    public set resourceStrings(value: IgcPrefixedResourceStrings);
+          public get resourceStrings(): IgcPrefixedResourceStrings;
+  
+                
+
+    /**
+     * Returns if the current page is the last page.
+     * ```typescript
+     * const lastPage = this.paginator.isLastPage;
+     * ```
+     */
+    public get isLastPage(): boolean;
+        
+                
+
+    /**
+     * 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
+     */
+    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
+     */
+    public previousPage(): void;
+
+            
+    /**
+     * Goes to the desired page index.
+     * ```typescript
+     * this.paginator.paginate(1);
+     * ```
+     *
+     * @param val
+     * @memberof IgxPaginatorComponent
+     */
+    public paginate(val: number): void;
+
+    }
+
+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-paginator-resource-strings.d.ts

@@ -0,0 +1,30 @@
+
+
+
+/* jsonAPIPlainObject */
+
+    export declare class IgcPaginatorResourceStrings
+    {
+
+          
+    public paginator_label?: string;
+  
+          
+    public paginator_pager_text?: string;
+  
+          
+    public paginator_first_page_button_text?: string;
+  
+          
+    public paginator_previous_page_button_text?: string;
+  
+          
+    public paginator_last_page_button_text?: string;
+  
+          
+    public paginator_next_page_button_text?: string;
+  
+    }
+
+
+        

package/grids/lib/igc-paging-state.d.ts

@@ -0,0 +1,24 @@
+
+
+
+/* jsonAPIPlainObject */
+
+
+/* marshalByValue */
+/* tsPlainInterface */
+
+    export declare class IgcPagingState
+    {
+
+          
+    public set index(value: number);
+          public get index(): number;
+  
+          
+    public set recordsPerPage(value: number);
+          public get recordsPerPage(): number;
+  
+    }
+
+
+        

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

@@ -0,0 +1,44 @@
+
+import { IgcColumnComponent } from './igc-column-component';
+
+
+
+
+/**
+ * The event arguments before a column's pin state is changed.
+ * `insertAtIndex`specifies at which index in the pinned/unpinned area the column is inserted.
+ * Can be changed in the `columnPin` event.
+ * `isPinned` returns the actual pin state of the column. When pinning/unpinning is successful,
+ * the value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
+ */
+
+    export declare class IgcPinColumnCancellableEventArgs
+    {
+
+        
+    public column: IgcColumnComponent;
+
+        
+    /**
+     * If pinned, specifies at which index in the pinned area the column is inserted.
+     * If unpinned, specifies at which index in the unpinned area the column is inserted.
+     */
+    public insertAtIndex: number;
+
+        
+    /**
+     * Returns the actual pin state of the column.
+     * If pinning/unpinning is successful, value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
+     */
+    public isPinned: boolean;
+
+        
+    /**
+     * Provides the ability to cancel the event.
+     */
+    public cancel: boolean;
+
+    }
+
+
+        

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

@@ -0,0 +1,37 @@
+
+import { IgcBaseEventArgs } from './igc-base-event-args';
+import { IgcColumnComponent } from './igc-column-component';
+
+
+
+
+/**
+ * The event arguments after a column's pin state is changed.
+ * `insertAtIndex`specifies at which index in the pinned/unpinned area the column was inserted.
+ * `isPinned` returns the actual pin state of the column after the operation completed.
+ */
+
+    export declare class IgcPinColumnEventArgs extends IgcBaseEventArgs
+    {
+
+        
+    public column: IgcColumnComponent;
+
+        
+    /**
+     * If pinned, specifies at which index in the pinned area the column is inserted.
+     * If unpinned, specifies at which index in the unpinned area the column is inserted.
+     */
+    public insertAtIndex: number;
+
+        
+    /**
+     * Returns the actual pin state of the column.
+     * If pinning/unpinning is successful, value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
+     */
+    public isPinned: boolean;
+
+    }
+
+
+        

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

@@ -0,0 +1,52 @@
+
+import { IgcRowType } from './igc-row-type';
+
+
+
+
+/**
+ * Event emitted when a row's pin state changes.
+ * The event is cancelable
+ */
+
+    export declare class IgcPinRowEventArgs
+    {
+
+        
+    /**
+     * The ID of the row, that was pinned/unpinned.
+     * ID is either the primaryKey value or the data record instance.
+     * @deprecated Use the `rowKey` property instead.
+     */
+    public rowID: any;
+
+        
+    public rowKey: any;
+
+        
+    public row?: IgcRowType;
+
+        
+    /** The index at which to pin the row in the pinned rows collection. */
+    public insertAtIndex?: number;
+
+        
+    /** Whether or not the row is pinned or unpinned. */
+    public isPinned: boolean;
+
+        
+    /**
+     * Provides reference to the owner component.
+     */
+    public owner?: any;
+
+        
+    /**
+     * Provides the ability to cancel the event.
+     */
+    public cancel: boolean;
+
+    }
+
+
+        

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

@@ -0,0 +1,27 @@
+
+import { ColumnPinningPosition } from './column-pinning-position';
+import { RowPinningPosition } from './row-pinning-position';
+
+
+/* jsonAPIPlainObject */
+
+
+/* marshalByValue */
+/* tsPlainInterface */
+/**
+ * An interface describing settings for row/column pinning position.
+ */
+
+    export declare class IgcPinningConfig
+    {
+
+          
+    public columns?: ColumnPinningPosition;
+  
+          
+    public rows?: RowPinningPosition;
+  
+    }
+
+
+        

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

@@ -0,0 +1,47 @@
+
+import { PivotAggregationType } from './pivot-aggregation-type';
+
+
+/* jsonAPIPlainObject */
+
+
+/* marshalByValue */
+/**
+* Interface describing a IPivotAggregator class.
+* Used for specifying custom aggregator lists.
+*/
+
+    export declare class IgcPivotAggregator
+    {
+
+          
+    /** Aggregation unique key. */
+    public set key(value: string);
+          public get key(): string;
+  
+          
+    /** Aggregation label to show in the UI. */
+    public set label(value: string);
+          public get label(): string;
+  
+          
+    /**
+     * Aggregation name that will be used from a list of predefined aggregations.
+     * If not set will use the specified aggregator function.
+     */
+    public aggregatorName?: PivotAggregationType;
+  
+          
+
+    /* blazorAlternateType: AggregatorEventHandler */
+    /* blazorOnlyScript */
+    /**
+     * Aggregator function can be a custom implementation of `PivotAggregation`, or
+     * use predefined ones from `IgxPivotAggregate` and its variants.
+     */
+    public aggregator?: any;
+  
+    }
+
+
+        

package/grids/lib/igc-pivot-configuration-changed-event-args.d.ts

@@ -0,0 +1,21 @@
+
+import { IgcPivotConfiguration } from './igc-pivot-configuration';
+
+
+
+
+/**
+ * Event emitted when pivot configuration is changed.
+ */
+
+    export declare class IgcPivotConfigurationChangedEventArgs
+    {
+
+        
+    /** The new configuration. */
+    public pivotConfiguration: IgcPivotConfiguration;
+
+    }
+
+
+        

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

@@ -0,0 +1,53 @@
+
+import { IgcPivotDimensionStrategy } from './igc-pivot-dimension-strategy';
+import { IgcPivotDimension } from './igc-pivot-dimension';
+import { IgcPivotValue } from './igc-pivot-value';
+import { IgcPivotKeys } from './igc-pivot-keys';
+
+
+/* jsonAPIPlainObject */
+
+
+/* marshalByValue */
+/**
+* Configuration of the pivot grid.
+*/
+
+    export declare class IgcPivotConfiguration
+    {
+
+          
+    /** A strategy to transform the rows. */
+    public rowStrategy?: IgcPivotDimensionStrategy;
+  
+          
+    /** A strategy to transform the columns. */
+    public columnStrategy?: IgcPivotDimensionStrategy;
+  
+          
+    /** A list of the rows. */
+    public set rows(value: IgcPivotDimension[]);
+          public get rows(): IgcPivotDimension[];
+  
+          
+    /** A list of the columns. */
+    public set columns(value: IgcPivotDimension[]);
+          public get columns(): IgcPivotDimension[];
+  
+          
+    /** A list of the values. */
+    public set values(value: IgcPivotValue[]);
+          public get values(): IgcPivotValue[];
+  
+          
+    /** Dimensions to be displayed in the filter area. */
+    public filters?: IgcPivotDimension[];
+  
+          
+    /** Pivot data keys used for data generation. Can be used for custom remote scenarios where the data is pre-populated. */
+    public pivotKeys?: IgcPivotKeys;
+  
+    }
+
+
+