General : General properties used in most visualizations

# cacheBase64


# canvasBox


# canvasBoxColor


# createFactory

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

# createVersion

CanvasXpress Version used to create plot. This is parsed from the PNG or JSON data loaded
Type: float Private
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
Type: integer
Default: 500

# functions


# graphOrientation

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

# graphType

Specifies the type of graph
Type: string
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

Fraction of transparency for grey out when highlighting with mouse over
Type: float
Default: 0.67

# invertGraph

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

# isCxplot


# isR

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

# isReproducibleResearch

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

# metaData


# password


# plotBox

Flag to draw a box around the x,y coordinates of the plot
Type: boolean
Default: false

# plotBoxColor

Color for the box around the x,y coordinates of the plot
Type: color
Default: rgb(204,204,204)

# printMagnification

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

# printThumbnail


# printType

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
Type: string
Default: download
Options: download, window

# reproduceTime

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

# saveFilename

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
Type: string
Default: false

# skipRender


# tags


# theme

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

# transparency

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

# transparencyHidden

Percentage of transparency applied to elements that are hidden
Type: float
Default: 0.1

# useRawLines

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

# view

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