config/Options/common/boost.ts

  1. /**
  2.  * Copyright (c) 2017 ~ present NAVER Corp.
  3.  * billboard.js project is licensed under the MIT license
  4.  */
  5. /**
  6.  * boost config options
  7.  */
  8. export default {
  9. 	/**
  10. 	 * Set boost options
  11. 	 * @name boost
  12. 	 * @memberof Options
  13. 	 * @type {object}
  14. 	 * @property {object} boost boost object
  15. 	 * @property {boolean} [boost.useCssRule=false] Avoid setting inline styles for each shape elements.
  16. 	 * - **NOTE:**
  17. 	 *   - Will append <style> to the head tag and will add shpes' CSS rules dynamically.
  18. 	 *   - For now, covers colors related properties (fill, stroke, etc.) only.
  19. 	 * @property {boolean} [boost.useWorker=false] Use Web Worker as possible for processing.
  20. 	 * - **NOTE:**
  21. 	 *   - For now, only applies for data conversion at the initial time.
  22. 	 *   - As of Web Worker's async nature, handling chart instance synchrously is not recommended.
  23. 	 * @example
  24. 	 *  boost: {
  25. 	 *      useCssRule: true,
  26. 	 *      useWorker: false
  27. 	 *  }
  28. 	 */
  29. 	boost_useCssRule: false,
  30. 	boost_useWorker: false
  31. };