Documentation Documentation Examples Examples API Reference API References
Getting Started
Overview Installation
API
3D Attributes Animations and Visualization Transitions Area Graphs Aspect Ratio, Space and width Axis Bar Graphs Bins Boxplot Graphs Circular Graphs Citations or References Clustering Colors Combination Plots Contours Correlation Graphs DOE Data Data Explorer Data Filters Data Point Attributes Data Selection: Parameters used to select data in all visualizations Data Table Data Table/Filter Data sorting Debug Decorations Dendrograms Density Plots Dotplot Graphs Effect Error Bars and Confidence Intervals Events Fish Graphs Fonts Foreground and Background Functions Gantt Charts General General Attributes Genome Browser Gradients Heatmap Graphs Hierarchy Histograms Images Legends Line Graphs Lines Loess Maps Margins Meter Graphs Missing Data Motion Charts Network Algorithm Parameters Network Communities Network Graphs Network Node and Edge Attributes Oncoprint Graphs Overlays Pie Charts Plot area QQ Plots R R-Axis Random Remote Procedures Ridgeline Plots Samples Sankey Diagrams Scatter Plot Matrix Scatter Plots Shadows Shapes Tag Cloud Text Time Series Titles and Subtitles Treemap Graphs Trees Variables Venn Diagrams X-Axis X-Axis2 Y-Axis Z-Axis Zooming, Panning and Resizing

Functions API

# addNormalDistributionLine

addNormalDistributionLine void
Add a normaldistribution line(s) to a 2D-Scatter plot
Default:
Used in: Scatter2D, Scatter3D, ScatterBubble2D

# addRegressionLine

addRegressionLine void
Add regression line(s) to a 2D-Scatter plot
Default:
Used in: Scatter2D, Scatter3D, ScatterBubble2D

# clusterSamples

clusterSamples void
Cluster samples based on data and generate a dendrogram on the sample axis. It takes no parameters
See also: distance, imputeMethod, linkage
Default:
Used in: Area, AreaLine, Bar, Boxplot, Dotplot, Heatmap, Line, Stacked, StackedLine, StackedPercent, StackedPercentLine

# clusterVariables

clusterVariables void
Cluster variables based on data and generate a dendrogram on the variable axis. It takes no parameters
See also: distance, imputeMethod, linkage
Default:
Used in: Heatmap

# createContour

createContour void
Create contour
See also: contourType, contourXBinSize, contourYBinSize, contourZBinSize
Default:
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# createHistogram

createHistogram option
Create a histogram in 2D-Scatter plots in the 'x' axis or the 'y' axis
@advanced
Default:
Options: x, y
Used in: Scatter2D, Scatter3D, ScatterBubble2D

# createRandomData

createRandomData void
Create a random data set
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# desegregateSamples

desegregateSamples void
Desegreagate samples previously segregated based on a sample category (data.x object)
See also: segregateSamples
Default:
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# desegregateVariables

desegregateVariables void
Desegregate variables previously segregated based on a variable category (data.z object)
See also: segregateVariables
Default:
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# draw

draw void
Redraw the canvas
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# drawArea

drawArea void
Display event areas
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# groupSamples

groupSamples array
Group samples based on a sample category (data.x object)
See also: ungroupSamples
Default:
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# hideCodeDiv

hideCodeDiv void
Hide the code for the plot
@advanced
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# hideInfoDiv

hideInfoDiv void
Hide additional information
@advanced
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# hideUnhideSmps

hideUnhideSmps array
Hide or unhide samples. It works like a switch
Default:
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# hideUnhideVars

hideUnhideVars array
Hide or unhide variables. It works like a switch
Default:
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# kmeansSamples

kmeansSamples void
Cluster samples using kmeans
See also: kmeansSmpClusters, maxIterations
Default:
Used in: Area, AreaLine, Bar, Boxplot, Dotplot, Heatmap, Line, Stacked, StackedLine, StackedPercent, StackedPercentLine

# kmeansVariables

kmeansVariables void
Cluster variables using kmeans
See also: kmeansVarClusters, maxIterations
Default:
Used in: Area, AreaLine, Bar, Boxplot, Dotplot, Heatmap, Line, Stacked, StackedLine, StackedPercent, StackedPercentLine

# print

print void
initializeApi * @param void @returns void
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# recalculateLayout

recalculateLayout void
Recalculate the network layout
Default:
Used in: Scatter2D, Scatter3D, ScatterBubble2D

# removeContour

removeContour void
Remove contour
See also: contourType, contourXBinSize, contourYBinSize, contourZBinSize
Default:
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# removeHistogram

removeHistogram void
Remove histogram from a 2D-Scatter plot
Default:
Used in: Scatter2D, Scatter3D, ScatterBubble2D

# reset

reset void
Reset the canvas
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# segregateSamples

segregateSamples option
Segregate samples based on a sample category (data.x object)
See also: desegregateSamples
Default:
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# segregateVariables

segregateVariables option
Segregate variables based on a variable category (data.z object)
See also: segregateVariables
Default:
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# showCodeDiv

showCodeDiv void
Show the code for the plot
@advanced
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# showInfoDiv

showInfoDiv void
Show additional information
@advanced
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

# transform

transform option
Transform all the data. Warning: the option 'save' overwrites the original data
See also: ratioReference, transformType, zscoreAxis
Default:
Options: false, log2, log10, exp2, exp10, percentile, zscore, ratio, ratio2, ratio10, save, reset, undo
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# transpose

transpose void
Transpose the data. It takes no parameters
Default:
Used in: Area, AreaLine, Bar, Boxplot, Dotplot, Heatmap, Line, Stacked, StackedLine, StackedPercent, StackedPercentLine

# ungroupSamples

ungroupSamples void
Ungroup samples previously grouped according to a sample category (data.x object)
See also: groupSamples
Default:
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Pie, Stacked, StackedLine, StackedPercent, StackedPercentLine

# updateCodeDiv

updateCodeDiv void
Update the code to generate the plot
@advanced
Default:
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, Correlation, DotLine, Dotplot, Fish, Gantt, Genome, Heatmap, Line, Map, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap, Venn

⇧