Plugin/tableview/Options.ts

  1. /**
  2.  * Copyright (c) 2021 ~ present NAVER Corp.
  3.  * billboard.js project is licensed under the MIT license
  4.  */
  5. /**
  6.  * TableView plugin option class
  7.  * @class TableviewOptions
  8.  * @param {Options} options TableView plugin options
  9.  * @augments Plugin
  10.  * @returns {TableviewOptions}
  11.  * @private
  12.  */
  13. export default class Options {
  14. 	constructor() {
  15. 		return {
  16. 			/**
  17. 			 * Set tableview holder selector.
  18. 			 * - **NOTE:** If not set, will append new holder element dynamically right after chart element.
  19. 			 * @name selector
  20. 			 * @memberof plugin-tableview
  21. 			 * @type {string}
  22. 			 * @default undefined
  23. 			 * @example
  24. 			 *   selector: "#table-holder"
  25. 			 */
  26. 			selector: undefined,
  28. 			/**
  29. 			 * Set category title text
  30. 			 * @name categoryTitle
  31. 			 * @memberof plugin-tableview
  32. 			 * @type {string}
  33. 			 * @default "Category"
  34. 			 * @example
  35. 			 *   categoryTitle: "#table-holder"
  36. 			 */
  37. 			categoryTitle: "Category",
  39. 			/**
  40. 			 * Set category text format function.
  41. 			 * @name categoryFormat
  42. 			 * @memberof plugin-tableview
  43. 			 * @type {Function}
  44. 			 * @returns {string}
  45. 			 * @default function(v) { // will return formatted value according x Axis type }}
  46. 			 * @example
  47. 			 *   categoryFormat: "#table-holder"
  48. 			 */
  49. 			categoryFormat: function(v: Date | number | string): string {
  50. 				let category = v;
  52. 				if (this.$$.axis.isCategorized()) {
  53. 					category = this.$$.categoryName(v);
  54. 				} else if (this.$$.axis.isTimeSeries()) {
  55. 					category = (v as Date).toLocaleDateString();
  56. 				}
  58. 				return category as string;
  59. 			},
  61. 			/**
  62. 			 * Set tableview holder class name.
  63. 			 * @name class
  64. 			 * @memberof plugin-tableview
  65. 			 * @type {string}
  66. 			 * @default undefined
  67. 			 * @example
  68. 			 *   class: "table-class-name"
  69. 			 */
  70. 			class: undefined,
  72. 			/**
  73. 			 * Set to apply default style(`.bb-tableview`) to tableview element.
  74. 			 * @name style
  75. 			 * @memberof plugin-tableview
  76. 			 * @type {boolean}
  77. 			 * @default true
  78. 			 * @example
  79. 			 *   style: false
  80. 			 */
  81. 			style: true,
  83. 			/**
  84. 			 * Set tableview title text.
  85. 			 * - **NOTE:** If set [title.text](https://naver.github.io/billboard.js/release/latest/doc/Options.html#.title), will be used when this option value is empty.
  86. 			 * @name title
  87. 			 * @memberof plugin-tableview
  88. 			 * @type {string}
  89. 			 * @default undefined
  90. 			 * @example
  91. 			 *   title: "Table Title Text"
  92. 			 */
  93. 			title: undefined,
  95. 			/**
  96. 			 * Update tableview from data visibility update(ex. legend toggle).
  97. 			 * @name updateOnToggle
  98. 			 * @memberof plugin-tableview
  99. 			 * @type {boolean}
  100. 			 * @default true
  101. 			 * @example
  102. 			 *   legendToggleUpdate: false
  103. 			 */
  104. 			updateOnToggle: true,
  106. 			/**
  107. 			 * Set how null value to be shown.
  108. 			 * @name nullString
  109. 			 * @memberof plugin-tableview
  110. 			 * @type {string}
  111. 			 * @default "-"
  112. 			 * @example
  113. 			 *   nullString: "N/A"
  114. 			 */
  115. 			nullString: "-"
  116. 		};
  117. 	}
  118. }