billboard.js/src/Chart/api/category.ts

Re-usable easy interface JavaScript chart library, based on D3 v4+

/**
 * Copyright (c) 2017 ~ present NAVER Corp.
 * billboard.js project is licensed under the MIT license
 */
import {isEmpty} from "../../module/util";

export default {
	/**
	 * Set specified category name on category axis.
	 * @function category
	 * @instance
	 * @memberof Chart
	 * @param {number} i index of category to be changed
	 * @param {string} category category value to be changed
	 * @returns {string}
	 * @example
	 * chart.category(2, "Category 3");
	 */
	category(i: number, category: string): string {
		const $$ = this.internal;
		const {config} = $$;

		if (arguments.length > 1) {
			config.axis_x_categories[i] = category;
			$$.redraw();
		}

		return config.axis_x_categories[i];
	},

	/**
	 * Set or get category names on category axis.
	 * @function categories
	 * @instance
	 * @memberof Chart
	 * @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.
	 * @returns {Array}
	 * @example
	 * chart.categories([
	 *      "Category 1", "Category 2", ...
	 * ]);
	 */
	categories(categories?: string[]): string[] {
		const $$ = this.internal;
		const {config} = $$;

		if (!categories || !Array.isArray(categories)) {
			const cat = config.axis_x_categories;

			return isEmpty(cat) ? Object.values($$.data.xs)[0] : cat;
		}

		config.axis_x_categories = categories;
		$$.redraw();

		return config.axis_x_categories;
	}
};