Function Namespace LABKEY.Query.Visualization.Measure
Visualization Measures are plottable data elements (columns). They may be of numeric or date types.
Defined in: Visualization.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Method Attributes | Method Name and Description |
---|---|
Returns a description of this measure.
|
|
getDimensions(config)
Returns the set of available LABKEY.Query.Visualization.Dimension objects for this measure.
|
|
getLabel()
Returns the label of this measure.
|
|
getName()
Returns the column name of this measure.
|
|
Returns the name of the query associated with this measure.
|
|
Returns the name of the schema associated with this measure.
|
|
getType()
Returns the data types of this measure.
|
|
Returns whether this measure is part of a user-defined query (versus a built-in/system-provided query).
|
Method Detail
getDescription()
Returns a description of this measure.
getDimensions(config)
Returns the set of available LABKEY.Query.Visualization.Dimension objects for this measure.
- Parameters:
- config
- An object which contains the following configuration properties.
- config.includeDemographics
- {Boolean} Applies only to measures from study datsets. Indicates whether dimensions from demographic datasets should be included in the returned set. If false, only dimensions from the measure's query will be returned.
- {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
getLabel()
Returns the label of this measure.
getName()
Returns the column name of this measure.
getQueryName()
Returns the name of the query associated with this measure.
getSchemaName()
Returns the name of the schema associated with this measure.
getType()
Returns the data types of this measure.
isUserDefined()
Returns whether this measure is part of a user-defined query (versus a built-in/system-provided query).