Chart/api/x.ts

  1. /**
  2.  * Copyright (c) 2017 ~ present NAVER Corp.
  3.  * billboard.js project is licensed under the MIT license
  4.  */
  5. import {isArray, isObject} from "../../module/util";
  7. export default {
  8. 	/**
  9. 	 * Get and set x values for the chart.
  10. 	 * @function x
  11. 	 * @instance
  12. 	 * @memberof Chart
  13. 	 * @param {Array} x If x is given, x values of every target will be updated. If no argument is given, current x values will be returned as an Object whose keys are the target ids.
  14. 	 * @returns {object} xs
  15. 	 * @example
  16. 	 *  // Get current x values
  17. 	 *  chart.x();
  18. 	 *
  19. 	 *  // Update x values for all targets
  20. 	 *  chart.x([100, 200, 300, 400, ...]);
  21. 	 */
  22. 	x(x?: number[]): {[key: string]: number[]} {
  23. 		const $$ = this.internal;
  24. 		const {axis, data} = $$;
  25. 		const isCategorized = axis.isCustomX() && axis.isCategorized();
  27. 		if (isArray(x)) {
  28. 			if (isCategorized) {
  29. 				this.categories(x);
  30. 			} else {
  31. 				$$.updateTargetX(data.targets, x);
  33. 				$$.redraw({
  34. 					withUpdateOrgXDomain: true,
  35. 					withUpdateXDomain: true
  36. 				});
  37. 			}
  38. 		}
  40. 		return isCategorized ? this.categories() : data.xs;
  41. 	},
  43. 	/**
  44. 	 * Get and set x values for the chart.
  45. 	 * @function xs
  46. 	 * @instance
  47. 	 * @memberof Chart
  48. 	 * @param {Array} xs If xs is given, specified target's x values will be updated. If no argument is given, current x values will be returned as an Object whose keys are the target ids.
  49. 	 * @returns {object} xs
  50. 	 * @example
  51. 	 *  // Get current x values
  52. 	 *  chart.xs();
  53. 	 *
  54. 	 *  // Update x values for all targets
  55. 	 *  chart.xs({
  56. 	 *    data1: [10, 20, 30, 40, ...],
  57. 	 *    data2: [100, 200, 300, 400, ...]
  58. 	 *  });
  59. 	 */
  60. 	xs(xs?: {[key: string]: number[]}): {[key: string]: number[]} {
  61. 		const $$ = this.internal;
  63. 		if (isObject(xs)) {
  64. 			$$.updateTargetXs($$.data.targets, xs);
  66. 			$$.redraw({
  67. 				withUpdateOrgXDomain: true,
  68. 				withUpdateXDomain: true
  69. 			});
  70. 		}
  72. 		return $$.data.xs;
  73. 	}
  74. };