DM-6282 merge external chart API, pull request #170

DM-6282 Chart API: external API and the API for histogram

Author: tgoldina

.eslintrc

@@ -4,15 +4,15 @@
     "jsdoc"
 
    ],
- /* "settings": {
-    "jsdoc": {
-      "tagNamePreference": {
-        "param": "param",
-        "returns": ["returns", "return"],
-        "description":"desc"
-      }
-    }
-  },*/
+  /* "settings": {
+     "jsdoc": {
+       "tagNamePreference": {
+         "param": "param",
+         "returns": ["returns", "return"],
+         "description":"desc"
+       }
+     }
+   },*/
 
   "env": {
     "es6": true,
@@ -78,14 +78,15 @@
     "space-infix-ops": 0,
     "quotes": [2, "single", "avoid-escape"],
     "eqeqeq": 1,
+    //"valid-jsdoc": [2, { "requireReturn" : false, "requireParamDescription": false, "requireReturnDescription": false}]
     //jsdoc rules
-    "jsdoc/check-param-names": 0,
+    "jsdoc/check-param-names": 2,
     "jsdoc/check-tag-names": 0,
-    "jsdoc/check-types": 1,
+    "jsdoc/check-types": 0,
     "jsdoc/newline-after-description": 0,
     "jsdoc/require-description-complete-sentence": 0,
     "jsdoc/require-hyphen-before-param-description": 0,
-    "jsdoc/require-param": 0,
+    "jsdoc/require-param": 2,
     "jsdoc/require-param-description": 0,
     "jsdoc/require-param-type": 0,
     "jsdoc/require-returns-description": 0,

src/firefly/html/demo/ffapi-highlevel-test.html

@@ -44,8 +44,20 @@
     <div id="tables-2" style="display: inline-block; width: 550px; height: 300px; margin: 10px; background-color: white"></div>
     <div id="tables-1" style="display: inline-block; width: 550px; height: 300px; margin: 10px; background-color: white; position: absolute"></div>
 </div>
-<div id="xyPlot1" style="display: inline-block; width: 550px; height: 300px; margin: 10px; background-color: white"></div>
-<div id="xyPlot2" style="display: inline-block; width: 550px; height: 300px; margin: 10px; background-color: white; position: absolute"></div>
+<div>XYPlot from API calls:
+    <a href='javascript:firefly.getViewer().showXYPlot(xyPlotOpsReq3)'>Show XY Plot</a>
+</div>
+<div>
+    <div id="xyPlot1" style="display: inline-block; width: 550px; height: 300px; margin: 10px; background-color: white"></div>
+    <div id="xyPlot2" style="display: inline-block; width: 550px; height: 300px; margin: 10px; background-color: white; position: absolute"></div>
+</div>
+<div>XYPlot from API calls:
+    <a href='javascript:firefly.getViewer().showHistogram(histogramOpsReq3)'>Show Histogram</a>
+</div>
+<div>
+    <div id="histogram1" style="display: inline-block; width: 550px; height: 300px; margin: 10px; background-color: white"></div>
+    <div id="histogram2" style="display: inline-block; width: 550px; height: 300px; margin: 10px; background-color: white; position: absolute"></div>
+</div>
 <div>Tables from deprecated API calls:</div>
 <div>
     <div id="oldSelectable" style="display: inline-block; width: 550px; height: 300px; margin: 10px; background-color: white"></div>
@@ -200,13 +212,19 @@
                         META_INFO: {CENTER_COLUMN: 'crval1;crval2;EQJ2000'}
                     });
 
+
             firefly.showTable('tables-1', tblReq1);
             firefly.showTable('tables-1', tblReq3);
             firefly.showTable('tables-2', tblReq2, {removable: false, showUnits: true, showFilters: true});
             //-----------------  CHART DEMO ------------------------//
             //--- using QUERY_ID: 'upload' does not work getActiveTableId('upload') returns undefined ---//
-            firefly.addXYPlot('xyPlot1', {tbl_id: tblReq2.tbl_id, xCol: 'ra', yCol: 'dec', help_id: 'visualization.xyplotViewer'});
-            firefly.addXYPlot('xyPlot2', {tbl_id: tblReq2.tbl_id, xCol: 'w1mpro+w4mpro', yCol: 'w2mpro'});
+            xyPlotOpsReq3 = {source: 'http://web.ipac.caltech.edu/staff/roby/demo/WiseDemoTable.tbl', xCol: 'ra1', yCol: 'dec1'};
+            firefly.showXYPlot('xyPlot1', {tbl_id: tblReq2.tbl_id, xCol: 'ra', yCol: 'dec', help_id: 'visualization.xyplotViewer'});
+            firefly.showXYPlot('xyPlot2', {tbl_id: tblReq2.tbl_id, xCol: 'w1mpro+w4mpro', yCol: 'w2mpro'});
+            histogramOpsReq3 = {source: 'http://web.ipac.caltech.edu/staff/roby/demo/WiseDemoTable.tbl', col: 'modeint', xOptions: 'log'};
+            firefly.showHistogram('histogram1', {tbl_id: tblReq2.tbl_id, col: 'w1mpro'});
+            firefly.showHistogram('histogram2', {tbl_id: tblReq2.tbl_id, col: 'w2mpro+w3mpro', falsePositiveRate: 0.05});
+
 
             //-----< old table api ------//
             var tblParams = {
@@ -427,6 +445,6 @@
 </script>
 
 
-<script  type="text/javascript" src="../firefly_loader.js"></script>
+<script  type="text/javascript" src="http://localhost:8080/firefly/firefly_loader.js"></script>
 
 

src/firefly/js/api/ApiBuild.js

@@ -49,21 +49,51 @@ import {buildViewerApi} from './ApiViewer.js';
 import './ApiStyle.css';
 
 
-/**@namespace firefly*/
+/**
+ * High-level API.
+ * @public
+ * @namespace firefly
+ */
 
-/**@namespace firefly.action*/
+/**
+ * Actions and action dispatchers.
+ * @public
+ * @namespace firefly.action
+ */
 
-/**@namespace firefly.ui*/
+/**
+ * React components.
+ * @public
+ * @namespace firefly.ui
+ */
 
-/**@namespace firefly.util*/
+/**
+ * Utilities.
+ * @public
+ * @namespace firefly.util
+ */
 
-/** @namespace firefly.util.chart*/
+/**
+ * Chart utilities.
+ * @public
+ * @namespace firefly.util.chart
+ */
 
-/** @namespace firefly.util.data*/
+/**
+ * @namespace firefly.util.data
+ */
 
-/**@namespace firefly.util.image*/
+/**
+ * Image utilities.
+ * @public
+ * @namespace firefly.util.image
+ */
 
-/** @namespace firefly.util.table*/
+/**
+ * Table utilities.
+ * @public
+ * @namespace firefly.util.table
+ */
 
 
 /**
@@ -168,7 +198,7 @@ export function buildLowlevelAPI() {
 
 /**
  * pull all the dispatch functions out of the object
- * @param obj
+ * @param {Object} obj
  * @return {*}
  * @ignore
  */
@@ -182,8 +212,8 @@ function findDispatch(obj) {
 
 /**
  * pull all the action type constants out of the object
- * @param obj
- * @param prefix
+ * @param {Object} obj
+ * @param {string} prefix
  * @return {*}
  * @ignore
  */