config/Options/shape/scatter.ts

  1. /**
  2.  * Copyright (c) 2017 ~ present NAVER Corp.
  3.  * billboard.js project is licensed under the MIT license
  4.  */
  5. /**
  6.  * scatter config options
  7.  */
  8. export default {
  9. 	/**
  10. 	 * Set scatter options
  11. 	 * @name scatter
  12. 	 * @memberof Options
  13. 	 * @type {object}
  14. 	 * @property {object} [scatter] scatter object
  15. 	 * @property {boolean} [scatter.zerobased=false] Set if min or max value will be 0 on scatter chart.
  16. 	 * @example
  17. 	 *  scatter: {
  18. 	 *      connectNull: true,
  19. 	 *      step: {
  20. 	 *          type: "step-after"
  21. 	 *      },
  22. 	 *
  23. 	 *      // hide all data points ('point.show=false' also has similar effect)
  24. 	 *      point: false,
  25. 	 *
  26. 	 *      // show data points for only indicated datas
  27. 	 *      point: [
  28. 	 *          "data1", "data3"
  29. 	 *      ],
  30. 	 *
  31. 	 *      zerobased: false
  32. 	 *  }
  33. 	 */
  34. 	scatter_zerobased: false
  35. };