SeriesDimensionDefine.js 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  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 = /** @class */function () {
  42. /**
  43. * @param opt All of the fields will be shallow copied.
  44. */
  45. function SeriesDimensionDefine(opt) {
  46. /**
  47. * The format of `otherDims` is:
  48. * ```js
  49. * {
  50. * tooltip?: number
  51. * label?: number
  52. * itemName?: number
  53. * seriesName?: number
  54. * }
  55. * ```
  56. *
  57. * A `series.encode` can specified these fields:
  58. * ```js
  59. * encode: {
  60. * // "3, 1, 5" is the index of data dimension.
  61. * tooltip: [3, 1, 5],
  62. * label: [0, 3],
  63. * ...
  64. * }
  65. * ```
  66. * `otherDims` is the parse result of the `series.encode` above, like:
  67. * ```js
  68. * // Suppose the index of this data dimension is `3`.
  69. * this.otherDims = {
  70. * // `3` is at the index `0` of the `encode.tooltip`
  71. * tooltip: 0,
  72. * // `3` is at the index `1` of the `encode.label`
  73. * label: 1
  74. * };
  75. * ```
  76. *
  77. * This prop should never be `null`/`undefined` after initialized.
  78. */
  79. this.otherDims = {};
  80. if (opt != null) {
  81. zrUtil.extend(this, opt);
  82. }
  83. }
  84. return SeriesDimensionDefine;
  85. }();
  86. ;
  87. export default SeriesDimensionDefine;