config/Options/shape/line.ts

  1. /**
  2.  * Copyright (c) 2017 ~ present NAVER Corp.
  3.  * billboard.js project is licensed under the MIT license
  4.  */
  5. /**
  6.  * line config options
  7.  */
  8. export default {
  9. 	/**
  10. 	 * Set line options
  11. 	 * @name line
  12. 	 * @memberof Options
  13. 	 * @type {object}
  14. 	 * @property {object} line Line object
  15. 	 * @property {boolean} [line.connectNull=false] Set if null data point will be connected or not.<br>
  16. 	 *  If true set, the region of null data will be connected without any data point. If false set, the region of null data will not be connected and get empty.
  17. 	 * @property {Array}   [line.classes=undefined] If set, used to set a css class on each line.
  18. 	 * @property {boolean} [line.step.type=step] Change step type for step chart.<br>
  19. 	 * **Available values:**
  20. 	 * - step
  21. 	 * - step-before
  22. 	 * - step-after
  23. 	 * @property {boolean} [line.step.tooltipMatch=false] Set to `true` for `step-before` and `step-after` types to have cursor/tooltip match to hovered step's point instead of nearest point.
  24. 	 * @property {boolean|Array} [line.point=true] Set to false to not draw points on linecharts. Or pass an array of line ids to draw points for.
  25. 	 * @property {boolean} [line.zerobased=false] Set if min or max value will be 0 on line chart.
  26. 	 * @example
  27. 	 *  line: {
  28. 	 *      connectNull: true,
  29. 	 *      classes: [
  30. 	 *          "line-class1",
  31. 	 *          "line-class2"
  32. 	 *      ],
  33. 	 *      step: {
  34. 	 *          type: "step-after",
  35. 	 *
  36. 	 *          // to have cursor/tooltip match to hovered step's point instead of nearest point.
  37. 	 *          tooltipMatch: true
  38. 	 *      },
  39. 	 *
  40. 	 *      // hide all data points ('point.show=false' also has similar effect)
  41. 	 *      point: false,
  42. 	 *
  43. 	 *      // show data points for only indicated datas
  44. 	 *      point: [
  45. 	 *          "data1", "data3"
  46. 	 *      ],
  47. 	 *
  48. 	 *      zerobased: false
  49. 	 *  }
  50. 	 */
  51. 	line_connectNull: false,
  52. 	line_step_type: <"step" | "step-before" | "step-after">"step",
  53. 	line_step_tooltipMatch: false,
  54. 	line_zerobased: false,
  55. 	line_classes: <string[] | undefined>undefined,
  56. 	line_point: <string[] | boolean>true
  57. };