core.ts

  1. /**
  2.  * Copyright (c) 2017 ~ present NAVER Corp.
  3.  * billboard project is licensed under the MIT license
  4.  */
  5. import Chart from "./Chart/Chart";
  6. import {isObject, mergeObj} from "./module/util";
  8. let defaults = Object.create(null);
  10. /**
  11.  * @namespace bb
  12.  * @version __VERSION__
  13.  */
  14. const bb = {
  15. 	/**
  16. 	 * Version information
  17. 	 * @property {string} version version
  18. 	 * @example
  19. 	 *    bb.version;  // "1.0.0"
  20. 	 * @memberof bb
  21. 	 */
  22. 	version: "__VERSION__",
  24. 	/**
  25. 	 * Generate chart
  26. 	 * - **NOTE:** Bear in mind for the possiblity of ***throwing an error***, during the generation when:
  27. 	 *   - Unused option value is given.
  28. 	 *     - ex) For `data.type="pie"` option, setting 'axis' option can cause unexpected generation error.
  29. 	 *   - Insufficient value is given for certain option used.
  30. 	 *     - ex) `data: { x: "x", columns: [["x"], ["data1", 30, 200, 100]] }`
  31. 	 * @param {Options} config chart options
  32. 	 * @memberof bb
  33. 	 * @returns {Chart}
  34. 	 * @see {@link Options} for different generation options
  35. 	 * @see {@link Chart} for different methods API
  36. 	 * @example
  37. 	 *  <!-- chart holder -->
  38. 	 * <div id="LineChart"></div>
  39. 	 * @example
  40. 	 *  // Generate chart with options
  41. 	 *  var chart = bb.generate({
  42. 	 *      "bindto": "#LineChart"
  43. 	 *      "data": {
  44. 	 *          "columns": [
  45. 	 *              ["data1", 30, 200, 100, 400, 150, 250],
  46. 	 *              ["data2", 50, 20, 10, 40, 15, 25]
  47. 	 *           ],
  48. 	 *          "type": "line"
  49. 	 *      }
  50. 	 *  });
  51. 	 *
  52. 	 *  // call some API
  53. 	 *  // ex) get the data of 'data1'
  54. 	 *  chart.data("data1");
  55. 	 * @example
  56. 	 * // Generate chart by importing ESM
  57. 	 * // Import types to be used only, where this will make smaller bundle size.
  58. 	 * import bb, {
  59. 	 *   area,
  60. 	 *   areaLineRange,
  61. 	 *   areaSpline,
  62. 	 *   areaSplineRange,
  63. 	 *   areaStep,
  64. 	 *   bar,
  65. 	 *   bubble,
  66. 	 *   donut,
  67. 	 *   gauge,
  68. 	 *   line,
  69. 	 *   pie,
  70. 	 *   polar,
  71. 	 *   radar,
  72. 	 *   scatter,
  73. 	 *   spline,
  74. 	 *   step
  75. 	 * }
  76. 	 *
  77. 	 * bb.generate({
  78. 	 *      "bindto": "#LineChart"
  79. 	 *      "data": {
  80. 	 *          "columns": [
  81. 	 *              ["data1", 30, 200, 100, 400, 150, 250],
  82. 	 *              ["data2", 50, 20, 10, 40, 15, 25]
  83. 	 *           ]
  84. 	 *      },
  85. 	 *      type: line(),
  86. 	 *
  87. 	 *      // or
  88. 	 *      types: {
  89. 	 *        data1: bar(),
  90. 	 *        data2: step()
  91. 	 *      }
  92. 	 * });
  93. 	 */
  94. 	generate(config) {
  95. 		const options = mergeObj(Object.create(null), defaults, config);
  96. 		const inst = new Chart(options);
  98. 		inst.internal.charts = this.instance;
  99. 		this.instance.push(inst);
  101. 		return inst;
  102. 	},
  104. 	/**
  105. 	 * Set or get global default options.
  106. 	 * - **NOTE:**
  107. 	 *   - The options values settings are valid within page context only.
  108. 	 *   - If is called multiple times, will override the last value.
  109. 	 * @param {Options} options chart options
  110. 	 * @memberof bb
  111. 	 * @returns {Options}
  112. 	 * @see {@link Options}
  113. 	 * @example
  114. 	 * // Set same option value as for `.generate()`
  115. 	 * bb.defaults({
  116. 	 *   data: {
  117. 	 *     type: "bar"
  118. 	 *   }
  119. 	 * });
  120. 	 *
  121. 	 * bb.defaults();  // {data:{type: "bar"}}
  122. 	 *
  123. 	 * // data.type defaults to 'bar'
  124. 	 * var chart = bb.generate({ ... });
  125. 	 */
  126. 	defaults(options?) {
  127. 		if (isObject(options)) {
  128. 			defaults = options;
  129. 		}
  131. 		return defaults;
  132. 	},
  134. 	/**
  135. 	 * An array containing instance created
  136. 	 * @property {Array} instance instance array
  137. 	 * @example
  138. 	 *  // generate charts
  139. 	 *  var chart1 = bb.generate(...);
  140. 	 *  var chart2 = bb.generate(...);
  141. 	 *
  142. 	 *  bb.instance;  // [ chart1, chart2, ... ]
  143. 	 * @memberof bb
  144. 	 */
  145. 	instance: [],
  147. 	/**
  148. 	 * Namespace for plugins
  149. 	 * @property {object} plugin plugin namespace
  150. 	 * @example
  151. 	 *  // Stanford diagram plugin
  152. 	 *  bb.plugin.stanford;
  153. 	 * @memberof bb
  154. 	 */
  155. 	plugin: {}
  156. };
  158. export {bb, bb as default};