SeriesDimensionDefine.js 2.9 KB

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