hyper-analytics - npm Package Compare versions

Comparing version 0.11.12 to 0.11.13

js/DataNodeBase.js

@@ -16,3 +16,3 @@ 'use strict';
     /**
-     * @memberOf DataNodeBase.prototype
+     * @memberOf DataNodeBase#
      * @param {string} key
@@ -22,3 +22,3 @@ */
         /**
-         * @memberOf DataNodeBase.prototype
+         * @memberOf DataNodeBase#
          * @type {string}
@@ -30,3 +30,3 @@ */
         /**
-         * @memberOf DataNodeBase.prototype
+         * @memberOf DataNodeBase#
          * @type {string[]}
@@ -38,3 +38,3 @@ * @default false
         /**
-         * @memberOf DataNodeBase.prototype
+         * @memberOf DataNodeBase#
          * @type {number[]}
@@ -46,3 +46,3 @@ * @default ['']
         /**
-         * @memberOf DataNodeBase.prototype
+         * @memberOf DataNodeBase#
          * @type {boolean}
@@ -54,3 +54,3 @@ * @default false
         /**
-         * @memberOf DataNodeBase.prototype
+         * @memberOf DataNodeBase#
          * @type {number}
@@ -62,3 +62,3 @@ * @default 0
         /**
-         * @memberOf DataNodeBase.prototype
+         * @memberOf DataNodeBase#
          * @type {number}
@@ -70,3 +70,3 @@ * @default 1
         /**
-         * @memberOf DataNodeBase.prototype
+         * @memberOf DataNodeBase#
          * @type {boolean}
@@ -79,3 +79,3 @@ * @default false
     /**
-     * @memberOf DataNodeLeaf.prototype
+     * @memberOf DataNodeLeaf#
      * @param x
@@ -89,3 +89,3 @@ * @returns {*}
     /**
-     * @memberOf DataNodeLeaf.prototype
+     * @memberOf DataNodeLeaf#
      * @param depth
@@ -99,3 +99,3 @@ */
     /**
-     * @memberOf DataNodeLeaf.prototype
+     * @memberOf DataNodeLeaf#
      * @returns {string}
@@ -108,3 +108,3 @@ */
     /**
-     * @memberOf DataNodeLeaf.prototype
+     * @memberOf DataNodeLeaf#
      * @returns {number}
@@ -117,3 +117,3 @@ */
     /**
-     * @memberOf DataNodeLeaf.prototype
+     * @memberOf DataNodeLeaf#
      * @returns {Array}
@@ -126,3 +126,3 @@ */
     /**
-     * @memberOf DataNodeLeaf.prototype
+     * @memberOf DataNodeLeaf#
      * @param drillDown
@@ -140,3 +140,3 @@ */
     /**
-     * @memberOf DataNodeLeaf.prototype
+     * @memberOf DataNodeLeaf#
      * @param drillDown
@@ -149,3 +149,3 @@ */
     /**
-     * @memberOf DataNodeLeaf.prototype
+     * @memberOf DataNodeLeaf#
      */
