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

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

@@ -0,0 +1,183 @@
+
+import { IgcPivotGridComponent } from './igc-pivot-grid-component';
+                import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from './common';
+
+
+
+
+/* blazorIndirectRender
+   blazorComponent */
+/* 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)
+
+    {
+
+    /* blazorSuppress */
+    static readonly tagName: string;
+    /* blazorSuppress */
+    static register(): void;
+
+          
+
+
+    /**
+     * 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;
+  
+          
+
+    /**
+     * 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;
+  
+          
+
+    /**
+     * 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;
+  
+          
+
+    /**
+     * 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;
+  
+          
+
+
+    /* treatAsRef */
+    /**
+     * Sets the grid.
+     */
+    public set grid(value: IgcPivotGridComponent);
+          public get grid(): IgcPivotGridComponent;
+  
+    }
+
+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-options.d.ts

@@ -0,0 +1,34 @@
+
+
+
+/* jsonAPIPlainObject */
+
+
+
+    export declare class IgcPivotDateDimensionOptions
+    {
+
+          
+    /** Enables/Disables total value of all periods. */
+    public total?: boolean;
+  
+          
+    /** Enables/Disables dimensions per year from provided periods. */
+    public years?: boolean;
+  
+          
+    /*/** Enables/Disables dimensions per quarter from provided periods. */
+    public quarters?: boolean;
+  
+          
+    /** Enables/Disables dimensions per month from provided periods. */
+    public months?: boolean;
+  
+          
+    /** Enabled/Disables dimensions for the full date provided */
+    public fullDate?: boolean;
+  
+    }
+
+
+        

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

@@ -0,0 +1,91 @@
+
+import { IgcPivotDimension } from './igc-pivot-dimension';
+import { GridColumnDataType } from './grid-column-data-type';
+import { IgcPrefixedResourceStrings } from './igc-prefixed-resource-strings';
+import { IgcPivotDateDimensionOptions } from './igc-pivot-date-dimension-options';
+
+
+
+
+/* blazorAlternateBaseType: PivotDimension */
+/* alternateBaseType: PivotDimension */
+// Equals to pretty much this configuration:
+// {
+//     member: () => 'All Periods',
+//     enabled: true,
+//     fieldName: 'AllPeriods',
+//     childLevel: {
+//         fieldName: 'Years',
+//         member: (rec) => {
+//             const recordValue = rec['Date'];
+//             return recordValue ? (new Date(recordValue)).getFullYear().toString() : rec['Years'];
+//         },
+//         enabled: true,
+//         childLevel: {
+//                 member: (rec) => {
+//                     const recordValue = rec['Date'];
+//                     return recordValue ? new Date(recordValue).toLocaleString('default', { month: 'long' }) : rec['Months'];
+//                 },
+//                 enabled: true,
+//                 fieldName: 'Months',
+//                 childLevel: {
+//                         member: 'Date',
+//                         fieldName:'Date',
+//                         enabled: true
+//                     }
+//             }
+//     }
+// },
+
+    export declare class IgcPivotDateDimension extends IgcPivotDimension
+    {
+
+          
+    /** Enables/Disables a particular dimension from pivot structure. */
+    public set enabled(value: boolean);
+          public get enabled(): boolean;
+  
+          
+
+    /**
+     * Gets/Sets data type
+     */
+    public dataType?: GridColumnDataType;
+  
+          
+
+    /**
+     * Gets/Sets the resource strings.
+     *
+     * @remarks
+     * By default it uses EN resources.
+     */
+    public set resourceStrings(value: IgcPrefixedResourceStrings);
+          public get resourceStrings(): IgcPrefixedResourceStrings;
+  
+          
+
+    /**
+     * Gets/Sets the base dimension that is used by this class to determine the other dimensions and their values.
+     * Having base dimension set is required in order for the Date Dimensions to show.
+     */
+    public set baseDimension(value: IgcPivotDimension);
+          public get baseDimension(): IgcPivotDimension;
+  
+          
+
+    /**
+     * Gets/Sets the options for the predefined date dimensions whether to show quarter, years and etc.
+     */
+    public set options(value: IgcPivotDateDimensionOptions);
+          public get options(): IgcPivotDateDimensionOptions;
+  
+          
+    public displayName: string;
+  
+    constructor(inBaseDimension?: IgcPivotDimension, inOptions?: IgcPivotDateDimensionOptions);
+
+    }
+
+
+        

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

