axisSnippets.js 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  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 { calcBandWidth } from '../../coord/axisBand.js';
  41. import { AXIS_STAT_KEY_DELIMITER } from '../../coord/axisStatistics.js';
  42. import { registerMetricImplLiPosMinGap } from '../../coord/axisStatisticsMetricsImpl.js';
  43. import { isOrdinalScale } from '../../scale/helper.js';
  44. import { isNullableNumberFinite } from '../../util/number.js';
  45. /**
  46. * Require `requireAxisStatistics`.
  47. *
  48. * Simply expand `Scale` extent by half bandWidth.
  49. * Do nothing if an `OrdinalScale` has `boundaryGap: true`.
  50. */
  51. export function createBandWidthBasedAxisContainShapeHandler(axisStatKey) {
  52. // [AXIS_CONTAIN_SHAPE_COMMON_STRATEGY]:
  53. // The calculation below is based on a proportion mapping
  54. // from `[barsBoundVal[0], barsBoundVal[1]]` to `[minValNew, maxValNew]`:
  55. // |------|------------------------------|---|
  56. // barsBoundVal[0] minValOld maxValOld barsBoundVal[1]
  57. // |----|----------------------|--|
  58. // minValNew minValOld maxValOld maxValNew
  59. // (Note: `|---|` above represents "pixels" rather than "data".)
  60. return function (axis, ecModel) {
  61. var bandWidthResult = calcBandWidth(axis, {
  62. fromStat: {
  63. key: axisStatKey
  64. }
  65. });
  66. if (isNullableNumberFinite(bandWidthResult.w2)) {
  67. return [-bandWidthResult.w2 / 2, bandWidthResult.w2 / 2];
  68. }
  69. };
  70. }
  71. /**
  72. * A pre-built `makeAxisStatKey`.
  73. * See `makeAxisStatKey2`. Use two functions rather than a optional parameter to impose checking.
  74. */
  75. export function makeAxisStatKey(seriesType) {
  76. return seriesType + AXIS_STAT_KEY_DELIMITER;
  77. }
  78. export function makeAxisStatKey2(seriesType, coordSysType) {
  79. return seriesType + AXIS_STAT_KEY_DELIMITER + coordSysType;
  80. }
  81. /**
  82. * A pre-built `getMetrics`.
  83. */
  84. export function createMetricsNonOrdinalLinearPositiveMinGap(axis) {
  85. registerMetricImplLiPosMinGap();
  86. return {
  87. // non-category scale do not use `liPosMinGap` to calculate `bandWidth`.
  88. liPosMinGap: !isOrdinalScale(axis.scale)
  89. };
  90. }
  91. ;