@@ -152,0 +152,0 @@ toggleExpansionState: function() {

js/DataNodeGroup.js

@@ -21,3 +21,3 @@ 'use strict';
     /**
-     * @memberOf DataNodeGroup.prototype
+     * @memberOf DataNodeGroup#
      * @param key
@@ -30,3 +30,3 @@ */
     /**
-     * @memberOf DataNodeGroup.prototype
+     * @memberOf DataNodeGroup#
      * @param depth
@@ -44,3 +44,3 @@ */
     /**
-     * @memberOf DataNodeGroup.prototype
+     * @memberOf DataNodeGroup#
      * @returns {string}
@@ -56,3 +56,3 @@ */
     /**
-     * @memberOf DataNodeGroup.prototype
+     * @memberOf DataNodeGroup#
      * @returns {*}
@@ -68,3 +68,3 @@ */
     /**
-     * @memberOf DataNodeGroup.prototype
+     * @memberOf DataNodeGroup#
      * @returns {Array}
@@ -82,3 +82,3 @@ */
     /**
-     * @memberOf DataNodeGroup.prototype
+     * @memberOf DataNodeGroup#
      * @param drillDown
@@ -105,3 +105,3 @@ * @param {boolean} [expand] - One of:
     /**
-     * @memberOf DataNodeGroup.prototype
+     * @memberOf DataNodeGroup#
      * @param drillDown
@@ -119,3 +119,3 @@ */
     /**
-     * @memberOf DataNodeGroup.prototype
+     * @memberOf DataNodeGroup#
      * @param aggregator
@@ -133,3 +133,3 @@ */
     /**
-     * @memberOf DataNodeGroup.prototype
+     * @memberOf DataNodeGroup#
      * @returns {number}
@@ -136,0 +136,0 @@ */

js/DataNodeGroupSorter.js

@@ -13,3 +13,3 @@ 'use strict';
     /**
-     * @memberOf DataSourceSorterComposite.prototype
+     * @memberOf DataSourceSorterComposite#
      */
@@ -23,3 +23,3 @@ initialize: function(dataSource) {
     /**
-     * @memberOf DataSourceSorterComposite.prototype
+     * @memberOf DataSourceSorterComposite#
      * @param {number} y
@@ -33,3 +33,3 @@ * @returns {Object}
     /**
-     * @memberOf DataSourceSorterComposite.prototype
+     * @memberOf DataSourceSorterComposite#
      * @param columnIndex
@@ -47,3 +47,3 @@ * @param direction
     /**
-     * @memberOf DataSourceSorterComposite.prototype
+     * @memberOf DataSourceSorterComposite#
      */
@@ -55,3 +55,3 @@ apply: function() {
     /**
-     * @memberOf DataSourceSorterComposite.prototype
+     * @memberOf DataSourceSorterComposite#
      */
@@ -58,0 +58,0 @@ clearSorts: function() {

js/DataNodeLeaf.js

@@ -12,3 +12,3 @@ 'use strict';
     /**
-     * @memberOf DataNodeLeaf.prototype
+     * @memberOf DataNodeLeaf#
      * @param {string} key
@@ -21,3 +21,3 @@ */
     /**
-     * @memberOf DataNodeLeaf.prototype
+     * @memberOf DataNodeLeaf#
      * @param depth
@@ -31,3 +31,3 @@ */
     /**
-     * @memberOf DataNodeLeaf.prototype
+     * @memberOf DataNodeLeaf#
      * @returns {numer[]}
@@ -40,3 +40,3 @@ */
     /**
-     * @memberOf DataNodeLeaf.prototype
+     * @memberOf DataNodeLeaf#
      * @param drillDown
@@ -49,3 +49,3 @@ */
     /**
-     * @memberOf DataNodeLeaf.prototype
+     * @memberOf DataNodeLeaf#
      * @param aggregator
@@ -72,3 +72,3 @@ */
     /**
-     * @memberOf DataNodeLeaf.prototype
+     * @memberOf DataNodeLeaf#
      * @returns {number}
@@ -75,0 +75,0 @@ */

js/DataNodeTree.js

@@ -13,3 +13,3 @@ 'use strict';
     /**
-     * @memberOf DataNodeGroup.prototype
+     * @memberOf DataNodeGroup#
      * @param {string} key
@@ -23,3 +23,3 @@ */
     /**
-     * @memberOf DataNodeGroup.prototype
+     * @memberOf DataNodeGroup#
      */
@@ -34,3 +34,3 @@ toArray: function() {
     /**
-     * @memberOf DataNodeGroup.prototype
+     * @memberOf DataNodeGroup#
      * @param drillDown
@@ -45,3 +45,3 @@ */
     /**
-     * @memberOf DataNodeGroup.prototype
+     * @memberOf DataNodeGroup#
      * @returns {number}
@@ -48,0 +48,0 @@ */

js/DataSource.js

@@ -15,2 +15,3 @@ 'use strict';
          * @type {string[]}
+         * @memberOf DataSource#
          */
@@ -23,2 +24,3 @@ this.fields = fields || computeFieldNames(data[0]);
          * @type {object[]}
+         * @memberOf DataSource#
          */
@@ -35,3 +37,3 @@ this.data = data;
     /**
-     * @memberOf DataSource.prototype
+     * @memberOf DataSource#
      * @param y
@@ -63,3 +65,4 @@ * @returns {object[]}
      * * _number_ - index of found data row object in `this.data` (if `replacement` was `undefined`)
-     * @todo Implement binary search when the column is currently indexed (sorted).
+     * @todo Use a binary search (rather than `Array..find`) when column is known to be indexed (sorted).
+     * @memberOf DataSource#
      */
@@ -144,3 +147,3 @@ findRow: function findRow(columnName, value, replacement) {
     /**
-     * @memberOf DataSource.prototype
+     * @memberOf DataSource#
      * @param x
@@ -159,3 +162,3 @@ * @param y
     /**
-     * @memberOf DataSource.prototype
+     * @memberOf DataSource#
      * @param {number} x
@@ -170,3 +173,3 @@ * @param {number} y
     /**
-     * @memberOf DataSource.prototype
+     * @memberOf DataSource#
      * @returns {number}
@@ -179,3 +182,3 @@ */
     /**
-     * @memberOf DataSource.prototype
+     * @memberOf DataSource#
      * @returns {number}
@@ -188,3 +191,3 @@ */
     /**
-     * @memberOf DataSource.prototype
+     * @memberOf DataSource#
      * @returns {number[]}
@@ -197,3 +200,3 @@ */
     /**
-     * @memberOf DataSource.prototype
+     * @memberOf DataSource#
      * @returns {string[]}
@@ -210,3 +213,3 @@ */
     /**
-     * @memberOf DataSource.prototype
+     * @memberOf DataSource#
      * @returns {string[]}
@@ -219,3 +222,3 @@ */
     /**
-     * @memberOf DataSource.prototype
+     * @memberOf DataSource#
      * @param {string[]} fields
@@ -228,3 +231,3 @@ */
     /**
-     * @memberOf DataSource.prototype
+     * @memberOf DataSource#
      * @param {string[]} headers
@@ -240,3 +243,3 @@ */
     /**
-     * @memberOf DataSource.prototype
+     * @memberOf DataSource#
      */
@@ -248,3 +251,3 @@ getGrandTotals: function() {
     /**
-     * @memberOf DataSource.prototype
+     * @memberOf DataSource#
      * @param arrayOfUniformObjects
@@ -251,0 +254,0 @@ */

js/DataSourceAggregator.js

@@ -18,3 +18,3 @@ 'use strict';
         /**
-         * @memberOf DataSourceAggregator.prototype
+         * @memberOf DataSourceAggregator#
          * @type {DataSource}
@@ -25,3 +25,3 @@ */
         /**
-         * @memberOf DataSourceAggregator.prototype
+         * @memberOf DataSourceAggregator#
          * @type {DataSource}
@@ -32,3 +32,3 @@ */
         /**
-         * @memberOf DataSourceAggregator.prototype
+         * @memberOf DataSourceAggregator#
          * @type {DataNodeTree}
@@ -39,3 +39,3 @@ */
         /**
-         * @memberOf DataSourceAggregator.prototype
+         * @memberOf DataSourceAggregator#
          * @type {number[]}
@@ -47,3 +47,3 @@ * @default []
         /**
-         * @memberOf DataSourceAggregator.prototype
+         * @memberOf DataSourceAggregator#
          * @type {Array}
@@ -55,3 +55,3 @@ * @default []
         /**
-         * @memberOf DataSourceAggregator.prototype
+         * @memberOf DataSourceAggregator#
          * @type {Array}
@@ -63,3 +63,3 @@ * @default []
         /**
-         * @memberOf DataSourceAggregator.prototype
+         * @memberOf DataSourceAggregator#
          * @type {Array}
@@ -71,3 +71,3 @@ * @default []
         /**
-         * @memberOf DataSourceAggregator.prototype
+         * @memberOf DataSourceAggregator#
          * @type {object}
@@ -79,3 +79,3 @@ * @default {}
         /**
-         * @memberOf DataSourceAggregator.prototype
+         * @memberOf DataSourceAggregator#
          * @type {boolean}
@@ -87,3 +87,3 @@ * @default true
         /**
-         * @memberOf DataSourceAggregator.prototype
+         * @memberOf DataSourceAggregator#
          * @type {object}
@@ -101,3 +101,3 @@ * @default {}
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @param aggregations, groups
@@ -111,3 +111,3 @@ */
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @param aggregations
@@ -148,3 +148,3 @@ */
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @param label
@@ -159,3 +159,3 @@ * @param func
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @param columnIndexArray
@@ -173,3 +173,3 @@ */
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @param index
@@ -182,3 +182,3 @@ */
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @returns {boolean}
@@ -191,3 +191,3 @@ */
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @returns {boolean}
@@ -200,3 +200,3 @@ */
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @params [options]
@@ -212,3 +212,3 @@ */
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      */
@@ -220,3 +220,3 @@ clearGroups: function() {
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      */
@@ -228,3 +228,3 @@ clearAggregations: function() {
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      */
@@ -265,3 +265,3 @@ buildGroupTree: function() {
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @param dataNode
@@ -274,3 +274,3 @@ */
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      */
@@ -284,3 +284,3 @@ buildView: function() {
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @returns {*|boolean}
@@ -297,3 +297,3 @@ */
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @param x
@@ -312,3 +312,3 @@ * @param y
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @param x
@@ -326,3 +326,3 @@ * @param y
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @returns {*}
@@ -338,3 +338,3 @@ */
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @returns {*}
@@ -350,3 +350,3 @@ */
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @param y
@@ -387,3 +387,3 @@ * @param {boolean} [expand] - One of:
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @param headers
@@ -396,3 +396,3 @@ */
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @param fields
@@ -406,3 +406,3 @@ * @returns {*}
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @returns {object[]}
@@ -416,3 +416,3 @@ */
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @param y
@@ -432,3 +432,3 @@ * @returns {*}
     /**
-     * @memberOf DataSourceAggregator.prototype
+     * @memberOf DataSourceAggregator#
      * @param arrayOfUniformObjects
@@ -435,0 +435,0 @@ */

js/DataSourceDepthSorter.js

@@ -7,5 +7,7 @@ 'use strict';
 /**
- * Used by `DataSourceTreeviewSorter`.
- * One of these data sources should be created for each sort depth, starting with the maximum sort depth, and then one for each sort depth through the top (0) sort depth.
+ * @classdesc Sorts on non-terminal tree node rows only (_i.e.,_ expandable rows with children).
+ *
+ * One of these sorters is created by {@link DataSourceTreeviewSorter} for each grouping level, starting with the maximum group level depth, and then one for each group level through the top level (0) sort depth.
  * @constructor
+ * @param dataSource
  * @extends DataSourceIndexed
@@ -20,8 +22,13 @@ */
     /**
-     * @param {number} columnIndex
-     * @param {number} [direction=1]
-     * @param {number} sortDepth - If greater than row depth, sorts on _edge value_ value; otherwise sorts on value of ancestor of this depth. "Edge" means a value that lexically comes before all others (ascending sort) or after all others (descending sort).
-     * @memberOf DataSourceDepthSorter.prototype
+     * @desc Stable-sorts non-terminal tree node rows. Terminal (leaf) rows remain stable.
+     * @param {number} groupLevel - If greater than row depth, sorts on an _edge value_ value, which is a value lexically inferior to (ascending sort) or superior to (descending sort) the row value.
+     * Otherwise sorts on value of ancestor of this depth.
+     *
+     * @param {number} [direction=1] - One of:
+     * `1` - Sort ascending.
+     * `-1` - Sort descending.
+     * @param {number} [columnIndex] - Sorts on the values in this column. Otherwise sorts on the row index.
+     * @memberOf DataSourceDepthSorter#
      */
-    sortOn: function(sortDepth, direction, columnIndex) {
+    sortOn: function(groupLevel, direction, columnIndex) {
         switch (direction) {
@@ -55,3 +62,3 @@ case 0:
 
-                    this.depth = sortDepth;
+                    this.depth = groupLevel;
                     stableSort.sort(this.index, getValue, direction);
@@ -58,0 +65,0 @@ }

js/DataSourceGlobalFilter.js

@@ -20,3 +20,3 @@ 'use strict';
      *
-     * @memberOf DataSourceGlobalFilter.prototype
+     * @memberOf DataSourceGlobalFilter#
      * @param {object} [filter] - If undefined, deletes filter.
@@ -28,3 +28,3 @@ */
              * @type {filterFunction}
-             * @memberOf DataSourceGlobalFilter.prototype
+             * @memberOf DataSourceGlobalFilter#
              */
@@ -43,3 +43,3 @@ this.filter = filter;
      *
-     * @memberOf DataSourceGlobalFilter.prototype
+     * @memberOf DataSourceGlobalFilter#
      */
@@ -58,3 +58,3 @@ apply: function() {
      *
-     * @memberOf DataSourceGlobalFilter.prototype
+     * @memberOf DataSourceGlobalFilter#
      * @returns {number}
@@ -61,0 +61,0 @@ */

js/DataSourceGroupView.js

@@ -17,3 +17,3 @@ 'use strict';
         /**
-         * @memberOf DataSourceGroupView.prototype
+         * @memberOf DataSourceGroupView#
          * @type {DataSource}
@@ -24,3 +24,3 @@ */
         /**
-         * @memberOf DataSourceGroupView.prototype
+         * @memberOf DataSourceGroupView#
          * @type {DataNodeTree}
@@ -31,3 +31,3 @@ */
         /**
-         * @memberOf DataSourceGroupView.prototype
+         * @memberOf DataSourceGroupView#
          * @type {number[]}
@@ -39,3 +39,3 @@ * @default []
         /**
-         * @memberOf DataSourceGroupView.prototype
+         * @memberOf DataSourceGroupView#
          * @type {Array}
@@ -47,3 +47,3 @@ * @default []
         /**
-         * @memberOf DataSourceGroupView.prototype
+         * @memberOf DataSourceGroupView#
          * @type {Array}
@@ -55,3 +55,3 @@ * @default []
         /**
-         * @memberOf DataSourceGroupView.prototype
+         * @memberOf DataSourceGroupView#
          * @type {object}
@@ -63,3 +63,3 @@ * @default {}
         /**
-         * @memberOf DataSourceGroupView.prototype
+         * @memberOf DataSourceGroupView#
          * @type {object}
@@ -71,3 +71,3 @@ * @default {}
         /**
-         * @memberOf DataSourceGroupView.prototype
+         * @memberOf DataSourceGroupView#
          * @type {boolean}
@@ -105,3 +105,3 @@ * @default true
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      * @param columnIndexArray
@@ -118,3 +118,3 @@ */
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      * @param index
@@ -127,3 +127,3 @@ */
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      * @returns {boolean}
@@ -136,3 +136,3 @@ */
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      * @params [options]
@@ -148,3 +148,3 @@ */
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      */
@@ -156,3 +156,3 @@ clearGroups: function() {
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      */
@@ -194,3 +194,3 @@ buildGroupTree: function() {
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      * @param dataNode
@@ -203,3 +203,3 @@ */
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      */
@@ -213,3 +213,3 @@ buildView: function() {
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      * @returns {*|boolean}
@@ -226,3 +226,3 @@ */
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      * @param x
@@ -241,3 +241,3 @@ * @param y
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      * @param x
@@ -255,3 +255,3 @@ * @param y
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      * @returns {*}
@@ -267,3 +267,3 @@ */
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      * @returns {*}
@@ -279,3 +279,3 @@ */
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      * @param y
@@ -316,3 +316,3 @@ * @param {boolean} [expand] - One of:
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      * @param headers
@@ -325,3 +325,3 @@ */
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      * @param fields
@@ -335,3 +335,3 @@ * @returns {*}
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      * @param y
@@ -351,3 +351,3 @@ * @returns {*}
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      * @param arrayOfUniformObjects
@@ -361,3 +361,3 @@ */
     /**
-     * @memberOf DataSourceGroupView.prototype
+     * @memberOf DataSourceGroupView#
      */
@@ -364,0 +364,0 @@ getGrandTotals: function (){

js/DataSourceIndexed.js

@@ -6,2 +6,3 @@ 'use strict';
 /**
+ * @param dataSource
  * @constructor
@@ -11,9 +12,6 @@ */
 
-    /**
-     *
-     */
     isNullObject: false,
 
     /**
-     * @memberOf DataSourceIndexed.prototype
+     * @memberOf DataSourceIndexed#
      * @param dataSource
@@ -27,3 +25,3 @@ */
     /**
-     * @memberOf DataSourceIndexed.prototype
+     * @memberOf DataSourceIndexed#
      * @param y
@@ -41,3 +39,3 @@ * @returns {*}
     /**
-     * @memberOf DataSourceIndexed.prototype
+     * @memberOf DataSourceIndexed#
      * @param y
@@ -51,3 +49,3 @@ * @returns {object}
     /**
-     * @memberOf DataSourceIndexed.prototype
+     * @memberOf DataSourceIndexed#
      * @param x
@@ -62,3 +60,3 @@ * @param y
     /**
-     * @memberOf DataSourceIndexed.prototype
+     * @memberOf DataSourceIndexed#
      * @param {number} x
@@ -73,3 +71,3 @@ * @param {number} y
     /**
-     * @memberOf DataSourceIndexed.prototype
+     * @memberOf DataSourceIndexed#
      * @returns {Number|*}
@@ -84,2 +82,3 @@ */
      * @returns {*}
+     * @memberOf DataSourceIndexed#
      */
@@ -91,3 +90,3 @@ getColumnCount: function() {
     /**
-     * @memberOf DataSourceIndexed.prototype
+     * @memberOf DataSourceIndexed#
      * @returns {*}
@@ -100,3 +99,3 @@ */
     /**
-     * @memberOf DataSourceIndexed.prototype
+     * @memberOf DataSourceIndexed#
      * @param fields
@@ -110,3 +109,3 @@ * @returns {*}
     /**
-     * @memberOf DataSourceIndexed.prototype
+     * @memberOf DataSourceIndexed#
      * @param {string[]} headers
@@ -122,2 +121,3 @@ * @returns {string[]}
      * @returns {string[]}
+     * @memberOf DataSourceIndexed#
      */
@@ -129,3 +129,3 @@ getHeaders: function() {
     /**
-     * @memberOf DataSourceIndexed.prototype
+     * @memberOf DataSourceIndexed#
      * @returns {*}
@@ -138,3 +138,3 @@ */
     /**
-     * @memberOf DataSourceIndexed.prototype
+     * @memberOf DataSourceIndexed#
      * @param {object[]} arrayOfUniformObjects
@@ -148,3 +148,3 @@ * @returns {object[]}
     /**
-     * @memberOf DataSourceIndexed.prototype
+     * @memberOf DataSourceIndexed#
      */
@@ -156,3 +156,3 @@ clearIndex: function() {
     /**
-     * @memberOf DataSourceIndexed.prototype
+     * @memberOf DataSourceIndexed#
      * @param {filterPredicate} predicate
@@ -191,6 +191,9 @@ * @returns {number[]}
 DataSourceIndexed.valOrFunc = function(dataRow, columnName, calculator) {
-    var result = dataRow[columnName];
-    calculator = (typeof result)[0] === 'f' && result || calculator;
-    if (calculator) {
-        result = calculator(dataRow, columnName);
+    var result;
+    if (dataRow) {
+        result = dataRow[columnName];
+        calculator = (typeof result)[0] === 'f' && result || calculator;
+        if (calculator) {
+            result = calculator(dataRow, columnName);
+        }
     }
@@ -197,0 +200,0 @@ return result;

js/DataSourceSorter.js

@@ -12,3 +12,3 @@ 'use strict';
     /**
-     * @memberOf DataSourceSorter.prototype
+     * @memberOf DataSourceSorter#
      * @param {number} columnIndex
@@ -15,0 +15,0 @@ * @param {number} [direction=1]

js/DataSourceSorterComposite.js

@@ -13,3 +13,3 @@ 'use strict';
     /**
-     * @memberOf DataSourceSorterComposite.prototype
+     * @memberOf DataSourceSorterComposite#
      */
@@ -24,3 +24,3 @@ initialize: function() {
          * @type {number[]}
-         * @memberOf DataSourceSorterComposite.prototype
+         * @memberOf DataSourceSorterComposite#
          */
@@ -31,3 +31,3 @@ this.sorts = [];
          * @type {DataSource}
-         * @memberOf DataSourceSorterComposite.prototype
+         * @memberOf DataSourceSorterComposite#
          */
@@ -38,3 +38,3 @@ this.last = this.dataSource;
     /**
-     * @memberOf DataSourceSorterComposite.prototype
+     * @memberOf DataSourceSorterComposite#
      * @param {number} y
@@ -48,3 +48,3 @@ * @returns {Object}
     /**
-     * @memberOf DataSourceSorterComposite.prototype
+     * @memberOf DataSourceSorterComposite#
      * @param columnIndex
@@ -62,3 +62,3 @@ * @param direction
     /**
-     * @memberOf DataSourceSorterComposite.prototype
+     * @memberOf DataSourceSorterComposite#
      */
@@ -77,3 +77,3 @@ apply: function() {
     /**
-     * @memberOf DataSourceSorterComposite.prototype
+     * @memberOf DataSourceSorterComposite#
      */
@@ -90,3 +90,3 @@ clearSorts: function() {
     /**
-     * @memberOf DataSourceSorterComposite.prototype
+     * @memberOf DataSourceSorterComposite#
      * @param {number} x
@@ -101,3 +101,3 @@ * @param {number} y
     /**
-     * @memberOf DataSourceSorterComposite.prototype
+     * @memberOf DataSourceSorterComposite#
      * @param {number} x
@@ -104,0 +104,0 @@ * @param {number} y

js/DataSourceTreeview.js

@@ -11,5 +11,12 @@ 'use strict';
 
+/** @typedef columnAddress
+ * @property {string} name - The name of a column listed in the fields array. See the {@link DataSourceTreeview#getFields|getFields()} method.
+ * @property {number} index - The index of the column in the fields array. See the {@link DataSourceTreeview#getFields|getFields()} method.
+ */
+
+
 /**
- * For proper sorting, include `DataSourceTreeviewSorter` in your pipeline, _ahead of_ (closer to the data than) this data source.
+ * @classdesc For proper sorting, include `DataSourceTreeviewSorter` in your data source pipeline, _ahead of_ (closer to the data than) this data source.
  * @constructor
+ * @param dataSource
  * @extends DataSourceIndexed
@@ -19,5 +26,8 @@ */
 
-    /** DataSourceTreeviewSorter needs access to this object for instance variables `joined`, `idColumn`, and `parentIdColumn`, these last two of which are passed to the DataSourceDepthSorter constructor. (If dataSource is not the sorter, this is not used but harmless.)
+    /** @summary Initialize a new instance.
+     * @desc Set up {@link DataSourceTreeviewSorter} access to this object. Access is provided to the whole object although only instance variables `joined`, `idColumn`, and `parentIdColumn` are needed by the sorter. The two ID columns are passed to the {@link DataSourceDepthSorter} constructor. (If dataSource is not the sorter, this is not used but harmless.)
+     *
+     * Note that all ancestor classes' `initialize` methods are called (top-down) before this one. See {@link http://npmjs.org/extend-me} for more info.
      * @param dataSource
-     * @memberOf DataSourceTreeview.prototype
+     * @memberOf DataSourceTreeview#
      */
@@ -30,14 +40,16 @@ initialize: function(dataSource) {
      * @summary Toggle the tree-view.
-     * @desc Calculates or recalculates nesting depth of each row and marks it as expandable if it has children.
+     * @desc Calculates or recalculates nesting depth of each row and marks it as "expandable" iff it has children.
      *
-     * If resetting previously set data, the state of expansion of all rows that still have children is retained.
+     * If resetting previously set data, the state of expansion of all rows that still have children is retained. (All expanded rows will still be expanded when tree-view is turned back *ON*.)
      *
-     * All three named columns must exist.
+     * All of the columns referenced by the properties `idColumn`, `parentColumn`, `treeColumn`, and `groupColumn` must exist. These four columns have default references (names) as listed below. The references may be overridden in `options` by supplying alternate column names or indexes.
      *
-     * @param {boolean|object} [options] - Turn tree-view **ON**. If falsy (or omitted), turn it **OFF**.
+     * @param {boolean|object} [options] - If truthy, turn tree-view **ON**. If falsy (or omitted), turn it **OFF**.
      * @param {number|string} [options.idColumn='ID'] - Name or index of the primary key column.
      * @param {number|string} [options.parentIdColumn='parentID'] - Name or index of the foreign key column for grouping.
-     * @param {number|string} [options.treeColumn='name'] - Name or index of the drill-down column to decorate.
+     * @param {number|string} [options.treeColumn='name'] - Name or index of the drill-down column to decorate with triangles.
+     * @param {number|string} [options.groupColumn=this.treeColumn.name] - Name or index of the column that contains the group names. This is normally the same as the drill-down column. You only need to specify a different value when you want the drill down to this column, such as when the drill-down is in a column of its own. See {@link http://openfin.github.io/fin-hypergrid/tree-view-separate-drill-down.html} for an example.
      * @returns {boolean} Joined state.
-     * @memberOf DataSourceTreeview.prototype
+     *
+     * @memberOf DataSourceTreeview#
      */
@@ -49,6 +61,50 @@ setRelation: function(options) {
         this.joined = !!(
-            options &&
+
+            options && // turns tree view on or off (based on truthiness)
+
+            /** @summary Reference to the primary key column.
+             * @desc The primary key column uniquely identifies a data row.
+             * Used to relate a child row to a parent row.
+             *
+             * Redefined each time tree-view is turned *ON* by a call to {@link DataSourceTreeview#setRelation|setRelation()}.
+             * @type {columnAddress}
+             * @name idColumn
+             * @memberOf DataSourceTreeview#
+             */
             (this.idColumn = this.getColumnInfo(options.idColumn, 'ID')) &&
+
+            /** @summary Reference to the foreign key column for grouping.
+             * @desc The foreign key column relates this tree node row to its parent tree node row. Top-level tree nodes have no parent. In that case the value in the column is `null`.
+             *
+             * Redefined each time tree-view is turned *ON* by a call to {@link DataSourceTreeview#setRelation|setRelation()}.
+             * @type {columnAddress}
+             * @name parentIdColumn
+             * @memberOf DataSourceTreeview#
+             */
             (this.parentIdColumn = this.getColumnInfo(options.parentIdColumn, 'parentID')) &&
+
+            /** @summary Reference to the drill-down column.
+             * @desc The drill-down column is the column that is indented and decorated with drill-down controls (triangles).
+             *
+             * Redefined each time tree-view is turned *ON* by a call to {@link DataSourceTreeview#setRelation|setRelation()}.
+             * @type {columnAddress}
+             * @name treeColumn
+             * @memberOf DataSourceTreeview#
+             */
             (this.treeColumn = this.getColumnInfo(options.treeColumn, 'name')) &&
+
+            /** @summary Reference to the group name column.
+             * @desc The group name column is the column whose content describes the group.
+             *
+             * The treeview sorter treats the group name column differently than other columns,
+             * apply a "group sort" to it, which means only the group rows (rows with children)
+             * are sorted and the leaves are left alone (stable sorted).
+             *
+             * Normally refers to the same column as {@link DataSourceTreeview#treeColumn|treeColumn}.
+             *
+             * Redefined each time tree-view is turned *ON* by a call to {@link DataSourceTreeview#setRelation|setRelation()}.
+             * @type {columnAddress}
+             * @name groupColumn
+             * @memberOf DataSourceTreeview#
+             */
             (this.groupColumn = this.getColumnInfo(options.groupColumn, this.treeColumn.name))
@@ -101,3 +157,5 @@ );
     /**
-     * @memberOf DataSourceTreeview.prototype
+     * @summary Rebuild the index.
+     * @desc Rebuild the index to show only "revealed" rows. (Rows that are not inside a collapsed parent node row.)
+     * @memberOf DataSourceTreeview#
      */
@@ -111,6 +169,8 @@ apply: function() {
     /**
+     * @summary Get the value for the specified cell.
+     * @desc Intercepts tree column values and indents and decorates them.
      * @param x
      * @param y
      * @returns {*}
-     * @memberOf DataSourceTreeview.prototype
+     * @memberOf DataSourceTreeview#
      */
@@ -136,2 +196,3 @@ getValue: function(x, y) {
     /**
+     * @summary Handle a click event in the drill-down column.
      * @desc Operates only on the following rows:
@@ -152,3 +213,3 @@ * * Expandable rows - Rows with a drill-down control.
      * * `false` - Row had drill-down _but_ state did _not_ change.
-     * @memberOf DataSourceTreeview.prototype
+     * @memberOf DataSourceTreeview#
      */
@@ -182,2 +243,3 @@ click: function(y, expand, depth) {
      * @returns {boolean} If any rows expanded.
+     * @memberOf DataSourceTreeview#
      */
@@ -184,0 +246,0 @@ revealRow: function(ID) {

js/DataSourceTreeviewSorter.js

@@ -8,8 +8,13 @@ 'use strict';
 /**
- * This data source should be positioned _ahead of_ (closer to the data than) `DataSourceTreeview`.
+ * @classdesc Should be positioned in the data source pipeline _ahead of_ (closer to the data than) `DataSourceTreeview`.
  * @constructor
- * @extends DataSourceIndexed
+ * @param dataSource
+ * @extends DataSourceSorterComposite
  */
 var DataSourceTreeviewSorter = DataSourceSorterComposite.extend('DataSourceTreeviewSorter', {
 
+    /**
+     * @summary Rebuild the index.
+     * @memberOf DataSourceSorterComposite#
+     */
     apply: function() {
@@ -16,0 +21,0 @@ var each = this.dataSource,

js/util/Mappy.js

@@ -17,3 +17,3 @@ 'use strict';
     /**
-     * @memberOf Mappy.prototype
+     * @memberOf Mappy#
      * @param key
@@ -32,3 +32,3 @@ * @param value
     /**
-     * @memberOf Mappy.prototype
+     * @memberOf Mappy#
      * @param key
@@ -44,3 +44,3 @@ * @returns {*}
      *
-     * @memberOf Mappy.prototype
+     * @memberOf Mappy#
      * @param key
@@ -64,3 +64,3 @@ * @param {function} ifUndefinedFunc - Value getter when value is otherwise undefined.
     /**
-     * @memberOf Mappy.prototype
+     * @memberOf Mappy#
      */
@@ -74,3 +74,3 @@ clear: function() {
     /**
-     * @memberOf Mappy.prototype
+     * @memberOf Mappy#
      * @param key
@@ -89,3 +89,3 @@ */
     /**
-     * @memberOf Mappy.prototype
+     * @memberOf Mappy#
      * @param {function} iteratee
@@ -105,3 +105,3 @@ */
     /**
-     * @memberOf Mappy.prototype
+     * @memberOf Mappy#
      * @param {function} iteratee
@@ -128,3 +128,3 @@ * @returns {Mappy}
     /**
-     * @memberOf Mappy.prototype
+     * @memberOf Mappy#
      * @returns {Mappy}
@@ -131,0 +131,0 @@ */

package.json

 {
   "name": "hyper-analytics",
-  "version": "0.11.12",
+  "version": "0.11.13",
   "description": "Data transformations on arrays of congruent JavaScript objects.",
@@ -5,0 +5,0 @@ "repository": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

85909

increased by4.3%

Lines of code

2691

increased by2.87%

No dependency changes