CanvasXpress: API - General

General API

# cacheBase64

cacheBase64 boolean

Cache image in meta data as Base64.

Default: false

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

# canvasBox

canvasBox boolean

Flag to draw a box around the canvas

See also: canvasBoxColor

Default: false

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

# canvasBoxColor

canvasBoxColor color

Color for the box around the canvas

See also: canvasBox

Default: rgb(204,204,204)

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

# createFactory

createFactory object Private

CanvasXpress Factory used to create plot. This is parsed from the PNG or JSON data loaded

Default: false

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

# createVersion

createVersion float Private

CanvasXpress Version used to create plot. This is parsed from the PNG or JSON data loaded

Default: false

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

# editable

editable boolean

Editable in JS Fiddle.

Default: true

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

# fullTextMeasureCheck

fullTextMeasureCheck integer

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

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

# functions

functions array Private

Functions exposed to the api

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

# graphOrientation

graphOrientation option

Specifies the orientation of one dimensional graphs.

Default: horizontal

Options: horizontal, vertical

Used in: Area, AreaLine, Bar, BarLine, Boxplot, DotLine, Dotplot, Heatmap, Line, ParallelCoordinates, Sankey, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# 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

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

# highlightGreyOut

highlightGreyOut boolean

Flag to add grey out when highlighting with mouse over

See also: highlightGreyOutTransparency

Default: false

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

# highlightGreyOutTransparency

highlightGreyOutTransparency float

Fraction of transparency for grey out when highlighting with mouse over

See also: highlightGreyOut

Default: 0.67

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

# invertGraph

invertGraph boolean

Flag to invert horizontal one dimensional graphs to plot from right to left

Default: false

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

# isR

isR boolean

Flag to indicate is running from the R library. For developers only.

Default: false

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

# isReproducibleResearch

isReproducibleResearch boolean

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

Default: true

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

# metaData

metaData object

Meta data for files read from a url

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

# plotBox

plotBox boolean

Flag to draw a box around the x,y coordinates of the plot

See also: plotBoxColor

Default: false

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

# plotBoxColor

plotBoxColor color

Color for the box around the x,y coordinates of the plot

See also: plotBox

Default: rgb(204,204,204)

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

# printMagnification

printMagnification integer

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

Default: 1

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

# printThumbnail

printThumbnail boolean

Print thumbnail.

Default: false

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

# 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

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

# reproduceTime

reproduceTime integer

Time to wait in milliseconds to reproduce user modifications through the UI.

Default: 500

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

# 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

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

# showFunctionNamesAfterRender

showFunctionNamesAfterRender boolean

Show function names when after render is set

Default: false

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

# skipRender

skipRender boolean Private

Flag to skip initial rendering

Default: false

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

# tags

tags array

Tags

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

# 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

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

# transparency

transparency float

Percentage of transparency applied to all elements in the visualizations

Default: null

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

# transparencyHidden

transparencyHidden float

Percentage of transparency applied to elements that are hidden

Default: 0.1

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

# useRawLines

useRawLines boolean

Use raw lines rather than 'potentially' crisp lines. Use only with circular graphs and networks.

Default: false

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

# view

view option

Specify the starting view of the data

Default: canvas

Options: canvas, table, layout

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

⇧