Data

Data related parameters

erroBarsWidth integer
Minimum size of the bar in pixels to determine to show or hide error bar ends in the graphs when available.
Default: 2
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
errorBarsType option
Type of error bars.
Default: confidenceInterval95
Options: standardDeviation, standardErrorMean, confidenceInterval95
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
groupingFactors array Private
An array that holds the group names used for grouping the data. It must be a category in the 'data.x' object
Default: []
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
isBoxPlotCalc boolean Private
Flag to indicate if the iqr has been calculated if the graph type is Boxplot.
Default:
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
isGroupedData boolean Private
Flag to indicate if the data is grouped.
Default:
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
isLogData boolean
Flag to indicate if the data is Log transformed.
Default: false
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
isMarketDataFormated boolean Private
Flag to indicate if the data has been formated to display Candlestick.
Default:
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
isMarketSwitched boolean Private
Flag to indicate if the data is a time series so there is no need to plot every time interval. It is boolean in one dimensional plots or a string indicating the axis which is timed 'x', 'y' or 'z' @cfg {boolean|string} isGraphTime
Default: false
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
isTransformedData boolean Private
Flag to indicate if the data is transformed.
Default:
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
missingDataColor color
Color for the missing data
Default: rgb(255,255,0)
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
ratioGroupReference option
Name of the group used in ratio transformation.
Default: false
Options: false
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
ratioLevelReference option
Name of the level used in ratio transformation. @default
Default:
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
ratioReference integer
Default index of sample used in ratio transformation.
Default:
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
ratioSampleReference option
Name of the sample used in ratio transformation.
Default: false
Options: false
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
segregateSamplesBy option
String to indicate the annotation used to segregate the samples. It must be a category in the 'data.x' object
Default: false
Options: false, string
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
segregateVariablesBy option
String to indicate the annotation used to segregate the variables. It must be a category in the 'data.z' object
Default: false
Options: false, string
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
showErrorBars boolean
Flag to indicate whether to show or not error bars in the graphs.
Default: true
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
smpSort integer Private
Sample index used in sorting the data.
Default:
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
sortDir option
Default direction for data sorting.
Default: ascending
Options: ascending, descending
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
standardDeviationType option
Type of Standard Deviation. 'biased' uses n as denominator and 'unbiased' uses (n - 1) as denominator where n is the number of values
Default: unbiased
Options: biased, unbiased
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
tmpAsciiArray array Private
A temporary array to enable sorting data asciibetically.
Default:
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
transformAxis option
Default axis to use to transform the data.
Default: samples
Options: samples, variables
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
transformBase integer
Default log or exponential transformation.
Default: 2
Options: 2, 10
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
transformType option
Default transformation type.
Default: false
Options: false, log2, log10, exp2, exp10, percentile, zscore, ratio, ratio2, ratio10, save, reset, undo
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
varSort integer Private
Variable index used in sorting the data.
Default:
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
zscoreAxis option
Default axis to use to zcsore the data.
Default: samples
Options: samples, variables
Used in: Area, AreaLine, Bar, Barline, Boxplot, Candlestick, Correletion, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Treemap
 
Copyright © 2009-2015 canvasXpress.org | Isaac Neuhaus | Site Powered by Artician