12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
/** * Copyright (c) 2017 ~ present NAVER Corp. * billboard.js project is licensed under the MIT license */import {extend} from "../../module/util";
type GridsParam = {value?: number, class?: string, text?: string}[];
/** * Update x grid lines. * @function xgrids * @instance * @memberof Chart * @param {Array} grids X grid lines will be replaced with this argument. The format of this argument is the same as grid.x.lines. * @returns {object} * @example *  // Show 2 x grid lines * chart.xgrids([ *    {value: 1, text: "Label 1"}, *    {value: 4, text: "Label 4"} * ]); * // --> Returns: [{value: 1, text: "Label 1"}, {value: 4, text: "Label 4"}] */function xgrids(grids: GridsParam): GridsParam {	const $$ = this.internal;	const {config} = $$;
	if (!grids) {		return config.grid_x_lines;	}
	config.grid_x_lines = grids;	$$.redrawWithoutRescale();
	return config.grid_x_lines;}
extend(xgrids, {	/**	 * Add x grid lines.<br>	 * This API adds new x grid lines instead of replacing like xgrids.	 * @function xgrids․add	 * @instance	 * @memberof Chart	 * @param {Array|object} grids New x grid lines will be added. The format of this argument is the same as grid.x.lines and it's possible to give an Object if only one line will be added.	 * @returns {object}	 * @example	 *  // Add a new x grid line	 * chart.xgrids.add(	 *   {value: 4, text: "Label 4"}	 * );	 *	 * // Add new x grid lines	 * chart.xgrids.add([	 *   {value: 2, text: "Label 2"},	 *   {value: 4, text: "Label 4"}	 * ]);	 */	add: function(grids: GridsParam): GridsParam {		return this.xgrids(			this.internal.config.grid_x_lines				.concat(grids || [])		);	},
	/**	 * Remove x grid lines.<br>	 * This API removes x grid lines.	 * @function xgrids․remove	 * @instance	 * @memberof Chart	 * @param {object} params This argument should include value or class. If value is given, the x grid lines that have specified x value will be removed. If class is given, the x grid lines that have specified class will be removed. If args is not given, all of x grid lines will be removed.	 * @example	 * // x grid line on x = 2 will be removed	 * chart.xgrids.remove({value: 2});	 *	 * // x grid lines that have 'grid-A' will be removed	 * chart.xgrids.remove({	 *   class: "grid-A"	 * });	 *	 * // all of x grid lines will be removed	 * chart.xgrids.remove();	 */	remove: function(params?: GridsParam): void { // TODO: multiple		this.internal.removeGridLines(params, true);	}});
export default {xgrids};