@@ -0,0 +1,26 @@
+
+import { IgcPivotDimension } from './igc-pivot-dimension';
+import { IgcPivotValue } from './igc-pivot-value';
+import { IgcDataCloneStrategy } from './igc-data-clone-strategy';
+import { IgcPivotKeys } from './igc-pivot-keys';
+
+
+/* jsonAPIPlainObject */
+
+
+/**
+* Interface describing Pivot data processing for dimensions.
+* Should contain a process method and return records hierarchy based on the provided dimensions.
+*/
+
+    export declare class IgcPivotDimensionStrategy
+    {
+
+            
+    /* blazorCSSuppress */
+    public process(collection: any, dimensions: IgcPivotDimension[], values: IgcPivotValue[], cloneStrategy: IgcDataCloneStrategy, pivotKeys?: IgcPivotKeys): any[];
+
+    }
+
+
+        

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

@@ -0,0 +1,80 @@
+
+import { IgcFilteringExpressionsTree } from './igc-filtering-expressions-tree';
+import { SortingDirection } from './sorting-direction';
+import { GridColumnDataType } from './grid-column-data-type';
+
+
+/* jsonAPIPlainObject */
+
+
+/* blazorElement */
+/* marshalByValue */
+/**
+* Configuration of a pivot dimension.
+*/
+
+    export declare class IgcPivotDimension
+    {
+
+          
+    /** Allows defining a hierarchy when multiple sub groups need to be extracted from single member. */
+    public childLevel?: IgcPivotDimension;
+  
+          
+    /** Unique member to extract related data field value or the result of the memberFunction. */
+    public set memberName(value: string);
+          public get memberName(): string;
+  
+          
+
+    /* csTreatAsEvent: MemberFunctionHandler */
+    /* blazorOnlyScript */
+    /** Function that extracts the value */
+    public memberFunction?: any;
+  
+          
+    /** Display name to show instead of the field name of this value. **/
+    public displayName?: string;
+  
+          
+    /** Enables/Disables a particular dimension from pivot structure. */
+    public set enabled(value: boolean);
+          public get enabled(): boolean;
+  
+          
+    /**
+     * A predefined or defined via the `igxPivotSelector` filter expression tree for the current dimension to be applied in the filter pipe.
+     * */
+    public filter?: IgcFilteringExpressionsTree;
+  
+          
+    /** Enable/disable sorting for a particular dimension. True by default. */
+    public sortable?: boolean;
+  
+          
+    /**
+     * The sorting direction of the current dimension. Determines the order in which the values will appear in the related dimension.
+     */
+    public sortDirection?: SortingDirection;
+  
+          
+    /**
+     * The dataType of the related data field.
+     */
+    public dataType?: GridColumnDataType;
+  
+          
+    /** The width of the dimension cells to be rendered.Can be pixel, % or "auto". */
+    public width?: string;
+  
+          
+    /** Level of the dimension. */
+    public level?: number;
+  
+          
+    public horizontalSummary?: boolean;
+  
+    }
+
+
+        

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

@@ -0,0 +1,32 @@
+
+import { IgcPivotDimension } from './igc-pivot-dimension';
+import { IgcPivotValue } from './igc-pivot-value';
+
+
+/* jsonAPIPlainObject */
+
+
+/** Interface describing the Pivot column data.
+*  Contains information on the related column dimensions and their values.
+*/
+
+    export declare class IgcPivotGridColumn
+    {
+
+          
+        public set field(value: string);
+          public get field(): string;
+  
+          
+        /** List of dimensions associated with the column.**/
+        public set dimensions(value: IgcPivotDimension[]);
+          public get dimensions(): IgcPivotDimension[];
+  
+          
+        public set value(value: IgcPivotValue);
+          public get value(): IgcPivotValue;
+  
+    }
+
+
+