echarts 4.0.1 → 4.1.0

package/lib/coord/axisDefault.js

@@ -1,97 +1,98 @@
 var zrUtil = require("zrender/lib/core/util");
 
+/*
+* Licensed to the Apache Software Foundation (ASF) under one
+* or more contributor license agreements.  See the NOTICE file
+* distributed with this work for additional information
+* regarding copyright ownership.  The ASF licenses this file
+* to you under the Apache License, Version 2.0 (the
+* "License"); you may not use this file except in compliance
+* with the License.  You may obtain a copy of the License at
+*
+*   http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing,
+* software distributed under the License is distributed on an
+* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+* KIND, either express or implied.  See the License for the
+* specific language governing permissions and limitations
+* under the License.
+*/
 var defaultOption = {
   show: true,
   zlevel: 0,
-  // 一级层叠
   z: 0,
-  // 二级层叠
-  // 反向坐标轴
+  // Inverse the axis.
   inverse: false,
-  // 坐标轴名字，默认为空
+  // Axis name displayed.
   name: '',
-  // 坐标轴名字位置，支持'start' | 'middle' | 'end'
+  // 'start' | 'middle' | 'end'
   nameLocation: 'end',
-  // 坐标轴名字旋转，degree。
+  // By degree. By defualt auto rotate by nameLocation.
   nameRotate: null,
-  // Adapt to axis rotate, when nameLocation is 'middle'.
   nameTruncate: {
     maxWidth: null,
     ellipsis: '...',
     placeholder: '.'
   },
-  // 坐标轴文字样式，默认取全局样式
+  // Use global text style by default.
   nameTextStyle: {},
-  // 文字与轴线距离
+  // The gap between axisName and axisLine.
   nameGap: 15,
+  // Default `false` to support tooltip.
   silent: false,
-  // Default false to support tooltip.
+  // Default `false` to avoid legacy user event listener fail.
   triggerEvent: false,
-  // Default false to avoid legacy user event listener fail.
   tooltip: {
     show: false
   },
   axisPointer: {},
-  // 坐标轴线
   axisLine: {
-    // 默认显示，属性show控制显示与否
     show: true,
     onZero: true,
     onZeroAxisIndex: null,
-    // 属性lineStyle控制线条样式
     lineStyle: {
       color: '#333',
       width: 1,
       type: 'solid'
     },
-    // 坐标轴两端的箭头
+    // The arrow at both ends the the axis.
     symbol: ['none', 'none'],
     symbolSize: [10, 15]
   },
-  // 坐标轴小标记
   axisTick: {
-    // 属性show控制显示与否，默认显示
     show: true,
-    // 控制小标记是否在grid里
+    // Whether axisTick is inside the grid or outside the grid.
     inside: false,
-    // 属性length控制线长
+    // The length of axisTick.
     length: 5,
-    // 属性lineStyle控制线条样式
     lineStyle: {
       width: 1
     }
   },
-  // 坐标轴文本标签，详见axis.axisLabel
   axisLabel: {
     show: true,
-    // 控制文本标签是否在grid里
+    // Whether axisLabel is inside the grid or outside the grid.
     inside: false,
     rotate: 0,
+    // true | false | null/undefined (auto)
     showMinLabel: null,
-    // true | false | null (auto)
+    // true | false | null/undefined (auto)
     showMaxLabel: null,
-    // true | false | null (auto)
     margin: 8,
     // formatter: null,
-    // 其余属性默认使用全局文本样式，详见TEXTSTYLE
     fontSize: 12
   },
-  // 分隔线
   splitLine: {
-    // 默认显示，属性show控制显示与否
     show: true,
-    // 属性lineStyle（详见lineStyle）控制线条样式
     lineStyle: {
       color: ['#ccc'],
       width: 1,
       type: 'solid'
     }
   },
-  // 分隔区域
   splitArea: {
-    // 默认不显示，属性show控制显示与否
     show: false,
-    // 属性areaStyle（详见areaStyle）控制区域样式
     areaStyle: {
       color: ['rgba(250,250,250,0.3)', 'rgba(200,200,200,0.3)']
     }
@@ -99,7 +100,7 @@ var defaultOption = {
 };
 var axisDefault = {};
 axisDefault.categoryAxis = zrUtil.merge({
-  // 类目起始和结束两端空白策略
+  // The gap at both ends of the axis. For categoryAxis, boolean.
   boundaryGap: true,
   // Set false to faster category collection.
   // Only usefull in the case like: category is
@@ -115,39 +116,48 @@ axisDefault.categoryAxis = zrUtil.merge({
   splitLine: {
     show: false
   },
-  // 坐标轴小标记
   axisTick: {
     // If tick is align with label when boundaryGap is true
     alignWithLabel: false,
     interval: 'auto'
   },
-  // 坐标轴文本标签，详见axis.axisLabel
   axisLabel: {
     interval: 'auto'
   }
 }, defaultOption);
 axisDefault.valueAxis = zrUtil.merge({
-  // 数值起始和结束两端空白策略
+  // The gap at both ends of the axis. For value axis, [GAP, GAP], where
+  // `GAP` can be an absolute pixel number (like `35`), or percent (like `'30%'`)
   boundaryGap: [0, 0],
   // TODO
   // min/max: [30, datamin, 60] or [20, datamin] or [datamin, 60]
-  // 最小值, 设置成 'dataMin' 则从数据中计算最小值
+  // Min value of the axis. can be:
+  // + a number
+  // + 'dataMin': use the min value in data.
+  // + null/undefined: auto decide min value (consider pretty look and boundaryGap).
   // min: null,
-  // 最大值，设置成 'dataMax' 则从数据中计算最大值
+  // Max value of the axis. can be:
+  // + a number
+  // + 'dataMax': use the max value in data.
+  // + null/undefined: auto decide max value (consider pretty look and boundaryGap).
   // max: null,
   // Readonly prop, specifies start value of the range when using data zoom.
   // rangeStart: null
   // Readonly prop, specifies end value of the range when using data zoom.
   // rangeEnd: null
-  // 脱离0值比例，放大聚焦到最终_min，_max区间
+  // Optional value can be:
+  // + `false`: always include value 0.
+  // + `true`: the extent do not consider value 0.
   // scale: false,
-  // 分割段数，默认为5
-  splitNumber: 5 // Minimum interval
+  // AxisTick and axisLabel and splitLine are caculated based on splitNumber.
+  splitNumber: 5 // Interval specifies the span of the ticks is mandatorily.
+  // interval: null
+  // Specify min interval when auto calculate tick interval.
   // minInterval: null
+  // Specify max interval when auto calculate tick interval.
   // maxInterval: null
 
-}, defaultOption); // FIXME
-
+}, defaultOption);
 axisDefault.timeAxis = zrUtil.defaults({
   scale: true,
   min: 'dataMin',

package/lib/coord/axisHelper.js

@@ -4,8 +4,6 @@ var __DEV__ = _config.__DEV__;
 
 var zrUtil = require("zrender/lib/core/util");
 
-var textContain = require("zrender/lib/contain/text");
-
 var OrdinalScale = require("../scale/Ordinal");
 
 var IntervalScale = require("../scale/Interval");
@@ -16,12 +14,35 @@ var numberUtil = require("../util/number");
 
 var _barGrid = require("../layout/barGrid");
 
-var calBarWidthAndOffset = _barGrid.calBarWidthAndOffset;
+var prepareLayoutBarSeries = _barGrid.prepareLayoutBarSeries;
+var makeColumnLayout = _barGrid.makeColumnLayout;
+var retrieveColumnLayout = _barGrid.retrieveColumnLayout;
+
+var BoundingRect = require("zrender/lib/core/BoundingRect");
 
 require("../scale/Time");
 
 require("../scale/Log");
 
+/*
+* Licensed to the Apache Software Foundation (ASF) under one
+* or more contributor license agreements.  See the NOTICE file
+* distributed with this work for additional information
+* regarding copyright ownership.  The ASF licenses this file
+* to you under the Apache License, Version 2.0 (the
+* "License"); you may not use this file except in compliance
+* with the License.  You may obtain a copy of the License at
+*
+*   http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing,
+* software distributed under the License is distributed on an
+* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+* KIND, either express or implied.  See the License for the
+* specific language governing permissions and limitations
+* under the License.
+*/
+
 /**
  * Get axis scale extent before niced.
  * Item of returned array can only be number (including Infinity and NaN).
@@ -96,7 +117,7 @@ function getScaleExtent(scale, model) {
 
   (min == null || !isFinite(min)) && (min = NaN);
   (max == null || !isFinite(max)) && (max = NaN);
-  scale.setBlank(zrUtil.eqNaN(min) || zrUtil.eqNaN(max)); // Evaluate if axis needs cross zero
+  scale.setBlank(zrUtil.eqNaN(min) || zrUtil.eqNaN(max) || scaleType === 'ordinal' && !scale.getOrdinalMeta().categories.length); // Evaluate if axis needs cross zero
 
   if (model.getNeedCrossZero()) {
     // Axis is over zero and min is not set
@@ -110,18 +131,31 @@ function getScaleExtent(scale, model) {
     }
   } // If bars are placed on a base axis of type time or interval account for axis boundary overflow and current axis
   // is base axis
+  // FIXME
+  // (1) Consider support value axis, where below zero and axis `onZero` should be handled properly.
+  // (2) Refactor the logic with `barGrid`. Is it not need to `makeBarWidthAndOffsetInfo` twice with different extent?
+  //     Should not depend on series type `bar`?
+  // (3) Fix that might overlap when using dataZoom.
+  // (4) Consider other chart types using `barGrid`?
+  // See #6728, #4862, `test/bar-overflow-time-plot.html`
 
 
   var ecModel = model.ecModel;
 
-  if (ecModel) {
-    var isBaseAxisAndHasBarSeries = zrUtil.filter(ecModel.getSeriesByType('bar'), function (seriesModel) {
-      return seriesModel.getBaseAxis() === model.axis;
-    }).length > 0;
+  if (ecModel && scaleType === 'time'
+  /*|| scaleType === 'interval' */
+  ) {
+    var barSeriesModels = prepareLayoutBarSeries('bar', ecModel);
+    var isBaseAxisAndHasBarSeries;
+    zrUtil.each(barSeriesModels, function (seriesModel) {
+      isBaseAxisAndHasBarSeries |= seriesModel.getBaseAxis() === model.axis;
+    });
+
+    if (isBaseAxisAndHasBarSeries) {
+      // Calculate placement of bars on axis
+      var barWidthAndOffset = makeColumnLayout(barSeriesModels); // Adjust axis min and max to account for overflow
 
-    if ((scaleType === 'time' || scaleType === 'interval') && isBaseAxisAndHasBarSeries) {
-      // Adjust axis min and max to account for overflow
-      var adjustedScale = adjustScaleForOverflow(min, max, model);
+      var adjustedScale = adjustScaleForOverflow(min, max, model, barWidthAndOffset);
       min = adjustedScale.min;
       max = adjustedScale.max;
     }
@@ -130,18 +164,12 @@ function getScaleExtent(scale, model) {
   return [min, max];
 }
 
-function adjustScaleForOverflow(min, max, model) {
-  var ecModel = model.ecModel; // Get Axis Length
-
+function adjustScaleForOverflow(min, max, model, barWidthAndOffset) {
+  // Get Axis Length
   var axisExtent = model.axis.getExtent();
-  var axisLength = axisExtent[1] - axisExtent[0]; // Calculate placement of bars on axis
-
-  var barWidthAndOffset = calBarWidthAndOffset(zrUtil.filter(ecModel.getSeriesByType('bar'), function (seriesModel) {
-    return !ecModel.isSeriesFiltered(seriesModel) && seriesModel.coordinateSystem && seriesModel.coordinateSystem.type === 'cartesian2d';
-  })); // Get bars on current base axis and calculate min and max overflow
+  var axisLength = axisExtent[1] - axisExtent[0]; // Get bars on current base axis and calculate min and max overflow
 
-  var baseAxisKey = model.axis.dim + model.axis.index;
-  var barsOnCurrentAxis = barWidthAndOffset[baseAxisKey];
+  var barsOnCurrentAxis = retrieveColumnLayout(barWidthAndOffset, model.axis);
 
   if (barsOnCurrentAxis === undefined) {
     return {
@@ -158,7 +186,9 @@ function adjustScaleForOverflow(min, max, model) {
   zrUtil.each(barsOnCurrentAxis, function (item) {
     maxOverflow = Math.max(item.offset + item.width, maxOverflow);
   });
-  var totalOverFlow = Math.abs(minOverflow) + maxOverflow; // Calulate required buffer based on old range and overflow
+  minOverflow = Math.abs(minOverflow);
+  maxOverflow = Math.abs(maxOverflow);
+  var totalOverFlow = minOverflow + maxOverflow; // Calulate required buffer based on old range and overflow
 
   var oldRange = max - min;
   var oldRangePercentOfNew = 1 - (minOverflow + maxOverflow) / axisLength;
@@ -238,99 +268,116 @@ function ifAxisCrossZero(axis) {
   return !(min > 0 && max > 0 || min < 0 && max < 0);
 }
 /**
- * @param {Array.<number>} tickCoords In axis self coordinate.
- * @param {Array.<string>} labels
- * @param {string} font
- * @param {number} axisRotate 0: towards right horizontally, clock-wise is negative.
- * @param {number} [labelRotate=0] 0: towards right horizontally, clock-wise is negative.
- * @return {number}
+ * @param {module:echarts/coord/Axis} axis
+ * @return {Function} Label formatter function.
+ *         param: {number} tickValue,
+ *         param: {number} idx, the index in all ticks.
+ *                         If category axis, this param is not requied.
+ *         return: {string} label string.
  */
 
 
-function getAxisLabelInterval(tickCoords, labels, font, axisRotate, labelRotate) {
-  var textSpaceTakenRect;
-  var autoLabelInterval = 0;
-  var accumulatedLabelInterval = 0;
-  var rotation = (axisRotate - labelRotate) / 180 * Math.PI;
-  var step = 1;
-
-  if (labels.length > 40) {
-    // Simple optimization for large amount of labels
-    step = Math.floor(labels.length / 40);
-  }
-
-  for (var i = 0; i < tickCoords.length; i += step) {
-    var tickCoord = tickCoords[i]; // Not precise, do not consider align and vertical align
-    // and each distance from axis line yet.
-
-    var rect = textContain.getBoundingRect(labels[i], font, 'center', 'top');
-    rect.x += tickCoord * Math.cos(rotation);
-    rect.y += tickCoord * Math.sin(rotation); // Magic number
+function makeLabelFormatter(axis) {
+  var labelFormatter = axis.getLabelModel().get('formatter');
+  var categoryTickStart = axis.type === 'category' ? axis.scale.getExtent()[0] : null;
 
-    rect.width *= 1.3;
-    rect.height *= 1.3;
+  if (typeof labelFormatter === 'string') {
+    labelFormatter = function (tpl) {
+      return function (val) {
+        return tpl.replace('{value}', val != null ? val : '');
+      };
+    }(labelFormatter); // Consider empty array
 
-    if (!textSpaceTakenRect) {
-      textSpaceTakenRect = rect.clone();
-    } // There is no space for current label;
-    else if (textSpaceTakenRect.intersect(rect)) {
-        accumulatedLabelInterval++;
-        autoLabelInterval = Math.max(autoLabelInterval, accumulatedLabelInterval);
-      } else {
-        textSpaceTakenRect.union(rect); // Reset
 
-        accumulatedLabelInterval = 0;
+    return labelFormatter;
+  } else if (typeof labelFormatter === 'function') {
+    return function (tickValue, idx) {
+      // The original intention of `idx` is "the index of the tick in all ticks".
+      // But the previous implementation of category axis do not consider the
+      // `axisLabel.interval`, which cause that, for example, the `interval` is
+      // `1`, then the ticks "name5", "name7", "name9" are displayed, where the
+      // corresponding `idx` are `0`, `2`, `4`, but not `0`, `1`, `2`. So we keep
+      // the definition here for back compatibility.
+      if (categoryTickStart != null) {
+        idx = tickValue - categoryTickStart;
       }
-  }
 
-  if (autoLabelInterval === 0 && step > 1) {
-    return step;
+      return labelFormatter(getAxisRawValue(axis, tickValue), idx);
+    };
+  } else {
+    return function (tick) {
+      return axis.scale.getLabel(tick);
+    };
   }
+}
 
-  return (autoLabelInterval + 1) * step - 1;
+function getAxisRawValue(axis, value) {
+  // In category axis with data zoom, tick is not the original
+  // index of axis.data. So tick should not be exposed to user
+  // in category axis.
+  return axis.type === 'category' ? axis.scale.getLabel(value) : value;
 }
 /**
- * @param {Object} axis
- * @param {Function} labelFormatter
- * @return {Array.<string>}
+ * @param {module:echarts/coord/Axis} axis
+ * @return {module:zrender/core/BoundingRect} Be null/undefined if no labels.
  */
 
 
-function getFormattedLabels(axis, labelFormatter) {
+function estimateLabelUnionRect(axis) {
+  var axisModel = axis.model;
   var scale = axis.scale;
-  var labels = scale.getTicksLabels();
-  var ticks = scale.getTicks();
 
-  if (typeof labelFormatter === 'string') {
-    labelFormatter = function (tpl) {
-      return function (val) {
-        return tpl.replace('{value}', val != null ? val : '');
-      };
-    }(labelFormatter); // Consider empty array
+  if (!axisModel.get('axisLabel.show') || scale.isBlank()) {
+    return;
+  }
 
+  var isCategory = axis.type === 'category';
+  var realNumberScaleTicks;
+  var tickCount;
+  var categoryScaleExtent = scale.getExtent(); // Optimize for large category data, avoid call `getTicks()`.
 
-    return zrUtil.map(labels, labelFormatter);
-  } else if (typeof labelFormatter === 'function') {
-    return zrUtil.map(ticks, function (tick, idx) {
-      return labelFormatter(getAxisRawValue(axis, tick), idx);
-    }, this);
+  if (isCategory) {
+    tickCount = scale.count();
   } else {
-    return labels;
+    realNumberScaleTicks = scale.getTicks();
+    tickCount = realNumberScaleTicks.length;
+  }
+
+  var axisLabelModel = axis.getLabelModel();
+  var labelFormatter = makeLabelFormatter(axis);
+  var rect;
+  var step = 1; // Simple optimization for large amount of labels
+
+  if (tickCount > 40) {
+    step = Math.ceil(tickCount / 40);
+  }
+
+  for (var i = 0; i < tickCount; i += step) {
+    var tickValue = realNumberScaleTicks ? realNumberScaleTicks[i] : categoryScaleExtent[0] + i;
+    var label = labelFormatter(tickValue);
+    var unrotatedSingleRect = axisLabelModel.getTextRect(label);
+    var singleRect = rotateTextRect(unrotatedSingleRect, axisLabelModel.get('rotate') || 0);
+    rect ? rect.union(singleRect) : rect = singleRect;
   }
+
+  return rect;
 }
 
-function getAxisRawValue(axis, value) {
-  // In category axis with data zoom, tick is not the original
-  // index of axis.data. So tick should not be exposed to user
-  // in category axis.
-  return axis.type === 'category' ? axis.scale.getLabel(value) : value;
+function rotateTextRect(textRect, rotate) {
+  var rotateRadians = rotate * Math.PI / 180;
+  var boundingBox = textRect.plain();
+  var beforeWidth = boundingBox.width;
+  var beforeHeight = boundingBox.height;
+  var afterWidth = beforeWidth * Math.cos(rotateRadians) + beforeHeight * Math.sin(rotateRadians);
+  var afterHeight = beforeWidth * Math.sin(rotateRadians) + beforeHeight * Math.cos(rotateRadians);
+  var rotatedRect = new BoundingRect(boundingBox.x, boundingBox.y, afterWidth, afterHeight);
+  return rotatedRect;
 }
 
 exports.getScaleExtent = getScaleExtent;
-exports.adjustScaleForOverflow = adjustScaleForOverflow;
 exports.niceScaleExtent = niceScaleExtent;
 exports.createScaleByModel = createScaleByModel;
 exports.ifAxisCrossZero = ifAxisCrossZero;
-exports.getAxisLabelInterval = getAxisLabelInterval;
-exports.getFormattedLabels = getFormattedLabels;
-exports.getAxisRawValue = getAxisRawValue;
+exports.makeLabelFormatter = makeLabelFormatter;
+exports.getAxisRawValue = getAxisRawValue;
+exports.estimateLabelUnionRect = estimateLabelUnionRect;

package/lib/coord/axisModelCommonMixin.js

@@ -2,15 +2,25 @@ var zrUtil = require("zrender/lib/core/util");
 
 var axisHelper = require("./axisHelper");
 
+/*
+* Licensed to the Apache Software Foundation (ASF) under one
+* or more contributor license agreements.  See the NOTICE file
+* distributed with this work for additional information
+* regarding copyright ownership.  The ASF licenses this file
+* to you under the Apache License, Version 2.0 (the
+* "License"); you may not use this file except in compliance
+* with the License.  You may obtain a copy of the License at
+*
+*   http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing,
+* software distributed under the License is distributed on an
+* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+* KIND, either express or implied.  See the License for the
+* specific language governing permissions and limitations
+* under the License.
+*/
 var _default = {
-  /**
-   * Format labels
-   * @return {Array.<string>}
-   */
-  getFormattedLabels: function () {
-    return axisHelper.getFormattedLabels(this.axis, this.get('axisLabel.formatter'));
-  },
-
   /**
    * @param {boolean} origin
    * @return {number|string} min value or 'dataMin' or null/undefined (means auto) or NaN

package/lib/coord/axisModelCreator.js

@@ -11,6 +11,24 @@ var mergeLayoutParam = _layout.mergeLayoutParam;
 
 var OrdinalMeta = require("../data/OrdinalMeta");
 
+/*
+* Licensed to the Apache Software Foundation (ASF) under one
+* or more contributor license agreements.  See the NOTICE file
+* distributed with this work for additional information
+* regarding copyright ownership.  The ASF licenses this file
+* to you under the Apache License, Version 2.0 (the
+* "License"); you may not use this file except in compliance
+* with the License.  You may obtain a copy of the License at
+*
+*   http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing,
+* software distributed under the License is distributed on an
+* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+* KIND, either express or implied.  See the License for the
+* specific language governing permissions and limitations
+* under the License.
+*/
 // FIXME axisType is fixed ?
 var AXIS_TYPES = ['value', 'category', 'time', 'log'];
 /**
@@ -56,10 +74,15 @@ function _default(axisName, BaseAxisModelClass, axisTypeDefaulter, extraDefaultO
        * Should not be called before all of 'getInitailData' finished.
        * Because categories are collected during initializing data.
        */
-      getCategories: function () {
-        // FIXME
+      getCategories: function (rawData) {
+        var option = this.option; // FIXME
         // warning if called before all of 'getInitailData' finished.
-        if (this.option.type === 'category') {
+
+        if (option.type === 'category') {
+          if (rawData) {
+            return option.data;
+          }
+
           return this.__ordinalMeta.categories;
         }
       },