Source: axis/AxisDefs.js

  1. /**
  2.  * @module AxisDefs
  3.  * @description This module contains global axis members
  4.  */
  5. export {
  6.   AxisDefs,
  7.   AxisLocation
  8. };
  10. /**
  11.  * @enum
  12.  */
  13. var AxisDefs = {
  15.   X_AXIS_INDEX: 0,
  16.   Y_AXIS_INDEX: 1,
  18. }
  20. /**
  21.  * @enum {String}
  22.  * @readonly
  23.  */
  24. var AxisLocation = {
  25.   /**
  26.    * @member {String}
  27.    * @description X axis above the plot body
  28.    **/
  29.   X_AXIS_TOP : "xTop",
  30.   /**
  31.    * @member {String}
  32.    * @description Y axis to the left of the plot body
  33.    **/
  34.   Y_AXIS_LEFT : "yLeft",
  35.   /**
  36.    * @member {String}
  37.    * @description X axis below the plot body
  38.    **/
  39.   X_AXIS_BOTTOM : "xBottom",
  40.   /**
  41.    * @member {String}
  42.    * @description Y axis to the right of the plot body
  43.    **/
  44.   Y_AXIS_RIGHT : "yRight",
  45. }
  47. /**
  48.  * Test the validity of any axis location string
  49.  * @throws Error if the string does not match any value in {@link AxisLocation}
  50.  * @param  {String} location Location to test
  51.  * @return void
  52.  */
  53. export function testAxisLocation(location) {
  54.   const values = Object.values(AxisLocation);
  55.   if (values.indexOf(location) === -1) {
  56.     throw Error(`Unrecognized axis location ${location}. Choose from ${values.join(", ")}`);
  57.   }
  58. }