Blame view

node_modules/echarts/src/coord/ICoordinateSystem 2.79 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
  /*
  * 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.
  */
  
  /**
   * Coordinate System Interface:
   *
   *
   * Class members:
   *
   *  + dimensions {Array.<strign>}: mandatory
   *
   *
   * Instance members:
   *
   *  + dimensions {Array.<strign>}: mandatory
   *
   *  + model {module:echarts/model/Model}: mandatory
   *
   *  + create: mandatory
   *     @param {module:echarts/model/Global} ecModel
   *     @param {module:echarts/ExtensionAPI} api
   *     @return {Object} coordinate system instance
   *
   *  + update: mandatory
   *     @param {module:echarts/model/Global} ecModel
   *     @param {module:echarts/ExtensionAPI} api
   *
   *  + getAxis {Function}: mandatory
   *      @param {string} dim
   *      @return {module:echarts/coord/Axis}
   *
   *  + getAxes: {Function}: optional
   *      @return {Array.<module:echarts/coord/Axis>}
   *
   *  + axisPointerEnabled {boolean}
   *
   *  + dataToPoint {Function}: mandatory
   *      @param {*|Array.<*>} data
   *      @param {*} Defined by the coordinate system itself
   *      @param {Array.<*>} out
   *      @return {Array.<number>} point Point in global pixel coordinate system.
   *
   *  + pointToData {Function}: mandatory
   *      @param {Array.<number>} point Point in global pixel coordinate system.
   *      @param {*} Defined by the coordinate system itself
   *      @param {Array.<*>} out
   *      @return {*|Array.<*>} data
   *
   *  + containPoint {Function}: mandatory
   *      @param {Array.<number>} point Point in global pixel coordinate system.
   *      @return {boolean}
   *
   *  + getDimensionsInfo {Function}: optional
   *      @return {Array.<string|Object>} dimensionsInfo
   *              Like [{name: ..., type: ...}, 'xxx', ...]
   *
   *  + convertToPixel:
   *  + convertFromPixel:
   *        These two methods is also responsible for determine whether this
   *        coodinate system is applicable to the given `finder`.
   *        Each coordinate system will be tried, util one returns none
   *        null/undefined value.
   *        @param {module:echarts/model/Global} ecModel
   *        @param {Object} finder
   *        @param {Array|number} value
   *        @return {Array|number} convert result.
   *
   *
   */