Function Namespace LABKEY.Query.Visualization.Dimension
Visualization Dimensions are data elements (columns) on which LABKEY.Query.Visualization.Measure objects
can be pivoted or transformed. For example, the 'Analyte Name' dimension may be used to pivit a single 'Result' measure
into one series per Analyte.
Defined in: Visualization.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Method Attributes | Method Name and Description |
---|---|
<static> |
LABKEY.Query.Visualization.Dimension.getDescription()
Returns a description of this dimension.
|
<static> |
LABKEY.Query.Visualization.Dimension.getLabel()
Returns the label of this dimension.
|
<static> |
LABKEY.Query.Visualization.Dimension.getName()
Returns the column name of this dimension.
|
<static> |
LABKEY.Query.Visualization.Dimension.getQueryName()
Returns the name of the query associated with this dimension.
|
<static> |
LABKEY.Query.Visualization.Dimension.getSchemaName()
Returns the name of the schema assocated with this dimension.
|
<static> |
LABKEY.Query.Visualization.Dimension.getType()
Returns the data types of this dimension.
|
<static> |
LABKEY.Query.Visualization.Dimension.getValues(config)
Returns the set of available unique values for this dimension.
|
<static> |
LABKEY.Query.Visualization.Dimension.isUserDefined()
Returns whether this dimension is part of a user-defined query (versus a built-in/system-provided query).
|
Method Detail
<static>
LABKEY.Query.Visualization.Dimension.getDescription()
Returns a description of this dimension.
<static>
LABKEY.Query.Visualization.Dimension.getLabel()
Returns the label of this dimension.
<static>
LABKEY.Query.Visualization.Dimension.getName()
Returns the column name of this dimension.
<static>
LABKEY.Query.Visualization.Dimension.getQueryName()
Returns the name of the query associated with this dimension.
<static>
LABKEY.Query.Visualization.Dimension.getSchemaName()
Returns the name of the schema assocated with this dimension.
<static>
LABKEY.Query.Visualization.Dimension.getType()
Returns the data types of this dimension.
<static>
LABKEY.Query.Visualization.Dimension.getValues(config)
Returns the set of available unique values for this dimension.
- Parameters:
- config
- An object which contains the following configuration properties.
- {Function} config.success
- Function called when execution succeeds. Will be called with one argument:
- values: an array of unique dimension values
- {Function} config.failure Optional
- Function called when execution fails. Called with the following parameters:
- errorInfo: an object containing detailed error information (may be null)
- response: The XMLHttpResponse object
<static>
LABKEY.Query.Visualization.Dimension.isUserDefined()
Returns whether this dimension is part of a user-defined query (versus a built-in/system-provided query).