100pah commented on a change in pull request #12590: URL: https://github.com/apache/incubator-echarts/pull/12590#discussion_r446503827
########## File path: src/chart/helper/multipleGraphEdgeHelper.js ########## @@ -0,0 +1,238 @@ +/* +* 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. +*/ + +import * as zrUtil from 'zrender/src/core/util'; + +var KEY_DELIMITER = '-->'; +/** + * params handler + * @param {module:echarts/model/SeriesModel} seriesModel + * @returns {*} + */ +var getAutoCurvenessParams = function (seriesModel) { + return seriesModel.get('autoCurveness') || null; +}; + +/** + * Generate a list of edge curvatures, 20 is the default + * @param {module:echarts/model/SeriesModel} seriesModel + * @param {number} appendLength + * @return 20 => [0, -0.2, 0.2, -0.4, 0.4, -0.6, 0.6, -0.8, 0.8, -1, 1, -1.2, 1.2, -1.4, 1.4, -1.6, 1.6, -1.8, 1.8, -2] + */ +var createCurveness = function (seriesModel, appendLength) { + var autoCurvenessParmas = getAutoCurvenessParams(seriesModel); + var length = 20; + var curvenessList = []; + + // handler the function set + if (typeof autoCurvenessParmas === 'number') { + length = autoCurvenessParmas; + } + else if (zrUtil.isArray(autoCurvenessParmas)) { + seriesModel._curvenessList = autoCurvenessParmas; Review comment: By convention in echarts, if we mount something to an instance which does not belongs to this module, we use '__' prefix (rather than '_') to prevent from conflict with its private member. So here should better be `__curvenessList` ########## File path: src/data/Graph.js ########## @@ -182,6 +179,8 @@ graphProto.addEdge = function (n1, n2, dataIndex) { this.edges.push(edge); edgesMap[key] = edge; + createEdgeMapForCurveness(n1, n2, seriesModel, dataIndex); Review comment: I think `createEdgeMapForCurveness` should better not be added in `Graph addEdge`. Because `Graph` is not only used in graph series but also used in other series like sankey. And `Graph` it seams that do not need to depends on the module `multipleGraphEdgeHelper`, and do not necessary to introduce an param of `seriesModel` here. The calling of `createEdgeMapForCurveness` can be done in `GraphSeries getInitialData`. See the comment in `GraphSeries getInitialData`. ########## File path: src/chart/helper/multipleGraphEdgeHelper.js ########## @@ -0,0 +1,238 @@ +/* +* 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. +*/ + +import * as zrUtil from 'zrender/src/core/util'; + +var KEY_DELIMITER = '-->'; +/** + * params handler + * @param {module:echarts/model/SeriesModel} seriesModel + * @returns {*} + */ +var getAutoCurvenessParams = function (seriesModel) { + return seriesModel.get('autoCurveness') || null; +}; + +/** + * Generate a list of edge curvatures, 20 is the default + * @param {module:echarts/model/SeriesModel} seriesModel + * @param {number} appendLength + * @return 20 => [0, -0.2, 0.2, -0.4, 0.4, -0.6, 0.6, -0.8, 0.8, -1, 1, -1.2, 1.2, -1.4, 1.4, -1.6, 1.6, -1.8, 1.8, -2] + */ +var createCurveness = function (seriesModel, appendLength) { + var autoCurvenessParmas = getAutoCurvenessParams(seriesModel); + var length = 20; + var curvenessList = []; + + // handler the function set + if (typeof autoCurvenessParmas === 'number') { + length = autoCurvenessParmas; + } + else if (zrUtil.isArray(autoCurvenessParmas)) { + seriesModel._curvenessList = autoCurvenessParmas; + return; + } + + // append length + if (appendLength > length) { + length = appendLength; + } + + // make sure the length is even + var len = length % 2 ? length + 2 : length + 3; + curvenessList = []; + + for (var i = 0; i < len; i++) { + curvenessList.push((i % 2 ? i + 1 : i) / 10 * (i % 2 ? -1 : 1)); + } + seriesModel._curvenessList = curvenessList; +}; + +/** + * Create different cache key data in the positive and negative directions, in order to set the curvature later + * @param {number|string|module:echarts/data/Graph.Node} n1 + * @param {number|string|module:echarts/data/Graph.Node} n2 + * @param {module:echarts/model/SeriesModel} seriesModel + * @returns {string} key + */ +var getKeyOfEdges = function (n1, n2, seriesModel) { + var source = [n1.id, n1.dataIndex].join('.'); + var target = [n2.id, n2.dataIndex].join('.'); + return [seriesModel.uid, source, target].join(KEY_DELIMITER); +}; + +/** + * get opposite key + * @param {string} key + * @returns {string} + */ +var getOppositeKey = function (key) { + var keys = key.split(KEY_DELIMITER); + return [keys[0], keys[2], keys[1]].join(KEY_DELIMITER); +}; + +/** + * set edgeMap with key + * @param {number|string|module:echarts/data/Graph.Node} n1 + * @param {number|string|module:echarts/data/Graph.Node} n2 + * @param {module:echarts/model/SeriesModel} seriesModel + * @param {number} index + */ +var setEdgeToMap = function (n1, n2, seriesModel, index) { + var key = getKeyOfEdges(n1, n2, seriesModel); + var edgeMap = seriesModel._edgeMap; + var oppositeEdges = edgeMap[getOppositeKey(key)]; + // set direction + if (edgeMap[key] && !oppositeEdges) { + edgeMap[key].isForward = true; + } + else if (oppositeEdges && edgeMap[key]) { + oppositeEdges.isForward = true; + edgeMap[key].isForward = false; + } + + edgeMap[key] = edgeMap[key] || []; + edgeMap[key].push(index); +}; + +/** + * get edgeMap with key + * @param edge + * @param {module:echarts/model/SeriesModel} seriesModel + */ +var getEdgeFromMap = function (edge, seriesModel) { + var key = getKeyOfEdges(edge.node1, edge.node2, seriesModel); + return seriesModel._edgeMap[key]; +}; + +/** + * calculate all cases total length + * @param edge + * @param seriesModel + * @returns {number} + */ +var getTotalLengthBetweenNodes = function (edge, seriesModel) { + var len = getEdgeMapLengthWithKey(getKeyOfEdges(edge.node1, edge.node2, seriesModel), seriesModel); + var lenV = getEdgeMapLengthWithKey(getKeyOfEdges(edge.node2, edge.node1, seriesModel), seriesModel); + + return len + lenV; +}; + +/** + * + * @param key + */ +var getEdgeMapLengthWithKey = function (key, seriesModel) { + var edgeMap = seriesModel._edgeMap; + return edgeMap[key] ? edgeMap[key].length : 0; +}; + +/** + * Count the number of edges between the same two points, used to obtain the curvature table and the parity of the edge + * @see /graph/GraphSeries.js@getInitialData + * @param edges + * @param {module:echarts/model/SeriesModel} seriesModel + */ +export function initCurvenessList(edges, seriesModel) { + if (!getAutoCurvenessParams(seriesModel)) { + return; + } + // Hang on this object 4 dispose + seriesModel._curvenessList = seriesModel._curvenessList || []; Review comment: Not sure the meaning of > Hang on this object 4 dispose And I think for simplicity we can re-create `seriesModel._curvenessList` when each time `initCurvenessList` called rather than keeping the last `seriesModel._curvenessList`. (Should consider that users might call `setOption` multiple times). So here I think probably we should better be: ```js seriesModel.__curvenessList = []; seriesModel.__edgeMap = []; ``` ? ########## File path: src/chart/helper/multipleGraphEdgeHelper.js ########## @@ -0,0 +1,238 @@ +/* +* 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. +*/ + +import * as zrUtil from 'zrender/src/core/util'; + +var KEY_DELIMITER = '-->'; +/** + * params handler + * @param {module:echarts/model/SeriesModel} seriesModel + * @returns {*} + */ +var getAutoCurvenessParams = function (seriesModel) { + return seriesModel.get('autoCurveness') || null; +}; + +/** + * Generate a list of edge curvatures, 20 is the default + * @param {module:echarts/model/SeriesModel} seriesModel + * @param {number} appendLength + * @return 20 => [0, -0.2, 0.2, -0.4, 0.4, -0.6, 0.6, -0.8, 0.8, -1, 1, -1.2, 1.2, -1.4, 1.4, -1.6, 1.6, -1.8, 1.8, -2] + */ +var createCurveness = function (seriesModel, appendLength) { + var autoCurvenessParmas = getAutoCurvenessParams(seriesModel); + var length = 20; + var curvenessList = []; + + // handler the function set + if (typeof autoCurvenessParmas === 'number') { + length = autoCurvenessParmas; + } + else if (zrUtil.isArray(autoCurvenessParmas)) { + seriesModel._curvenessList = autoCurvenessParmas; + return; + } + + // append length + if (appendLength > length) { + length = appendLength; + } + + // make sure the length is even + var len = length % 2 ? length + 2 : length + 3; + curvenessList = []; + + for (var i = 0; i < len; i++) { + curvenessList.push((i % 2 ? i + 1 : i) / 10 * (i % 2 ? -1 : 1)); + } + seriesModel._curvenessList = curvenessList; +}; + +/** + * Create different cache key data in the positive and negative directions, in order to set the curvature later + * @param {number|string|module:echarts/data/Graph.Node} n1 + * @param {number|string|module:echarts/data/Graph.Node} n2 + * @param {module:echarts/model/SeriesModel} seriesModel + * @returns {string} key + */ +var getKeyOfEdges = function (n1, n2, seriesModel) { + var source = [n1.id, n1.dataIndex].join('.'); + var target = [n2.id, n2.dataIndex].join('.'); + return [seriesModel.uid, source, target].join(KEY_DELIMITER); +}; + +/** + * get opposite key + * @param {string} key + * @returns {string} + */ +var getOppositeKey = function (key) { + var keys = key.split(KEY_DELIMITER); + return [keys[0], keys[2], keys[1]].join(KEY_DELIMITER); +}; + +/** + * set edgeMap with key + * @param {number|string|module:echarts/data/Graph.Node} n1 + * @param {number|string|module:echarts/data/Graph.Node} n2 + * @param {module:echarts/model/SeriesModel} seriesModel + * @param {number} index + */ +var setEdgeToMap = function (n1, n2, seriesModel, index) { + var key = getKeyOfEdges(n1, n2, seriesModel); + var edgeMap = seriesModel._edgeMap; + var oppositeEdges = edgeMap[getOppositeKey(key)]; + // set direction + if (edgeMap[key] && !oppositeEdges) { + edgeMap[key].isForward = true; + } + else if (oppositeEdges && edgeMap[key]) { + oppositeEdges.isForward = true; + edgeMap[key].isForward = false; + } + + edgeMap[key] = edgeMap[key] || []; + edgeMap[key].push(index); +}; + +/** + * get edgeMap with key + * @param edge + * @param {module:echarts/model/SeriesModel} seriesModel + */ +var getEdgeFromMap = function (edge, seriesModel) { + var key = getKeyOfEdges(edge.node1, edge.node2, seriesModel); + return seriesModel._edgeMap[key]; +}; + +/** + * calculate all cases total length + * @param edge + * @param seriesModel + * @returns {number} + */ +var getTotalLengthBetweenNodes = function (edge, seriesModel) { + var len = getEdgeMapLengthWithKey(getKeyOfEdges(edge.node1, edge.node2, seriesModel), seriesModel); + var lenV = getEdgeMapLengthWithKey(getKeyOfEdges(edge.node2, edge.node1, seriesModel), seriesModel); + + return len + lenV; +}; + +/** + * + * @param key + */ +var getEdgeMapLengthWithKey = function (key, seriesModel) { + var edgeMap = seriesModel._edgeMap; + return edgeMap[key] ? edgeMap[key].length : 0; +}; + +/** + * Count the number of edges between the same two points, used to obtain the curvature table and the parity of the edge + * @see /graph/GraphSeries.js@getInitialData + * @param edges + * @param {module:echarts/model/SeriesModel} seriesModel + */ +export function initCurvenessList(edges, seriesModel) { + if (!getAutoCurvenessParams(seriesModel)) { + return; + } + // Hang on this object 4 dispose + seriesModel._curvenessList = seriesModel._curvenessList || []; + // calc the array of curveness List + createCurveness(seriesModel); +} + +/** + * create the edgeMap after addEdges + * @see chart/helper/createGraphFromNodeEdge.js#L52 + * @param {number|string|module:echarts/data/Graph.Node} n1 + * @param {number|string|module:echarts/data/Graph.Node} n2 + * @param {module:echarts/model/SeriesModel} seriesModel + * @param {number} dataIndex + */ +export function createEdgeMapForCurveness(n1, n2, seriesModel, dataIndex) { + seriesModel._edgeMap = seriesModel._edgeMap || {}; Review comment: By convention in echarts, if we mount something to an instance which does not belongs to this module, we use '__' prefix (rather than '_') to prevent from conflict with its private member. So here should better be `__edgeMap` ########## File path: src/chart/graph/GraphSeries.js ########## @@ -66,6 +67,8 @@ var GraphSeries = echarts.extendSeriesModel({ var self = this; if (nodes && edges) { + // auto curveness + initCurvenessList(edges, this); Review comment: The param `edges` is not needed in `initCurvenessList`. ########## File path: src/chart/graph/GraphSeries.js ########## @@ -66,6 +67,8 @@ var GraphSeries = echarts.extendSeriesModel({ var self = this; if (nodes && edges) { + // auto curveness + initCurvenessList(edges, this); return createGraphFromNodeEdge(nodes, edges, this, true, beforeLink).data; Review comment: I think `createEdgeMapForCurveness` can be called here: ```js var graph = createGraphFromNodeEdge(nodes, edges, this, true, beforeLink); zrUtil.each(graph.edges, function (edge) { createEdgeMapForCurveness(edge.node1, edge.node2, this, edge.dataIndex); }, this); ``` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
