echarts 4.5.0-rc.2 → 4.8.0

package/lib/data/DataDimensionInfo.js

@@ -0,0 +1,157 @@
+
+/*
+* 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 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.
+*/
+
+/**
+ * @class
+ * @param {Object|DataDimensionInfo} [opt] All of the fields will be shallow copied.
+ */
+function DataDimensionInfo(opt) {
+  if (opt != null) {
+    zrUtil.extend(this, opt);
+  }
+  /**
+   * Dimension name.
+   * Mandatory.
+   * @type {string}
+   */
+  // this.name;
+
+  /**
+   * The origin name in dimsDef, see source helper.
+   * If displayName given, the tooltip will displayed vertically.
+   * Optional.
+   * @type {string}
+   */
+  // this.displayName;
+
+  /**
+   * Which coordSys dimension this dimension mapped to.
+   * A `coordDim` can be a "coordSysDim" that the coordSys required
+   * (for example, an item in `coordSysDims` of `model/referHelper#CoordSysInfo`),
+   * or an generated "extra coord name" if does not mapped to any "coordSysDim"
+   * (That is determined by whether `isExtraCoord` is `true`).
+   * Mandatory.
+   * @type {string}
+   */
+  // this.coordDim;
+
+  /**
+   * The index of this dimension in `series.encode[coordDim]`.
+   * Mandatory.
+   * @type {number}
+   */
+  // this.coordDimIndex;
+
+  /**
+   * Dimension type. The enumerable values are the key of
+   * `dataCtors` of `data/List`.
+   * Optional.
+   * @type {string}
+   */
+  // this.type;
+
+  /**
+   * This index of this dimension info in `data/List#_dimensionInfos`.
+   * Mandatory after added to `data/List`.
+   * @type {number}
+   */
+  // this.index;
+
+  /**
+   * The format of `otherDims` is:
+   * ```js
+   * {
+   *     tooltip: number optional,
+   *     label: number optional,
+   *     itemName: number optional,
+   *     seriesName: number optional,
+   * }
+   * ```
+   *
+   * A `series.encode` can specified these fields:
+   * ```js
+   * encode: {
+   *     // "3, 1, 5" is the index of data dimension.
+   *     tooltip: [3, 1, 5],
+   *     label: [0, 3],
+   *     ...
+   * }
+   * ```
+   * `otherDims` is the parse result of the `series.encode` above, like:
+   * ```js
+   * // Suppose the index of this data dimension is `3`.
+   * this.otherDims = {
+   *     // `3` is at the index `0` of the `encode.tooltip`
+   *     tooltip: 0,
+   *     // `3` is at the index `1` of the `encode.tooltip`
+   *     label: 1
+   * };
+   * ```
+   *
+   * This prop should never be `null`/`undefined` after initialized.
+   * @type {Object}
+   */
+
+
+  this.otherDims = {};
+  /**
+   * Be `true` if this dimension is not mapped to any "coordSysDim" that the
+   * "coordSys" required.
+   * Mandatory.
+   * @type {boolean}
+   */
+  // this.isExtraCoord;
+
+  /**
+   * @type {module:data/OrdinalMeta}
+   */
+  // this.ordinalMeta;
+
+  /**
+   * Whether to create inverted indices.
+   * @type {boolean}
+   */
+  // this.createInvertedIndices;
+}
+
+;
+var _default = DataDimensionInfo;
+module.exports = _default;

package/lib/data/List.js

@@ -39,6 +39,8 @@ var _dimensionHelper = require("./helper/dimensionHelper");
 
 var summarizeDimensions = _dimensionHelper.summarizeDimensions;
 
+var DataDimensionInfo = require("./DataDimensionInfo");
+
 /*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
@@ -114,13 +116,9 @@ function transferProperties(target, source) {
  * @constructor
  * @alias module:echarts/data/List
  *
- * @param {Array.<string|Object>} dimensions
+ * @param {Array.<string|Object|module:data/DataDimensionInfo>} dimensions
  *      For example, ['someDimName', {name: 'someDimName', type: 'someDimType'}, ...].
  *      Dimensions should be concrete names like x, y, z, lng, lat, angle, radius
- *      Spetial fields: {
- *          ordinalMeta: <module:echarts/data/OrdinalMeta>
- *          createInvertedIndices: <boolean>
- *      }
  * @param {module:echarts/model/Model} hostModel
  */
 
