Chart/api/category.ts

  1. /**
  2.  * Copyright (c) 2017 ~ present NAVER Corp.
  3.  * billboard.js project is licensed under the MIT license
  4.  */
  5. import {isEmpty} from "../../module/util";
  7. export default {
  8. 	/**
  9. 	 * Set specified category name on category axis.
  10. 	 * @function category
  11. 	 * @instance
  12. 	 * @memberof Chart
  13. 	 * @param {number} i index of category to be changed
  14. 	 * @param {string} category category value to be changed
  15. 	 * @returns {string}
  16. 	 * @example
  17. 	 * chart.category(2, "Category 3");
  18. 	 */
  19. 	category(i: number, category: string): string {
  20. 		const $$ = this.internal;
  21. 		const {config} = $$;
  23. 		if (arguments.length > 1) {
  24. 			config.axis_x_categories[i] = category;
  25. 			$$.redraw();
  26. 		}
  28. 		return config.axis_x_categories[i];
  29. 	},
  31. 	/**
  32. 	 * Set or get category names on category axis.
  33. 	 * @function categories
  34. 	 * @instance
  35. 	 * @memberof Chart
  36. 	 * @param {Array} categories This must be an array that includes category names in string. If category names are included in the date by data.x option, this is not required.
  37. 	 * @returns {Array}
  38. 	 * @example
  39. 	 * chart.categories([
  40. 	 *      "Category 1", "Category 2", ...
  41. 	 * ]);
  42. 	 */
  43. 	categories(categories?: string[]): string[] {
  44. 		const $$ = this.internal;
  45. 		const {config} = $$;
  47. 		if (!categories || !Array.isArray(categories)) {
  48. 			const cat = config.axis_x_categories;
  50. 			return isEmpty(cat) ? Object.values($$.data.xs)[0] : cat;
  51. 		}
  53. 		config.axis_x_categories = categories;
  54. 		$$.redraw();
  56. 		return config.axis_x_categories;
  57. 	}
  58. };