Class LABKEY.vis.TrendingLinePlot
TrendingLinePlot Wrapper to create a plot which shows data points compared to expected ranges
For LeveyJennings, the range is +/- 3 standard deviations from a mean.
For MovingRange, the range is [0, 3.268*mean(mR)].
For CUSUM, the range is [0, +5].
Defined in: plot.js.
Constructor Attributes | Constructor Name and Description |
---|---|
LABKEY.vis.TrendingLinePlot(config)
This helper will take the input data and generate a sequencial x-axis so that all data points are the same distance apart.
|
Config Attributes | Config Name and Description |
---|---|
The array of chart segment data.
|
|
CUSUM plot only.
|
|
For LeveyJennings, it's the raw value.
|
|
(optional) The data property name used to group plot lines and points.
|
|
The chart canvas height in pixels.
|
|
An object that contains the properties specific to the Levey-Jennings plot
|
|
(Optional) The data property name for the color to be used for the data point.
|
|
(Optional) The array of color values to use for the data points.
|
|
(Optional) Whether or not to show the control ranges in the plot.
|
|
(Optional) The hover text to display for each data point.
|
|
The data property name for the mean of the expected range.
|
|
The data property name for the mean of the moving range.
|
|
The data property name for the value to be plotted on the left y-axis for CUSUM-.
|
|
The data property name for the value to be plotted on the right y-axis for CUSUM-.
|
|
(Optional) The function to call on data point click.
|
|
The data property name for the value to be plotted on the left y-axis for CUSUM+.
|
|
The data property name for the value to be plotted on the right y-axis for CUSUM+.
|
|
(Optional) Whether or not to show a line connecting the data points.
|
|
The data property name for the standard deviation of the expected range.
|
|
The data property name for the value to be plotted on the left y-axis.
|
|
The data property name for the moving range value to be plotted on the left y-axis.
|
|
The data property name for the value to be plotted on the right y-axis.
|
|
The data property name for the moving range to be plotted on the right y-axis.
|
|
(Optional) The data property to use for unique x-axis tick marks.
|
|
The data property name for the x-axis tick label.
|
|
(Optional) The index/value of the x-axis label to be tagged (i.e.
|
|
(Optional) Y-axis min/max values.
|
|
(Optional) Whether the y-axis should be plotted with linear or log scale.
|
|
Specifies the plot type to be one of "LeveyJennings", "CUSUM", "MovingRange".
|
|
The id of the div/span to insert the svg element into.
|
|
The chart canvas width in pixels.
|
Class Detail
LABKEY.vis.TrendingLinePlot(config)
This helper will take the input data and generate a sequencial x-axis so that all data points are the same distance apart.
- Parameters:
- {Object} config
- An object that contains the following properties
Config Detail
{Array}
config.data
The array of chart segment data.
For LeveyJennings and MovingRange, each object is of the form: { label: "label", value: 123 }.
For CUSUM, each object is of the form: { label: "label", value: 123, negative: true}.
{String}
config.data.negative
CUSUM plot only. True for CUSUM-, false for CUSUM+. Default false;
{Number}
config.data.value
For LeveyJennings, it's the raw value.
For MovingRange, the calculated rM value, not the raw value.
For CUSUM, the calculated CUSUM value, not the raw value.
{String}
config.groupBy
(optional) The data property name used to group plot lines and points.
{Number}
config.height
The chart canvas height in pixels.
{Object}
config.properties
An object that contains the properties specific to the Levey-Jennings plot
{String}
config.properties.color
(Optional) The data property name for the color to be used for the data point.
{Array}
config.properties.colorRange
(Optional) The array of color values to use for the data points.
{Boolean}
config.properties.disableRangeDisplay
(Optional) Whether or not to show the control ranges in the plot. Defaults to false.
For LeveyJennings, the range is +/- 3 standard deviations from a mean.
For MovingRange, the range is [0, 3.268*mean(mR)].
For CUSUM, the range is [0, +5].
{Function}
config.properties.hoverTextFn
(Optional) The hover text to display for each data point. The parameter
to that function will be a row of data with access to all values for that row.
{String}
config.properties.mean
The data property name for the mean of the expected range.
Used by LeveyJennings.
{String}
config.properties.meanMR
The data property name for the mean of the moving range.
Used MovingRange.
{String}
config.properties.negativeValue
The data property name for the value to be plotted on the left y-axis for CUSUM-.
Used by CUSUM only.
{String}
config.properties.negativeValueRight
The data property name for the value to be plotted on the right y-axis for CUSUM-.
Used by CUSUM only.
{Function}
config.properties.pointClickFn
(Optional) The function to call on data point click. The parameters to
that function will be the click event and the row of data for the selected point.
{String}
config.properties.positiveValue
The data property name for the value to be plotted on the left y-axis for CUSUM+.
Used by CUSUM only.
{String}
config.properties.positiveValueRight
The data property name for the value to be plotted on the right y-axis for CUSUM+.
Used by CUSUM only.
{Boolean}
config.properties.showTrendLine
(Optional) Whether or not to show a line connecting the data points. Default false.
{String}
config.properties.stdDev
The data property name for the standard deviation of the expected range.
Used by LeveyJennings only.
{String}
config.properties.value
The data property name for the value to be plotted on the left y-axis.
Used by LeveyJennings.
{String}
config.properties.valueMR
The data property name for the moving range value to be plotted on the left y-axis.
Used by MovingRange.
{String}
config.properties.valueRight
The data property name for the value to be plotted on the right y-axis.
Used by LeveyJennings.
{String}
config.properties.valueRightMR
The data property name for the moving range to be plotted on the right y-axis.
Used by MovingRange.
{String}
config.properties.xTick
(Optional) The data property to use for unique x-axis tick marks. Defaults to sequence from 1:data length.
{String}
config.properties.xTickLabel
The data property name for the x-axis tick label.
{Number}
config.properties.xTickTagIndex
(Optional) The index/value of the x-axis label to be tagged (i.e. class="xticktag").
{Array}
config.properties.yAxisDomain
(Optional) Y-axis min/max values. Example: [0,20].
{String}
config.properties.yAxisScale
(Optional) Whether the y-axis should be plotted with linear or log scale. Default linear.
{String}
config.qcPlotType
Specifies the plot type to be one of "LeveyJennings", "CUSUM", "MovingRange". Defaults to "LeveyJennings".
{String}
config.renderTo
The id of the div/span to insert the svg element into.
{Number}
config.width
The chart canvas width in pixels.