Namespace LABKEY.vis
The namespace for the internal LabKey visualization library. Contains classes within
LABKEY.vis.Plot, LABKEY.vis.Layer, and LABKEY.vis.Geom.
Defined in: utils.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Field Attributes | Field Name and Description |
---|---|
<static> |
LABKEY.vis.LeveyJenningsPlot
|
Method Attributes | Method Name and Description |
---|---|
<static> |
LABKEY.vis.getAggregateData(data, dimensionName, subDimensionName, measureName, aggregate, nullDisplayValue, includeTotal)
Generate an array of aggregate values for the given groups/subgroups in the data array.
|
<static> |
LABKEY.vis.groupCountData(data, groupAccessor, subgroupAccessor, propNameMap)
Groups data by the groupAccessor, and subgroupAccessor if provided, passed in and returns the number
of occurrences for that group/subgroup.
|
<static> |
LABKEY.vis.groupData(data, groupAccessor, subgroupAccessor)
Groups data by the groupAccessor, and subgroupAccessor if provided, passed in.
|
Field Detail
<static>
LABKEY.vis.LeveyJenningsPlot
Defined in: plot.js.
Method Detail
<static>
{Array}
LABKEY.vis.getAggregateData(data, dimensionName, subDimensionName, measureName, aggregate, nullDisplayValue, includeTotal)
Generate an array of aggregate values for the given groups/subgroups in the data array.
- Parameters:
- {Array} data
- The response data from selectRows.
- {String} dimensionName
- The grouping variable to get distinct members from.
- {String} subDimensionName
- The subgrouping variable to get distinct members from
- {String} measureName
- The variable to calculate aggregate values over. Nullable.
- {String} aggregate
- MIN/MAX/SUM/COUNT/etc. Defaults to COUNT.
- {String} nullDisplayValue
- The display value to use for null dimension values. Defaults to 'null'.
- {Boolean} includeTotal
- Whether or not to include the cumulative totals. Defaults to false.
- Returns:
- {Array} An array of results for each group/subgroup/aggregate
<static>
{Array}
LABKEY.vis.groupCountData(data, groupAccessor, subgroupAccessor, propNameMap)
Groups data by the groupAccessor, and subgroupAccessor if provided, passed in and returns the number
of occurrences for that group/subgroup. Most commonly used for processing data for a bar plot.
- Parameters:
- data
- groupAccessor
- subgroupAccessor
- propNameMap
- Returns:
- {Array}
<static>
{Object}
LABKEY.vis.groupData(data, groupAccessor, subgroupAccessor)
Groups data by the groupAccessor, and subgroupAccessor if provided, passed in.
Ex: A set of rows with participantIds in them, would return an object that has one attribute
per participant id. Each attribute will be an array of all of the rows the participant is in.
- Parameters:
- data
- Array of data (likely result of selectRows API call)
- groupAccessor
- Function defining how to access group data from array rows
- subgroupAccessor
- Function defining how to access subgroup data from array rows
- Returns:
- {Object} Map of groups, and subgroups, to arrays of data for each