cycleCache.js 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  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 { makeInner } from './model.js';
  41. var ecModelCacheInner = makeInner();
  42. /**
  43. * CAVEAT: Can only be called by `echarts.ts`
  44. */
  45. export function resetCachePerECPrepare(ecModel) {
  46. ecModelCacheInner(ecModel).prepare = {};
  47. }
  48. /**
  49. * CAVEAT: Can only be called by `echarts.ts`
  50. */
  51. export function resetCachePerECFullUpdate(ecModel) {
  52. ecModelCacheInner(ecModel).fullUpdate = {};
  53. }
  54. /**
  55. * The cache is auto cleared at the beginning of EC_PREPARE.
  56. * See also comments in EC_CYCLE.
  57. *
  58. * NOTICE:
  59. * - EC_PREPARE is not necessarily executed before each EC_FULL_UPDATE performing.
  60. * Typically, `setOption` trigger EC_PREPARE, but `dispatchAction` does not.
  61. * - It is not cleared in EC_PARTIAL_UPDATE and EC_PROGRESSIVE_CYCLE.
  62. *
  63. */
  64. export function getCachePerECPrepare(ecModel) {
  65. return ecModelCacheInner(ecModel).prepare;
  66. }
  67. /**
  68. * @usage
  69. * ```js
  70. * const cycleCache = makeInner<{
  71. * prop1: number;
  72. * prop2: string;
  73. * }, GlobalModelCachePerECFullUpdate>();
  74. * function doSomthing(ecModel: GlobalModel): void {
  75. * cycleCache(getCachePerECFullUpdate(ecModel)).prop1 = 123;
  76. * cycleCache(getCachePerECFullUpdate(ecModel)).prop2;
  77. * }
  78. * ```
  79. *
  80. * The cache is auto cleared at the beginning of EC_FULL_UPDATE.
  81. * See also comments in EC_CYCLE.
  82. *
  83. * NOTICE:
  84. * - It is not cleared in EC_PARTIAL_UPDATE and EC_PROGRESSIVE_CYCLE.
  85. * - The cache should NOT be written before EC_FULL_UPDATE started, such as:
  86. * - should NOT in `getTargetSeries` methods of data processors.
  87. * - should NOT in `init`/`mergeOption`/`optionUpdated`/`getData` methods of component/series models.
  88. * - See `getCachePerECPrepare` for details.
  89. */
  90. export function getCachePerECFullUpdate(ecModel) {
  91. return ecModelCacheInner(ecModel).fullUpdate;
  92. }