@@ -136,9 +134,11 @@ var List = function (dimensions, hostModel) {
     var dimensionInfo = dimensions[i];
 
     if (zrUtil.isString(dimensionInfo)) {
-      dimensionInfo = {
+      dimensionInfo = new DataDimensionInfo({
         name: dimensionInfo
-      };
+      });
+    } else if (!(dimensionInfo instanceof DataDimensionInfo)) {
+      dimensionInfo = new DataDimensionInfo(dimensionInfo);
     }
 
     var dimensionName = dimensionInfo.name;
@@ -1182,7 +1182,8 @@ listProto.indexOfRawIndex = function (rawIndex) {
  * @param {string} dim
  * @param {number} value
  * @param {number} [maxDistance=Infinity]
- * @return {Array.<number>} Considere multiple points has the same value.
+ * @return {Array.<number>} If and only if multiple indices has
+ *        the same value, they are put to the result.
  */
 
 
@@ -1199,29 +1200,34 @@ listProto.indicesOfNearest = function (dim, value, maxDistance) {
     maxDistance = Infinity;
   }
 
-  var minDist = Number.MAX_VALUE;
+  var minDist = Infinity;
   var minDiff = -1;
+  var nearestIndicesLen = 0; // Check the test case of `test/ut/spec/data/List.js`.
 
   for (var i = 0, len = this.count(); i < len; i++) {
-    var diff = value - this.get(dim, i
-    /*, stack */
-    );
+    var diff = value - this.get(dim, i);
     var dist = Math.abs(diff);
 
-    if (diff <= maxDistance && dist <= minDist) {
-      // For the case of two data are same on xAxis, which has sequence data.
-      // Show the nearest index
-      // https://github.com/ecomfe/echarts/issues/2869
-      if (dist < minDist || diff >= 0 && minDiff < 0) {
+    if (dist <= maxDistance) {
+      // When the `value` is at the middle of `this.get(dim, i)` and `this.get(dim, i+1)`,
+      // we'd better not push both of them to `nearestIndices`, otherwise it is easy to
+      // get more than one item in `nearestIndices` (more specifically, in `tooltip`).
+      // So we chose the one that `diff >= 0` in this csae.
+      // But if `this.get(dim, i)` and `this.get(dim, j)` get the same value, both of them
+      // should be push to `nearestIndices`.
+      if (dist < minDist || dist === minDist && diff >= 0 && minDiff < 0) {
         minDist = dist;
         minDiff = diff;
-        nearestIndices.length = 0;
+        nearestIndicesLen = 0;
       }
 
-      nearestIndices.push(i);
+      if (diff === minDiff) {
+        nearestIndices[nearestIndicesLen++] = i;
+      }
     }
   }
 
+  nearestIndices.length = nearestIndicesLen;
   return nearestIndices;
 };
 /**

package/lib/data/Tree.js

@@ -281,14 +281,13 @@ TreeNode.prototype = {
 
     var hostTree = this.hostTree;
     var itemModel = hostTree.data.getItemModel(this.dataIndex);
-    var levelModel = this.getLevelModel();
-    var leavesModel;
+    var levelModel = this.getLevelModel(); // FIXME: refactor levelModel to "beforeLink", and remove levelModel here.
 
-    if (!levelModel && (this.children.length === 0 || this.children.length !== 0 && this.isExpand === false)) {
-      leavesModel = this.getLeavesModel();
+    if (levelModel) {
+      return itemModel.getModel(path, levelModel.getModel(path));
+    } else {
+      return itemModel.getModel(path);
     }
-
-    return itemModel.getModel(path, (levelModel || leavesModel || hostTree.hostModel).getModel(path));
   },
 
   /**
@@ -298,13 +297,6 @@ TreeNode.prototype = {
     return (this.hostTree.levelModels || [])[this.depth];
   },
 
-  /**
-   * @return {module:echarts/model/Model}
-   */
-  getLeavesModel: function () {
-    return this.hostTree.leavesModel;
-  },
-
   /**
    * @example
    *  setItemVisual('color', color);
@@ -376,10 +368,9 @@ TreeNode.prototype = {
  * @alias module:echarts/data/Tree
  * @param {module:echarts/model/Model} hostModel
  * @param {Array.<Object>} levelOptions
- * @param {Object} leavesOption
  */
 
-function Tree(hostModel, levelOptions, leavesOption) {
+function Tree(hostModel, levelOptions) {
   /**
    * @type {module:echarts/data/Tree~TreeNode}
    * @readOnly
@@ -414,7 +405,6 @@ function Tree(hostModel, levelOptions, leavesOption) {
   this.levelModels = zrUtil.map(levelOptions || [], function (levelDefine) {
     return new Model(levelDefine, hostModel, hostModel.ecModel);
   });
-  this.leavesModel = new Model(leavesOption || {}, hostModel, hostModel.ecModel);
 }
 
 Tree.prototype = {
@@ -503,12 +493,11 @@ Tree.prototype = {
  * @param {module:echarts/model/Model} hostModel
  * @param {Object} treeOptions
  * @param {Array.<Object>} treeOptions.levels
- * @param {Array.<Object>} treeOptions.leaves
  * @return module:echarts/data/Tree
  */
 
-Tree.createTree = function (dataRoot, hostModel, treeOptions) {
-  var tree = new Tree(hostModel, treeOptions.levels, treeOptions.leaves);
+Tree.createTree = function (dataRoot, hostModel, treeOptions, beforeLink) {
+  var tree = new Tree(hostModel, treeOptions && treeOptions.levels);
   var listData = [];
   var dimMax = 1;
   buildHierarchy(dataRoot);
@@ -538,6 +527,7 @@ Tree.createTree = function (dataRoot, hostModel, treeOptions) {
   });
   var list = new List(dimensionsInfo, hostModel);
   list.initData(listData);
+  beforeLink && beforeLink(list);
   linkList({
     mainData: list,
     struct: tree,

package/lib/data/helper/completeDimensions.js

@@ -35,6 +35,7 @@ var normalizeToArray = _model.normalizeToArray;
 var _sourceHelper = require("./sourceHelper");
 
 var guessOrdinal = _sourceHelper.guessOrdinal;
+var BE_ORDINAL = _sourceHelper.BE_ORDINAL;
 
 var Source = require("../Source");
 
@@ -42,6 +43,8 @@ var _dimensionHelper = require("./dimensionHelper");
 
 var OTHER_DIMENSIONS = _dimensionHelper.OTHER_DIMENSIONS;
 
+var DataDimensionInfo = require("../DataDimensionInfo");
+
 /*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
@@ -69,8 +72,12 @@ var OTHER_DIMENSIONS = _dimensionHelper.OTHER_DIMENSIONS;
 /**
  * @see {module:echarts/test/ut/spec/data/completeDimensions}
  *
- * Complete the dimensions array, by user defined `dimension` and `encode`,
- * and guessing from the data structure.
+ * This method builds the relationship between:
+ * + "what the coord sys or series requires (see `sysDims`)",
+ * + "what the user defines (in `encode` and `dimensions`, see `opt.dimsDef` and `opt.encodeDef`)"
+ * + "what the data source provids (see `source`)".
+ *
+ * Some guess strategy will be adapted if user does not define something.
  * If no 'value' dimension specified, the first no-named dimension will be
  * named as 'value'.
  *
@@ -86,32 +93,20 @@ var OTHER_DIMENSIONS = _dimensionHelper.OTHER_DIMENSIONS;
  * @param {Array.<Object|string>} [opt.dimsDef] option.series.dimensions User defined dimensions
  *      For example: ['asdf', {name, type}, ...].
  * @param {Object|HashMap} [opt.encodeDef] option.series.encode {x: 2, y: [3, 1], tooltip: [1, 2], label: 3}
+ * @param {Function} [opt.encodeDefaulter] Called if no `opt.encodeDef` exists.
+ *      If not specified, auto find the next available data dim.
+ *      param source {module:data/Source}
+ *      param dimCount {number}
+ *      return {Object} encode Never be `null/undefined`.
  * @param {string} [opt.generateCoord] Generate coord dim with the given name.
- *                 If not specified, extra dim names will be:
- *                 'value', 'value0', 'value1', ...
+ *      If not specified, extra dim names will be:
+ *      'value', 'value0', 'value1', ...
  * @param {number} [opt.generateCoordCount] By default, the generated dim name is `generateCoord`.
- *                 If `generateCoordCount` specified, the generated dim names will be:
- *                 `generateCoord` + 0, `generateCoord` + 1, ...
- *                 can be Infinity, indicate that use all of the remain columns.
+ *      If `generateCoordCount` specified, the generated dim names will be:
+ *      `generateCoord` + 0, `generateCoord` + 1, ...
+ *      can be Infinity, indicate that use all of the remain columns.
  * @param {number} [opt.dimCount] If not specified, guess by the first data item.
- * @param {number} [opt.encodeDefaulter] If not specified, auto find the next available data dim.
- * @return {Array.<Object>} [{
- *      name: string mandatory,
- *      displayName: string, the origin name in dimsDef, see source helper.
- *                 If displayName given, the tooltip will displayed vertically.
- *      coordDim: string mandatory,
- *      coordDimIndex: number mandatory,
- *      type: string optional,
- *      otherDims: { never null/undefined
- *          tooltip: number optional,
- *          label: number optional,
- *          itemName: number optional,
- *          seriesName: number optional,
- *      },
- *      isExtraCoord: boolean true if coord is generated
- *          (not specified in encode and not series specified)
- *      other props ...
- * }]
+ * @return {Array.<module:data/DataDimensionInfo>}
  */
 function completeDimensions(sysDims, source, opt) {
   if (!Source.isInstance(source)) {
@@ -121,7 +116,6 @@ function completeDimensions(sysDims, source, opt) {
   opt = opt || {};
   sysDims = (sysDims || []).slice();
   var dimsDef = (opt.dimsDef || []).slice();
-  var encodeDef = createHashMap(opt.encodeDef);
   var dataDimNameMap = createHashMap();
   var coordDimNameMap = createHashMap(); // var valueCandidate;
 
@@ -133,9 +127,7 @@ function completeDimensions(sysDims, source, opt) {
       name: dimsDef[i]
     });
     var userDimName = dimDefItem.name;
-    var resultItem = result[i] = {
-      otherDims: {}
-    }; // Name will be applied later for avoiding duplication.
+    var resultItem = result[i] = new DataDimensionInfo(); // Name will be applied later for avoiding duplication.
 
     if (userDimName != null && dataDimNameMap.get(userDimName) == null) {
       // Only if `series.dimensions` is defined in option
@@ -147,8 +139,15 @@ function completeDimensions(sysDims, source, opt) {
 
     dimDefItem.type != null && (resultItem.type = dimDefItem.type);
     dimDefItem.displayName != null && (resultItem.displayName = dimDefItem.displayName);
-  } // Set `coordDim` and `coordDimIndex` by `encodeDef` and normalize `encodeDef`.
+  }
+
+  var encodeDef = opt.encodeDef;
+
+  if (!encodeDef && opt.encodeDefaulter) {
+    encodeDef = opt.encodeDefaulter(source, dimCount);
+  }
 
+  encodeDef = createHashMap(encodeDef); // Set `coordDim` and `coordDimIndex` by `encodeDef` and normalize `encodeDef`.
 
   encodeDef.each(function (dataDims, coordDim) {
     dataDims = normalizeToArray(dataDims).slice(); // Note: It is allowed that `dataDims.length` is `0`, e.g., options is
@@ -249,7 +248,7 @@ function completeDimensions(sysDims, source, opt) {
   var extra = generateCoord || 'value'; // Set dim `name` and other `coordDim` and other props.
 
   for (var resultDimIdx = 0; resultDimIdx < dimCount; resultDimIdx++) {
-    var resultItem = result[resultDimIdx] = result[resultDimIdx] || {};
+    var resultItem = result[resultDimIdx] = result[resultDimIdx] || new DataDimensionInfo();
     var coordDim = resultItem.coordDim;
 
     if (coordDim == null) {
@@ -265,7 +264,19 @@ function completeDimensions(sysDims, source, opt) {
 
     resultItem.name == null && (resultItem.name = genName(resultItem.coordDim, dataDimNameMap));
 
-    if (resultItem.type == null && guessOrdinal(source, resultDimIdx, resultItem.name)) {
+    if (resultItem.type == null && (guessOrdinal(source, resultDimIdx, resultItem.name) === BE_ORDINAL.Must // Consider the case:
+    // {
+    //    dataset: {source: [
+    //        ['2001', 123],
+    //        ['2002', 456],
+    //        ...
+    //        ['The others', 987],
+    //    ]},
+    //    series: {type: 'pie'}
+    // }
+    // The first colum should better be treated as a "ordinal" although it
+    // might not able to be detected as an "ordinal" by `guessOrdinal`.
+    || resultItem.isExtraCoord && (resultItem.otherDims.itemName != null || resultItem.otherDims.seriesName != null))) {
       resultItem.type = 'ordinal';
     }
   }

package/lib/data/helper/createDimensions.js

@@ -53,6 +53,7 @@ var completeDimensions = require("./completeDimensions");
  * @param {string} [opt.generateCoordCount]
  * @param {Array.<string|Object>} [opt.dimensionsDefine=source.dimensionsDefine] Overwrite source define.
  * @param {Object|HashMap} [opt.encodeDefine=source.encodeDefine] Overwrite source define.
+ * @param {Function} [opt.encodeDefaulter] Make default encode if user not specified.
  * @return {Array.<Object>} dimensionsInfo
  */
 function _default(source, opt) {
@@ -61,6 +62,7 @@ function _default(source, opt) {
     dimsDef: opt.dimensionsDefine || source.dimensionsDefine,
     encodeDef: opt.encodeDefine || source.encodeDefine,
     dimCount: opt.dimensionsCount,
+    encodeDefaulter: opt.encodeDefaulter,
     generateCoord: opt.generateCoord,
     generateCoordCount: opt.generateCoordCount
   });