config/Options/shape/spline.ts

  1. /**
  2.  * Copyright (c) 2017 ~ present NAVER Corp.
  3.  * billboard.js project is licensed under the MIT license
  4.  */
  5. /**
  6.  * spline config options
  7.  */
  8. export default {
  9. 	/**
  10. 	 * Set spline options
  11. 	 * - **Available interpolation type values:**
  12. 	 *  - basis (d3.curveBasis)
  13. 	 *  - basis-closed (d3.curveBasisClosed)
  14. 	 *  - basis-open (d3.curveBasisOpen)
  15. 	 *  - bundle (d3.curveBundle)
  16. 	 *  - cardinal (d3.curveCardinal)
  17. 	 *  - cardinal-closed (d3.curveCardinalClosed)
  18. 	 *  - cardinal-open (d3.curveCardinalOpen)
  19. 	 *  - catmull-rom (d3.curveCatmullRom)
  20. 	 *  - catmull-rom-closed (d3.curveCatmullRomClosed)
  21. 	 *  - catmull-rom-open (d3.curveCatmullRomOpen)
  22. 	 *  - monotone-x (d3.curveMonotoneX)
  23. 	 *  - monotone-y (d3.curveMonotoneY)
  24. 	 *  - natural (d3.curveNatural)
  25. 	 *  - linear-closed (d3.curveLinearClosed)
  26. 	 *  - linear (d3.curveLinear)
  27. 	 *  - step (d3.curveStep)
  28. 	 *  - step-after (d3.curveStepAfter)
  29. 	 *  - step-before (d3.curveStepBefore)
  30. 	 * @name spline
  31. 	 * @memberof Options
  32. 	 * @type {object}
  33. 	 * @property {object} spline Spline object
  34. 	 * @property {object} spline.interpolation Spline interpolation object
  35. 	 * @property {string} [spline.interpolation.type="cardinal"] Interpolation type
  36. 	 * @see [Interpolation (d3 v4)](http://bl.ocks.org/emmasaunders/c25a147970def2b02d8c7c2719dc7502)
  37. 	 * @example
  38. 	 *  spline: {
  39. 	 *      interpolation: {
  40. 	 *          type: "cardinal"
  41. 	 *      }
  42. 	 *  }
  43. 	 */
  44. 	spline_interpolation_type: "cardinal"
  45. };