Chart/api/legend.ts

  1. /**
  2.  * Copyright (c) 2017 ~ present NAVER Corp.
  3.  * billboard.js project is licensed under the MIT license
  4.  */
  5. /**
  6.  * Define legend
  7.  * @ignore
  8.  */
  9. const legend = {
  10. 	/**
  11. 	 * Show legend for each target.
  12. 	 * - **NOTE:** Legend APIs aren't supported for `treemap` type.
  13. 	 * @function legend․show
  14. 	 * @instance
  15. 	 * @memberof Chart
  16. 	 * @param {string|Array} targetIds
  17. 	 * - If targetIds is given, specified target's legend will be shown.
  18. 	 * - If only one target is the candidate, String can be passed.
  19. 	 * - If no argument is given, all of target's legend will be shown.
  20. 	 * @example
  21. 	 * // Show legend for data1.
  22. 	 * chart.legend.show("data1");
  23. 	 *
  24. 	 * // Show legend for data1 and data2.
  25. 	 * chart.legend.show(["data1", "data2"]);
  26. 	 *
  27. 	 * // Show all legend.
  28. 	 * chart.legend.show();
  29. 	 */
  30. 	show: function(targetIds?: string | string[]): void {
  31. 		const $$ = this.internal;
  33. 		$$.showLegend($$.mapToTargetIds(targetIds));
  34. 		$$.updateAndRedraw({withLegend: true});
  35. 	},
  37. 	/**
  38. 	 * Hide legend for each target.
  39. 	 * @function legend․hide
  40. 	 * @instance
  41. 	 * @memberof Chart
  42. 	 * @param {string|Array} targetIds
  43. 	 * - If targetIds is given, specified target's legend will be hidden.
  44. 	 * - If only one target is the candidate, String can be passed.
  45. 	 * - If no argument is given, all of target's legend will be hidden.
  46. 	 * @example
  47. 	 * // Hide legend for data1.
  48. 	 * chart.legend.hide("data1");
  49. 	 *
  50. 	 * // Hide legend for data1 and data2.
  51. 	 * chart.legend.hide(["data1", "data2"]);
  52. 	 *
  53. 	 * // Hide all legend.
  54. 	 * chart.legend.hide();
  55. 	 */
  56. 	hide: function(targetIds?: string | string[]): void {
  57. 		const $$ = this.internal;
  59. 		$$.hideLegend($$.mapToTargetIds(targetIds));
  60. 		$$.updateAndRedraw({withLegend: true});
  61. 	}
  62. };
  64. export default {legend};