forerunnerdb

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: Highchart</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Class: Highchart</h1> <section> <header> <h2> Highchart </h2> </header> <article> <div class="container-overview"> <h4 class="name" id="Highchart"><span class="type-signature"></span>new Highchart<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> The constructor. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line17">line 17</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".areaChart"><span class="type-signature">(static) </span>areaChart<span class="signature">(selector, seriesField, keyField, valField, options)</span><span class="type-signature"></span></h4> <div class="description"> Chart via defined params and an options object. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>selector</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">jQuery</span> </td> <td class="description last">The element to render the chart to.</td> </tr> <tr> <td class="name"><code>seriesField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The name of the series to plot.</td> </tr> <tr> <td class="name"><code>keyField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The field to use as the data key.</td> </tr> <tr> <td class="name"><code>valField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The field to use as the data value.</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The options object.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line436">line 436</a> </li></ul></dd> </dl> <h4 class="name" id=".areaChart"><span class="type-signature">(static) </span>areaChart<span class="signature">(options)</span><span class="type-signature"> → {*}</span></h4> <div class="description"> Chart via options object. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The options object.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line414">line 414</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">*</span> </dd> </dl> <h4 class="name" id=".barChart"><span class="type-signature">(static) </span>barChart<span class="signature">(selector, seriesField, keyField, valField, options)</span><span class="type-signature"></span></h4> <div class="description"> Chart via defined params and an options object. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>selector</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">jQuery</span> </td> <td class="description last">The element to render the chart to.</td> </tr> <tr> <td class="name"><code>seriesField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The name of the series to plot.</td> </tr> <tr> <td class="name"><code>keyField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The field to use as the data key.</td> </tr> <tr> <td class="name"><code>valField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The field to use as the data value.</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The options object.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line536">line 536</a> </li></ul></dd> </dl> <h4 class="name" id=".barChart"><span class="type-signature">(static) </span>barChart<span class="signature">(options)</span><span class="type-signature"> → {*}</span></h4> <div class="description"> Chart via options object. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The options object.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line514">line 514</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">*</span> </dd> </dl> <h4 class="name" id=".columnChart"><span class="type-signature">(static) </span>columnChart<span class="signature">(selector, seriesField, keyField, valField, options)</span><span class="type-signature"></span></h4> <div class="description"> Chart via defined params and an options object. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>selector</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">jQuery</span> </td> <td class="description last">The element to render the chart to.</td> </tr> <tr> <td class="name"><code>seriesField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The name of the series to plot.</td> </tr> <tr> <td class="name"><code>keyField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The field to use as the data key.</td> </tr> <tr> <td class="name"><code>valField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The field to use as the data value.</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The options object.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line486">line 486</a> </li></ul></dd> </dl> <h4 class="name" id=".columnChart"><span class="type-signature">(static) </span>columnChart<span class="signature">(options)</span><span class="type-signature"> → {*}</span></h4> <div class="description"> Chart via options object. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The options object.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line464">line 464</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">*</span> </dd> </dl> <h4 class="name" id=".lineChart"><span class="type-signature">(static) </span>lineChart<span class="signature">(options)</span><span class="type-signature"> → {*}</span></h4> <div class="description"> Chart via options object. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The options object.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line364">line 364</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">*</span> </dd> </dl> <h4 class="name" id=".lineChart"><span class="type-signature">(static) </span>lineChart<span class="signature">(selector, seriesField, keyField, valField, options)</span><span class="type-signature"></span></h4> <div class="description"> Chart via defined params and an options object. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>selector</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">jQuery</span> </td> <td class="description last">The element to render the chart to.</td> </tr> <tr> <td class="name"><code>seriesField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The name of the series to plot.</td> </tr> <tr> <td class="name"><code>keyField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The field to use as the data key.</td> </tr> <tr> <td class="name"><code>valField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The field to use as the data value.</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The options object.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line386">line 386</a> </li></ul></dd> </dl> <h4 class="name" id=".pieChart"><span class="type-signature">(static) </span>pieChart<span class="signature">(selector, keyField, valField, seriesName, options)</span><span class="type-signature"></span></h4> <div class="description"> Chart via defined params and an options object. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>selector</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">jQuery</span> </td> <td class="description last">The element to render the chart to.</td> </tr> <tr> <td class="name"><code>keyField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The field to use as the data key.</td> </tr> <tr> <td class="name"><code>valField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The field to use as the data value.</td> </tr> <tr> <td class="name"><code>seriesName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The name of the series to display on the chart.</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The options object.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line336">line 336</a> </li></ul></dd> </dl> <h4 class="name" id=".pieChart"><span class="type-signature">(static) </span>pieChart<span class="signature">(options)</span><span class="type-signature"> → {*}</span></h4> <div class="description"> Chart via options object. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The options object.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line314">line 314</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">*</span> </dd> </dl> <h4 class="name" id=".stackedBarChart"><span class="type-signature">(static) </span>stackedBarChart<span class="signature">(selector, seriesField, keyField, valField, options)</span><span class="type-signature"></span></h4> <div class="description"> Chart via defined params and an options object. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>selector</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">jQuery</span> </td> <td class="description last">The element to render the chart to.</td> </tr> <tr> <td class="name"><code>seriesField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The name of the series to plot.</td> </tr> <tr> <td class="name"><code>keyField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The field to use as the data key.</td> </tr> <tr> <td class="name"><code>valField</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The field to use as the data value.</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The options object.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line590">line 590</a> </li></ul></dd> </dl> <h4 class="name" id=".stackedBarChart"><span class="type-signature">(static) </span>stackedBarChart<span class="signature">(options)</span><span class="type-signature"> → {*}</span></h4> <div class="description"> Chart via options object. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">The options object.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line564">line 564</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">*</span> </dd> </dl> <h4 class="name" id="_changeListener"><span class="type-signature">(private) </span>_changeListener<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Handles changes to the collection data that the chart is reading from and then updates the data in the chart display. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line209">line 209</a> </li></ul></dd> </dl> <h4 class="name" id="_hookEvents"><span class="type-signature">(private) </span>_hookEvents<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Hook the events the chart needs to know about from the internal collection. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line195">line 195</a> </li></ul></dd> </dl> <h4 class="name" id="drop"><span class="type-signature"></span>drop<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4> <div class="description"> Destroys the chart and all internal references. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line274">line 274</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Boolean</span> </dd> </dl> <h4 class="name" id="pieDataFromCollectionData"><span class="type-signature"></span>pieDataFromCollectionData<span class="signature">(data, keyField, valField)</span><span class="type-signature"> → {Array}</span></h4> <div class="description"> Generate pie-chart series data from the given collection data array. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>data</code></td> <td class="type"> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>keyField</code></td> <td class="type"> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>valField</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line126">line 126</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Array</span> </dd> </dl> <h4 class="name" id="seriesDataFromCollectionData"><span class="type-signature"></span>seriesDataFromCollectionData<span class="signature">(seriesField, keyField, valField, orderBy)</span><span class="type-signature"></span></h4> <div class="description"> Generate line-chart series data from the given collection data array. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>seriesField</code></td> <td class="type"> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>keyField</code></td> <td class="type"> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>valField</code></td> <td class="type"> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>orderBy</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Highchart.js.html">Highchart.js</a>, <a href="Highchart.js.html#line144">line 144</a> </li></ul></dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ActiveBucket.html">ActiveBucket</a></li><li><a href="Angular.html">Angular</a></li><li><a href="AutoBind.html">AutoBind</a></li><li><a href="BinaryTree.html">BinaryTree</a></li><li><a href="Collection.html">Collection</a></li><li><a href="CollectionGroup.html">CollectionGroup</a></li><li><a href="Core.html">Core</a></li><li><a href="Db.html">Db</a></li><li><a href="Document.html">Document</a></li><li><a href="Grid.html">Grid</a></li><li><a href="Highchart.html">Highchart</a></li><li><a href="IndexBinaryTree.html">IndexBinaryTree</a></li><li><a href="IndexHashMap.html">IndexHashMap</a></li><li><a href="Infinilist.html">Infinilist</a></li><li><a href="KeyValueStore.html">KeyValueStore</a></li><li><a href="Metrics.html">Metrics</a></li><li><a href="OldView.html">OldView</a></li><li><a href="Operation.html">Operation</a></li><li><a href="Overload.html">Overload</a></li><li><a href="Path.html">Path</a></li><li><a href="Persist.html">Persist</a></li><li><a href="ReactorIO.html">ReactorIO</a></li><li><a href="Serialiser.html">Serialiser</a></li><li><a href="Shared.overload.html">overload</a></li><li><a href="View.html">View</a></li></ul><h3>Mixins</h3><ul><li><a href="ChainReactor.html">ChainReactor</a></li><li><a href="crcTable.html">crcTable</a></li><li><a href="Shared.html">Shared</a></li></ul><h3>Global</h3><ul><li><a href="global.html#%2522boolean,function%2522">"boolean, function"</a></li><li><a href="global.html#%2522string,*,function%2522">"string, *, function"</a></li><li><a href="global.html#%2522string,function%2522">"string, function"</a></li><li><a href="global.html#boolean">boolean</a></li><li><a href="global.html#function">function</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Nov 19 2015 13:31:32 GMT+0000 (GMT) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>