Plugin/textoverlap/Options.ts

  1. /**
  2.  * Copyright (c) 2017 ~ present NAVER Corp.
  3.  * billboard.js project is licensed under the MIT license
  4.  */
  5. /**
  6.  * TextOverlap plugin option class
  7.  * @class TextOverlapOptions
  8.  * @param {Options} options TextOverlap plugin options
  9.  * @augments Plugin
  10.  * @returns {TextOverlapOptions}
  11.  * @private
  12.  */
  13. export default class Options {
  14. 	constructor() {
  15. 		return {
  16. 			/**
  17. 			 * Selector string for target text nodes within chart element.
  18. 			 * - **NOTE:** If no value is given, defaults to data label text elements.
  19. 			 * @name selector
  20. 			 * @memberof plugin-textoverlap
  21. 			 * @type {string}
  22. 			 * @default undefined
  23. 			 * @example
  24. 			 *  // selector for data label text nodes
  25. 			 * selector: ".bb-texts text"
  26. 			 */
  27. 			selector: undefined,
  29. 			/**
  30. 			 * Extent of label overlap prevention.
  31. 			 * @name extent
  32. 			 * @memberof plugin-textoverlap
  33. 			 * @type {number}
  34. 			 * @default 1
  35. 			 * @example
  36. 			 * 	extent: 1
  37. 			 */
  38. 			extent: 1,
  40. 			/**
  41. 			 * Minimum area needed to show a data label.
  42. 			 * @name area
  43. 			 * @memberof plugin-textoverlap
  44. 			 * @type {number}
  45. 			 * @default 0
  46. 			 * @example
  47. 			 * 	area: 0
  48. 			 */
  49. 			area: 0
  50. 		};
  51. 	}
  52. }