SeriesDimensionDefine.js 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. /*
  2. * Licensed to the Apache Software Foundation (ASF) under one
  3. * or more contributor license agreements. See the NOTICE file
  4. * distributed with this work for additional information
  5. * regarding copyright ownership. The ASF licenses this file
  6. * to you under the Apache License, Version 2.0 (the
  7. * "License"); you may not use this file except in compliance
  8. * with the License. You may obtain a copy of the License at
  9. *
  10. * http://www.apache.org/licenses/LICENSE-2.0
  11. *
  12. * Unless required by applicable law or agreed to in writing,
  13. * software distributed under the License is distributed on an
  14. * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15. * KIND, either express or implied. See the License for the
  16. * specific language governing permissions and limitations
  17. * under the License.
  18. */
  19. /**
  20. * AUTO-GENERATED FILE. DO NOT MODIFY.
  21. */
  22. /*
  23. * Licensed to the Apache Software Foundation (ASF) under one
  24. * or more contributor license agreements. See the NOTICE file
  25. * distributed with this work for additional information
  26. * regarding copyright ownership. The ASF licenses this file
  27. * to you under the Apache License, Version 2.0 (the
  28. * "License"); you may not use this file except in compliance
  29. * with the License. You may obtain a copy of the License at
  30. *
  31. * http://www.apache.org/licenses/LICENSE-2.0
  32. *
  33. * Unless required by applicable law or agreed to in writing,
  34. * software distributed under the License is distributed on an
  35. * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  36. * KIND, either express or implied. See the License for the
  37. * specific language governing permissions and limitations
  38. * under the License.
  39. */
  40. import * as zrUtil from 'zrender/lib/core/util.js';
  41. var SeriesDimensionDefine =
  42. /** @class */
  43. function () {
  44. /**
  45. * @param opt All of the fields will be shallow copied.
  46. */
  47. function SeriesDimensionDefine(opt) {
  48. /**
  49. * The format of `otherDims` is:
  50. * ```js
  51. * {
  52. * tooltip?: number
  53. * label?: number
  54. * itemName?: number
  55. * seriesName?: number
  56. * }
  57. * ```
  58. *
  59. * A `series.encode` can specified these fields:
  60. * ```js
  61. * encode: {
  62. * // "3, 1, 5" is the index of data dimension.
  63. * tooltip: [3, 1, 5],
  64. * label: [0, 3],
  65. * ...
  66. * }
  67. * ```
  68. * `otherDims` is the parse result of the `series.encode` above, like:
  69. * ```js
  70. * // Suppose the index of this data dimension is `3`.
  71. * this.otherDims = {
  72. * // `3` is at the index `0` of the `encode.tooltip`
  73. * tooltip: 0,
  74. * // `3` is at the index `1` of the `encode.label`
  75. * label: 1
  76. * };
  77. * ```
  78. *
  79. * This prop should never be `null`/`undefined` after initialized.
  80. */
  81. this.otherDims = {};
  82. if (opt != null) {
  83. zrUtil.extend(this, opt);
  84. }
  85. }
  86. return SeriesDimensionDefine;
  87. }();
  88. ;
  89. export default SeriesDimensionDefine;