config/Options/shape/funnel.ts

  1. /**
  2.  * Copyright (c) 2017 ~ present NAVER Corp.
  3.  * billboard.js project is licensed under the MIT license
  4.  */
  5. /**
  6.  * funnel config options
  7.  */
  8. export default {
  9. 	/**
  10. 	 * Set funnel options
  11. 	 * @name funnel
  12. 	 * @memberof Options
  13. 	 * @type {object}
  14. 	 * @property {object} funnel Funnel object
  15. 	 * @property {number} [funnel.neck.width=0] Set funnel neck width.
  16. 	 * @property {number} [funnel.neck.height=0] Set funnel neck height.
  17. 	 * @property {number} [funnel.neck.width.ratio] Set funnel neck width in ratio.
  18. 	 * @property {number} [funnel.neck.height.ratio] Set funnel neck height in ratio.
  19. 	 * @see [Demo](https://naver.github.io/billboard.js/demo/#Chart.PolarChart)
  20. 	 * @example
  21. 	 *  funnel: {
  22. 	 *      neck: {
  23. 	 *          width: 200,
  24. 	 *          height: 100,
  25. 	 *
  26. 	 *          // or specify as ratio value (relative to the chart size)
  27. 	 *          width: {
  28. 	 *            ratio: 0.5
  29. 	 *          },
  30. 	 *          height: {
  31. 	 *            ratio: 0.5
  32. 	 *          }
  33. 	 *      }
  34. 	 *  }
  35. 	 */
  36. 	funnel_neck_width: <number | {ratio: number}>0,
  37. 	funnel_neck_height: <number | {ratio: number}>0
  38. };