General API

# cacheBase64

# canvasBox

# canvasBoxColor

# createFactory

createFactory object Private
CanvasXpress Factory used to create plot. This is parsed from the PNG or JSON data loaded
Default: false

# createVersion

createVersion float Private
CanvasXpress Version used to create plot. This is parsed from the PNG or JSON data loaded
Default: false

# editable

# fullTextMeasureCheck

Full thorough check of variable and sample names when more than the specified number. This is useful for large data sets as canvas has not an efficent maner to measure text.
Default: 500

# functions

# graphOrientation

Specifies the orientation of one dimensional graphs.
Default: horizontal
Options: horizontal, vertical

# graphType

graphType option
Specifies the type of graph.
Default: Bar
Options: Bar, Line, Area, AreaLine, BarLine, Boxplot, Dotplot, DotLine, Fish, Gantt, Meter, Heatmap, Stacked, StackedLine, StackedPercent, StackedPercentLine, Tree, Treemap, TagCloud, ParallelCoordinates, Sankey, Scatter2D, ScatterBubble2D, Scatter3D, Correlation, Pie, Venn, Network, Genome, Circular

# highlightGreyOut

# highlightGreyOutTransparency

# invertGraph

invertGraph boolean
Flag to invert horizontal one dimensional graphs to plot from right to left
Default: false

# isR

isR boolean
Flag to indicate is running from the R library. For developers only.
Default: false

# isReproducibleResearch

Flag to indicate to track user modifications for Reproducible Research. For developers only.
Default: true

# metaData

# plotBox

# plotBoxColor

plotBoxColor color
Color for the box around the x,y coordinates of the plot
See also: plotBox
Default: rgb(204,204,204)

# printMagnification

Print Magnification to produce High Definition images. Courtesy of Baohong Zhang.
Default: 1

# printThumbnail

# printType

printType option
Type of printing when the camera icon in the UI is pressed. Download is to download the image while window is to save the image in a new browser window.
Default: download
Options: download, window

# reproduceTime

reproduceTime integer
Time to wait in milliseconds to reproduce user modifications through the UI.
Default: 500

# saveFilename

saveFilename string
Filename to use when downloading the canvas as an image or as json. If not specified. the filename will be based on the target id of the canvas. 'cX-' + canvas.targetId + extension.
Default: false

# showFunctionNamesAfterRender

showFunctionNamesAfterRender boolean
Show function names when after render is set
Default: false

# skipRender

# tags

# theme

theme option
Themes for the plot. This parameter will overwrite colors, background, axes, etc
Default: none
Options: none, economist, excel, tableau, stata, igray, solarized, paulTol, ggplot, wallStreetJournal, cx

# transparency

transparency float
Percentage of transparency applied to all elements in the visualizations
Default: null

# transparencyHidden

# useRawLines

useRawLines boolean
Use raw lines rather than 'potentially' crisp lines. Use only with circular graphs and networks.
Default: false

# view

view option
Specify the starting view of the data
Default: canvas
Options: canvas, table, layout