Added options property disableNiceOnlyForScale for createScale (#18)

microsoft · Jun 23, 2017 · 5342bb2 · 5342bb2
1 parent 918b701
commit 5342bb2
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,11 @@
+## 1.2.0
+* Added 'disableNiceOnlyForScale' to 'CreateAxisOptions' interface
+and added verification with this property to createAxis func
+
 ## 1.1.0
 * Removed `lodash`
 * Updated dependencies
 
 ## 1.0.1
 * Update ChartUtils to use SVG utils version 1.0.0
-* Add CHANGELOG
+* Add CHANGELOG
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -224,6 +224,8 @@ declare module powerbi.extensibility.utils.chart.axis {
         shouldClamp?: boolean;
         /** (optional) Disable "niceing" for numeric axis. It means that if max value is 172 the axis will show 172 but not rounded to upper value 180 */
         disableNice?: boolean;
+        /** (optional) Disable "niceing" for numeric axis. Disabling nice will be applid only when creating scale obj (bestTickCount will be applied to 'ticks' method) */
+        disableNiceOnlyForScale?: boolean;
     }
     enum AxisOrientation {
         top = 0,

diff --git a/lib/index.js b/lib/index.js
@@ -777,7 +777,7 @@ var powerbi;
                         return 1;
                     }
                     function createScale(options) {
-                        var pixelSpan = options.pixelSpan, dataDomain = options.dataDomain, metaDataColumn = options.metaDataColumn, outerPadding = options.outerPadding || 0, isScalar = !!options.isScalar, isVertical = !!options.isVertical, forcedTickCount = options.forcedTickCount, categoryThickness = options.categoryThickness, shouldClamp = !!options.shouldClamp, maxTickCount = options.maxTickCount, disableNice = options.disableNice;
+                        var pixelSpan = options.pixelSpan, dataDomain = options.dataDomain, metaDataColumn = options.metaDataColumn, outerPadding = options.outerPadding || 0, isScalar = !!options.isScalar, isVertical = !!options.isVertical, forcedTickCount = options.forcedTickCount, categoryThickness = options.categoryThickness, shouldClamp = !!options.shouldClamp, maxTickCount = options.maxTickCount, disableNice = options.disableNice, disableNiceOnlyForScale = options.disableNiceOnlyForScale;
                         var dataType = getCategoryValueType(metaDataColumn, isScalar);
                         var maxTicks = isVertical ? getRecommendedNumberOfTicksForYAxis(pixelSpan) : getRecommendedNumberOfTicksForXAxis(pixelSpan);
                         if (maxTickCount &&
@@ -818,7 +818,11 @@ var powerbi;
                                     scalarDomain[0] = options.zeroScalarDomain[0];
                                     scalarDomain[1] = options.zeroScalarDomain[1];
                                 }
-                                scale = createNumericalScale(options.scaleType, pixelSpan, scalarDomain, dataType, outerPadding, bestTickCount, shouldClamp);
+                                var bestTickCountForNumericalScale = bestTickCount;
+                                if (disableNiceOnlyForScale) {
+                                    bestTickCountForNumericalScale = null;
+                                }
+                                scale = createNumericalScale(options.scaleType, pixelSpan, scalarDomain, dataType, outerPadding, bestTickCountForNumericalScale, shouldClamp);
                             }
                             else if (isScalar && dataType.dateTime) {
                                 // Use of a linear scale, instead of a D3.time.scale, is intentional since we want

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "powerbi-visuals-utils-chartutils",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "ChartUtils",
   "main": "lib/index.js",
   "repository": {

diff --git a/src/axis/axis.ts b/src/axis/axis.ts
@@ -759,7 +759,8 @@ module powerbi.extensibility.utils.chart.axis {
             categoryThickness = options.categoryThickness,
             shouldClamp = !!options.shouldClamp,
             maxTickCount = options.maxTickCount,
-            disableNice = options.disableNice;
+            disableNice = options.disableNice,
+            disableNiceOnlyForScale = options.disableNiceOnlyForScale;
 
         let dataType: ValueType = getCategoryValueType(metaDataColumn, isScalar);
 
@@ -808,7 +809,12 @@ module powerbi.extensibility.utils.chart.axis {
                     scalarDomain[1] = options.zeroScalarDomain[1];
                 }
 
-                scale = createNumericalScale(options.scaleType, pixelSpan, scalarDomain, dataType, outerPadding, bestTickCount, shouldClamp);
+                let bestTickCountForNumericalScale = bestTickCount;
+                if (disableNiceOnlyForScale) {
+                    bestTickCountForNumericalScale = null;
+                }
+
+                scale = createNumericalScale(options.scaleType, pixelSpan, scalarDomain, dataType, outerPadding, bestTickCountForNumericalScale, shouldClamp);
             }
             else if (isScalar && dataType.dateTime) {
                 // Use of a linear scale, instead of a D3.time.scale, is intentional since we want

diff --git a/src/axis/axisInterfaces.ts b/src/axis/axisInterfaces.ts
@@ -250,6 +250,8 @@ module powerbi.extensibility.utils.chart.axis {
         shouldClamp?: boolean;
         /** (optional) Disable "niceing" for numeric axis. It means that if max value is 172 the axis will show 172 but not rounded to upper value 180 */
         disableNice?: boolean;
+        /** (optional) Disable "niceing" for numeric axis. Disabling nice will be applid only when creating scale obj (bestTickCount will be applied to 'ticks' method) */
+        disableNiceOnlyForScale?: boolean;
     }
 
     export enum AxisOrientation {