terriajs

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: TableColumn</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: TableColumn</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>TableColumn<span class="signature">(name<span class="signature-attributes">opt</span>, values<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> </header> <article> <div class="container-overview"> <h4 class="name" id="TableColumn"><span class="type-signature"></span>new TableColumn<span class="signature">(name<span class="signature-attributes">opt</span>, values<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> <p>TableColumn is a light class containing a single variable (or column) from a TableStructure. It guesses the variable type (time, enum etc) from the variable name. It extends VariableConcept, which is used to represent the variable in the NowViewing tab. This gives it isActive, isSelected and color fields. In future it may perform additional processing.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The name of the variable.</p></td> </tr> <tr> <td class="name"><code>values</code></td> <td class="type"> <span class="param-type">Array.<Number></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>An array of values for the variable.</p></td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>Options:</p> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>active</code></td> <td class="type"> <span class="param-type">Boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>Whether the variable should start active.</p></td> </tr> <tr> <td class="name"><code>tableStructure</code></td> <td class="type"> <span class="param-type"><a href="TableStructure.html">TableStructure</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The table structure this column belongs to. Required so that only one column is selected at a time.</p></td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">VarType</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The variable type (eg. VarType.TIME). If not present, an educated guess is made based on the name and values.</p></td> </tr> <tr> <td class="name"><code>subtype</code></td> <td class="type"> <span class="param-type">VarSubType</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The variable subtype (eg. VarSubType.YEAR). If not present, an educated guess is made based on the name and values.</p></td> </tr> <tr> <td class="name"><code>isEndDate</code></td> <td class="type"> <span class="param-type">Boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>True if this is has type time and is an end_date. If not present, an educated guess is made based on the name and values.</p></td> </tr> <tr> <td class="name"><code>unallowedTypes</code></td> <td class="type"> <span class="param-type">Array.<VarType></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>An array of types which should not be guessed. If not present, all types are allowed. Cannot include VarType.SCALAR.</p></td> </tr> <tr> <td class="name"><code>displayVariableTypes</code></td> <td class="type"> <span class="param-type">Array.<VarType></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>If present, only make this variable visible if its type is in this list.</p></td> </tr> <tr> <td class="name"><code>replaceWithNullValues</code></td> <td class="type"> <span class="param-type">Array.<String></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>If present, and this is a SCALAR type with at least one numerical value, then replace these values with null. Defaults to ['na', 'NA'].</p></td> </tr> <tr> <td class="name"><code>replaceWithZeroValues</code></td> <td class="type"> <span class="param-type">Array.<String></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>If present, and this is a SCALAR type with at least one numerical value, then replace these values with 0. Defaults to [null, '-']. (Blank values like '' are converted to null before they reach here, so use null instead of '' to catch missing values.)</p></td> </tr> <tr> <td class="name"><code>displayDuration</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>id</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>Provided so that columns can be renamed; their original name is stored as the id.</p></td> </tr> <tr> <td class="name"><code>format</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>A format string for this column. For numbers, this is passed as options to toLocaleString.</p></td> </tr> <tr> <td class="name"><code>units</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The units of this column, if known. Not currently used internally by TableStructure or TableColumn.</p></td> </tr> <tr> <td class="name"><code>chartLineColor</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The string description of the chart line color of this variable, if any.</p></td> </tr> <tr> <td class="name"><code>yAxisMin</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>Override for the minimum display value of the y axis in charts.</p></td> </tr> <tr> <td class="name"><code>yAxisMax</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>Override for the maximum display value of the y axis in charts.</p></td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line72">line 72</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Extends</h3> <ul> <li><a href="VariableConcept.html">VariableConcept</a></li> </ul> <h3 class="subsection-title">Members</h3> <h4 class="name" id="_clock"><span class="type-signature"></span>_clock<span class="type-signature"></span></h4> <div class="description"> <p>A DataSourceClock whose start and stop times correspond to the first and last visible row. This is populated by TableStructure, since it may depend on other columns. Only if type === VarType.TIME.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line144">line 144</a> </li></ul></dd> </dl> <h4 class="name" id="_timeIntervals"><span class="type-signature"></span>_timeIntervals<span class="type-signature"></span></h4> <div class="description"> <p>A TimeInterval Array giving when each row applies. This is populated by TableStructure, since it may depend on other columns. Only if type === VarType.TIME.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line138">line 138</a> </li></ul></dd> </dl> <h4 class="name" id="clock"><span class="type-signature"></span>clock<span class="type-signature"> :DataSourceClock</span></h4> <div class="description"> <p>Returns a clock whose start and stop times correspond to the first and last visible row. Only defined if type == VarType.TIME.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">DataSourceClock</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableStructure.js.html">Map/TableStructure.js</a>, <a href="Map_TableStructure.js.html#line250">line 250</a> </li></ul></dd> </dl> <h4 class="name" id="clock"><span class="type-signature"></span>clock<span class="type-signature"> :DataSourceClock</span></h4> <div class="description"> <p>Returns a clock whose start and stop times correspond to the first and last visible row. Only defined if type == VarType.TIME.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">DataSourceClock</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line347">line 347</a> </li></ul></dd> </dl> <h4 class="name" id="color"><span class="type-signature"></span>color<span class="type-signature"> :String</span></h4> <div class="description"> <p>String describing the color of this node, if applicable. This property is observable.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">String</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="VariableConcept.html#color">VariableConcept#color</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_VariableConcept.js.html">Map/VariableConcept.js</a>, <a href="Map_VariableConcept.js.html#line53">line 53</a> </li></ul></dd> </dl> <h4 class="name" id="dates"><span class="type-signature"></span>dates<span class="type-signature"></span></h4> <div class="description"> <p>this.dates is a version of values that has been converted to javascript Dates. Only if type === VarType.TIME.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line121">line 121</a> </li></ul></dd> </dl> <h4 class="name" id="finishJulianDates"><span class="type-signature"></span>finishJulianDates<span class="type-signature"></span></h4> <div class="description"> <p>this.finishJulianDates is an Array of JulianDates listing the next different date in the values array, less 1 second. This is populated by TableStructure, since it may depend on other columns. Only if type === VarType.TIME.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line132">line 132</a> </li></ul></dd> </dl> <h4 class="name" id="formattedValues"><span class="type-signature"></span>formattedValues<span class="type-signature"> :Array</span></h4> <div class="description"> <p>Gets formatted values of this column.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Array</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line276">line 276</a> </li></ul></dd> </dl> <h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :String</span></h4> <div class="description"> <p>Gets or sets the id of the concept item. By default this is the same as the name. It is allowed to be different eg. for csv files with tersely-named columns.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">String</span> </li> </ul> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="VariableConcept.html#id">VariableConcept#id</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_Concept.js.html">Map/Concept.js</a>, <a href="Map_Concept.js.html#line20">line 20</a> </li></ul></dd> </dl> <h4 class="name" id="isActive"><span class="type-signature"></span>isActive<span class="type-signature"> :Boolean</span></h4> <div class="description"> <p>Gets or sets a value indicating whether this variable is currently active. This property is observable.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Boolean</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="VariableConcept.html#isActive">VariableConcept#isActive</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_VariableConcept.js.html">Map/VariableConcept.js</a>, <a href="Map_VariableConcept.js.html#line41">line 41</a> </li></ul></dd> </dl> <h4 class="name" id="isEnum"><span class="type-signature"></span>isEnum<span class="type-signature"> :Boolean</span></h4> <div class="description"> <p>Returns whether this column is an ENUM type.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Boolean</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line265">line 265</a> </li></ul></dd> </dl> <h4 class="name" id="isOpen"><span class="type-signature"></span>isOpen<span class="type-signature"> :Boolean</span></h4> <div class="description"> <p>Gets or sets a value indicating whether this concept item is currently open. When an item is open, its child items (if any) are visible. This property is observable. Only used if the concept's hasChildren can return true.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Boolean</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="Concept.html#isOpen">Concept#isOpen</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_Concept.js.html">Map/Concept.js</a>, <a href="Map_Concept.js.html#line48">line 48</a> </li></ul></dd> </dl> <h4 class="name" id="isSelectable"><span class="type-signature"></span>isSelectable<span class="type-signature"> :Boolean</span></h4> <div class="description"> <p>Flag to say if this if this node is selectable. This property is observable.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Boolean</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="VariableConcept.html#isSelectable">VariableConcept#isSelectable</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_VariableConcept.js.html">Map/VariableConcept.js</a>, <a href="Map_VariableConcept.js.html#line47">line 47</a> </li></ul></dd> </dl> <h4 class="name" id="isVisible"><span class="type-signature"></span>isVisible<span class="type-signature"> :Boolean</span></h4> <div class="description"> <p>Gets or sets a value indicating whether this concept is visible. Defaults to true.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Boolean</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="Concept.html#isVisible">Concept#isVisible</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_Concept.js.html">Map/Concept.js</a>, <a href="Map_Concept.js.html#line61">line 61</a> </li></ul></dd> </dl> <h4 class="name" id="items"><span class="type-signature"></span>items<span class="type-signature"> :Array.<<a href="AbsConcept.html">AbsConcept</a>></span></h4> <div class="description"> <p>Gets or sets the items contained in this concept. This property is observable. Only used if the concept's hasChildren can return true.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Array.<<a href="AbsConcept.html">AbsConcept</a>></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="Concept.html#items">Concept#items</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_Concept.js.html">Map/Concept.js</a>, <a href="Map_Concept.js.html#line40">line 40</a> </li></ul></dd> </dl> <h4 class="name" id="julianDates"><span class="type-signature"></span>julianDates<span class="type-signature"></span></h4> <div class="description"> <p>this.julianDates is a version of values that has been converted to JulianDates. Only if type === VarType.TIME.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line126">line 126</a> </li></ul></dd> </dl> <h4 class="name" id="julianDatesOrValues"><span class="type-signature"></span>julianDatesOrValues<span class="type-signature"> :Array</span></h4> <div class="description"> <p>Returns this column's values, except for TIME-type columns, in which case the julian dates are returned.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Array</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line324">line 324</a> </li></ul></dd> </dl> <h4 class="name" id="maximumValue"><span class="type-signature"></span>maximumValue<span class="type-signature"> :Number</span></h4> <div class="description"> <p>Gets the maximum value of this column.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Number</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line298">line 298</a> </li></ul></dd> </dl> <h4 class="name" id="minimumValue"><span class="type-signature"></span>minimumValue<span class="type-signature"> :Number</span></h4> <div class="description"> <p>Gets the minimum value of this column.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Number</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line287">line 287</a> </li></ul></dd> </dl> <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :String</span></h4> <div class="description"> <p>Gets or sets the name of the concept item. This property is observable.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">String</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="Concept.html#name">Concept#name</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_Concept.js.html">Map/Concept.js</a>, <a href="Map_Concept.js.html#line26">line 26</a> </li></ul></dd> </dl> <h4 class="name" id="numericalValues"><span class="type-signature"></span>numericalValues<span class="type-signature"> :Array</span></h4> <div class="description"> <p>Gets the column's numerical values only. This is the quantity used for the legend.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Array</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line254">line 254</a> </li></ul></dd> </dl> <h4 class="name" id="parent"><span class="type-signature"></span>parent<span class="type-signature"> :Array.<<a href="VariableConcept.html">VariableConcept</a>></span></h4> <div class="description"> <p>Gets or sets the parent for a node. This property is observable.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Array.<<a href="VariableConcept.html">VariableConcept</a>></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="VariableConcept.html#parent">VariableConcept#parent</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_VariableConcept.js.html">Map/VariableConcept.js</a>, <a href="Map_VariableConcept.js.html#line34">line 34</a> </li></ul></dd> </dl> <h4 class="name" id="subtype"><span class="type-signature"></span>subtype<span class="type-signature"> :VarSubType</span></h4> <div class="description"> <p>Gets or sets the subtype of this column.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">VarSubType</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line227">line 227</a> </li></ul></dd> </dl> <h4 class="name" id="timeIntervals"><span class="type-signature"></span>timeIntervals<span class="type-signature"> :Array.<TimeIntervalCollection></span></h4> <div class="description"> <p>Returns an array describing when each row is visible. Only defined if type == VarType.TIME.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Array.<TimeIntervalCollection></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line335">line 335</a> </li></ul></dd> </dl> <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :VarType</span></h4> <div class="description"> <p>Gets or sets the type of this column.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">VarType</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line212">line 212</a> </li></ul></dd> </dl> <h4 class="name" id="uniqueValues"><span class="type-signature"></span>uniqueValues<span class="type-signature"> :Array</span></h4> <div class="description"> <p>Returns this column's unique values only. Only defined if non-numeric.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Array</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line309">line 309</a> </li></ul></dd> </dl> <h4 class="name" id="values"><span class="type-signature"></span>values<span class="type-signature"> :Array</span></h4> <div class="description"> <p>Gets the values of this column.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Array</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line242">line 242</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".divideValues"><span class="type-signature">(static) </span>divideValues<span class="signature">(numerator, denominator)</span><span class="type-signature"> → {Array.<Number>}</span></h4> <div class="description"> <p>Divides the values of one TableColumns into another, optionally replacing those with denominator zero.</p> </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>numerator</code></td> <td class="type"> <span class="param-type"><a href="TableColumn.html">TableColumn</a></span> </td> <td class="description last"><p>The column whose values form the numerator.</p></td> </tr> <tr> <td class="name"><code>denominator</code></td> <td class="type"> <span class="param-type"><a href="TableColumn.html">TableColumn</a></span> </td> <td class="description last"><p>The column whose values form the denominator.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line608">line 608</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Array of values of numerator / denominator.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Array.<Number></span> </dd> </dl> <h4 class="name" id=".sumValues"><span class="type-signature">(static) </span>sumValues<span class="signature">(…The)</span><span class="type-signature"> → {Array.<Number>}</span></h4> <div class="description"> <p>Sums the values of a number of TableColumns.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>The</code></td> <td class="type"> <span class="param-type"><a href="TableColumn.html">TableColumn</a></span> </td> <td class="attributes"> <repeatable><br> </td> <td class="description last"><p>table columns (either a single array or as separate arguments).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line585">line 585</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Array of values of the sum.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Array.<Number></span> </dd> </dl> <h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Destroy the object and release resources. Is this necessary?</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line717">line 717</a> </li></ul></dd> </dl> <h4 class="name" id="getFullOptions"><span class="type-signature"></span>getFullOptions<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4> <div class="description"> <p>Returns the options you would pass to recreate this column.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line403">line 403</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>An options parameter suitable for passing to new TableColumn().</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Object</span> </dd> </dl> <h4 class="name" id="setTypeAndSubTypeFromName"><span class="type-signature"></span>setTypeAndSubTypeFromName<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Try to determine the best variable type based on the variable name. Sets the _type and _subtype properties.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line692">line 692</a> </li></ul></dd> </dl> <h4 class="name" id="toArrayWithName"><span class="type-signature"></span>toArrayWithName<span class="signature">()</span><span class="type-signature"> → {Array}</span></h4> <div class="description"> <p>Returns this column as an array, with the name as the first element, eg. ['x', 1, 3, 4].</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_TableColumn.js.html">Map/TableColumn.js</a>, <a href="Map_TableColumn.js.html#line709">line 709</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The column as an array.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Array</span> </dd> </dl> <h4 class="name" id="toggleActive"><span class="type-signature"></span>toggleActive<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Toggles the <a href="VariableConcept.html#isActive">VariableConcept#isActive</a> property, by using the parent's toggleActiveItem (if defined), or else manually.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="VariableConcept.html#toggleActive">VariableConcept#toggleActive</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_VariableConcept.js.html">Map/VariableConcept.js</a>, <a href="Map_VariableConcept.js.html#line74">line 74</a> </li></ul></dd> </dl> <h4 class="name" id="toggleOpen"><span class="type-signature"></span>toggleOpen<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Toggles the <a href="Concept.html#isOpen">Concept#isOpen</a> property. If this item's list of children is open, calling this method will close it. If the list is closed, calling this method will open it.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="Concept.html#toggleOpen">Concept#toggleOpen</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Map_Concept.js.html">Map/Concept.js</a>, <a href="Map_Concept.js.html#line89">line 89</a> </li></ul></dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbsCode.html">AbsCode</a></li><li><a href="AbsConcept.html">AbsConcept</a></li><li><a href="AbsDataset.html">AbsDataset</a></li><li><a href="AbsIttCatalogGroup.html">AbsIttCatalogGroup</a></li><li><a href="AbsIttCatalogItem.html">AbsIttCatalogItem</a></li><li><a href="AddressGeocoder.html">AddressGeocoder</a></li><li><a href="ArcGisCatalogGroup.html">ArcGisCatalogGroup</a></li><li><a href="ArcGisFeatureServerCatalogGroup.html">ArcGisFeatureServerCatalogGroup</a></li><li><a href="ArcGisFeatureServerCatalogItem.html">ArcGisFeatureServerCatalogItem</a></li><li><a href="ArcGisMapServerCatalogGroup.html">ArcGisMapServerCatalogGroup</a></li><li><a href="ArcGisMapServerCatalogItem.html">ArcGisMapServerCatalogItem</a></li><li><a href="AugmentedVirtuality.html">AugmentedVirtuality</a></li><li><a href="BingMapsCatalogItem.html">BingMapsCatalogItem</a></li><li><a href="BooleanParameter.html">BooleanParameter</a></li><li><a href="BulkAddressGeocoderResult.html">BulkAddressGeocoderResult</a></li><li><a href="CameraView.html">CameraView</a></li><li><a href="Catalog.html">Catalog</a></li><li><a href="CatalogFunction.html">CatalogFunction</a></li><li><a href="CatalogGroup.html">CatalogGroup</a></li><li><a href="CatalogItem.html">CatalogItem</a></li><li><a href="CatalogMember.html">CatalogMember</a></li><li><a href="Cesium.html">Cesium</a></li><li><a href="Cesium3DTilesCatalogItem.html">Cesium3DTilesCatalogItem</a></li><li><a href="CesiumDragPoints.html">CesiumDragPoints</a></li><li><a href="CesiumTerrainCatalogItem.html">CesiumTerrainCatalogItem</a></li><li><a href="CkanCatalogGroup.html">CkanCatalogGroup</a></li><li><a href="CkanCatalogItem.html">CkanCatalogItem</a></li><li><a href="Clock.html">Clock</a></li><li><a href="CompositeCatalogItem.html">CompositeCatalogItem</a></li><li><a href="Concept.html">Concept</a></li><li><a href="CorsProxy.html">CorsProxy</a></li><li><a href="CsvCatalogItem.html">CsvCatalogItem</a></li><li><a href="CswCatalogGroup.html">CswCatalogGroup</a></li><li><a href="CustomComponentType.html">CustomComponentType</a></li><li><a href="CzmlCatalogItem.html">CzmlCatalogItem</a></li><li><a href="DataSourceCatalogItem.html">DataSourceCatalogItem</a></li><li><a href="DateTimeParameter.html">DateTimeParameter</a></li><li><a href="DisplayVariablesConcept.html">DisplayVariablesConcept</a></li><li><a href="EnumerationParameter.html">EnumerationParameter</a></li><li><a href="Feature.html">Feature</a></li><li><a href="FunctionParameter.html">FunctionParameter</a></li><li><a href="GeoJsonCatalogItem.html">GeoJsonCatalogItem</a></li><li><a href="GlobeOrMap.html">GlobeOrMap</a></li><li><a href="GnafAddressGeocoder.html">GnafAddressGeocoder</a></li><li><a href="GnafApi.html">GnafApi</a></li><li><a href="GnafSearchProviderViewModel.html">GnafSearchProviderViewModel</a></li><li><a href="GpxCatalogItem.html">GpxCatalogItem</a></li><li><a href="HelpScreen.html">H