Merge pull request #12430 from IgniteUI/skrastev/task-12417-master

refactor(pivotDate): Add getter/setters for pivot date dimension and make constructor props private.

Author: dkamburov

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes for each version of this project will be documented in this file.
 
+## 15.1.0
+
+ - `IgxPivotGrid`
+    - The `IgxPivotDateDimension` properties `inBaseDimension` and `inOption` have been deprecated and renamed to `baseDimension` and `options` respectively.
+
 ## 15.0.1
 
 - `IgxGrid`

projects/igniteui-angular/src/lib/grids/pivot-grid/pivot-grid-dimensions.ts

@@ -53,7 +53,7 @@ export class IgxPivotDateDimension implements IPivotDimension {
      */
     public dataType?: GridColumnDataType;
 
-    /** Default options used for initialization. */
+    /** Default options. */
     public defaultOptions = {
         total: true,
         years: true,
@@ -75,11 +75,57 @@ export class IgxPivotDateDimension implements IPivotDimension {
         return this._resourceStrings;
     }
 
+    /**
+     * 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 get baseDimension(): IPivotDimension {
+        return this._baseDimension;
+    }
+    public set baseDimension(value: IPivotDimension) {
+        this._baseDimension = value;
+        this.initialize(this.baseDimension, this.options);
+    }
+
+    /**
+     * Gets/Sets the options for the predefined date dimensions whether to show quarter, years and etc.
+     */
+    public get options(): IPivotDateDimensionOptions {
+        return this._options;
+    }
+    public set options(value: IPivotDateDimensionOptions) {
+        this._options = value;
+        if (this.baseDimension) {
+            this.initialize(this.baseDimension, this.options);
+        }
+    }
+
+    /**
+     * @deprecated since version 15.1.x. Please use the new name `baseDimension` for future versions.
+     *
+     * Gets 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 get inBaseDimension(): IPivotDimension {
+        return this._baseDimension;
+    }
+
+    /**
+     * @deprecated since version 15.1.x. Please use the new name `options` for future versions.
+     *
+     * Gets the options for the predefined date dimensions whether to show quarter, years and etc.
+     */
+    public get inOptions(): IPivotDateDimensionOptions {
+        return this._options;
+    }
+
     /** @hidden @internal */
     public childLevel?: IPivotDimension;
     /** @hidden @internal */
     public memberName = 'AllPeriods';
     private _resourceStrings = CurrentResourceStrings.GridResStrings;
+    private _baseDimension: IPivotDimension;
+    private _options: IPivotDateDimensionOptions = {};
     private _monthIntl = new Intl.DateTimeFormat('default', { month: 'long' });
 
     /**
@@ -93,13 +139,16 @@ export class IgxPivotDateDimension implements IPivotDimension {
      * new IgxPivotDateDimension({ memberName: 'Date', enabled: true }, { total: false, months: false });
      * ```
      */
-    constructor(public inBaseDimension: IPivotDimension, public inOptions: IPivotDateDimensionOptions = {}) {
-        const options = { ...this.defaultOptions, ...inOptions };
-
-        if (!inBaseDimension) {
-            console.warn(`Please provide data child level to the pivot dimension.`);
-            return;
+    constructor(inBaseDimension: IPivotDimension, inOptions: IPivotDateDimensionOptions = {}) {
+        this._baseDimension = inBaseDimension;
+        this._options = inOptions;
+        if (this.baseDimension && this.options) {
+            this.initialize(this.baseDimension, this.options);
         }
+    }
+
+    protected initialize(inBaseDimension, inOptions) {
+        const options = { ...this.defaultOptions, ...inOptions };
 
         this.dataType = GridColumnDataType.Date;
         inBaseDimension.dataType = GridColumnDataType.Date;

projects/igniteui-angular/src/lib/grids/state.directive.ts

@@ -599,7 +599,7 @@ export class IgxGridStateDirective {
      * This method restores the IgxPivotDateDimension with its default functions and resource strings.
      */
     private restoreDateDimension(dim: IgxPivotDateDimension) {
-        const dateDim = new IgxPivotDateDimension((dim as any).inBaseDimension, (dim as any).inOptions);
+        const dateDim = new IgxPivotDateDimension((dim as any)._baseDimension, (dim as any)._options);
         // restore functions and resource strings
         dim.resourceStrings = dateDim.resourceStrings;
         dim.memberFunction = dateDim.memberFunction;
@@ -616,7 +616,7 @@ export class IgxGridStateDirective {
      * Returns if this is a IgxPivotDateDimension.
      */
     private isDateDimension(dim: IPivotDimension) {
-        return (dim as any).inBaseDimension;
+        return (dim as any)._baseDimension;
     }
 
     /**