Getting Started
Overview
Installation
API
3D Attributes Animations and Visualization Transitions Area Graphs Aspect Ratio, Space and width Axis Bar Graphs Bin Plots Bins Boxplot Graphs Circular Graphs Citations or References Clustering Colors Combination Plots Contours Correlation Graphs DOE Data Data Customizer Data Filters Data Point Attributes Data Selection Data Table Data Table/Filter Data sorting Debug Decorations Dendrograms Density Plots Dotplot Graphs Effect Error Bars and Confidence Intervals Events Fish Graphs Foreground and Background 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 Quantile Regression 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 UpSet Plots Variables Venn Diagrams X-Axis Y-Axis Z-Axis Zooming, Panning and Resizing cxplot false

Events : Event parameters

# broadcast

Flag to enable broadcasting to other canvasXpress objects in the page
Type: boolean
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

# broadcastGroup

Group Id for canvas to broadcast to. If not specified then it broadcasts to all canvases
Type: string
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

# disableBeacon

Flag to disable beacon.
Type: boolean
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

# disableCanvas

Flag to disable all canvas events
Type: boolean
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

# disableCode

Flag to disable showing the code
Type: boolean
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

# disableCustomizer

Flag to disable the data explorer
Type: boolean
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

# disableDataFilters

Flag to disable showing data filters
Type: boolean
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

# disableDataTable

Flag to disable showing data table
Type: boolean
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

# disableDocument

Flag to disable mousemove and mouseup in the document
Type: boolean
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

# disableDrag

Flag to disable drg events in canvas
Type: boolean
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

# disableEvents

Flag to disable all events
Type: boolean
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

# disableKeys

Flag to disable key binding events. This prevent some default browser shortcuts and it is system specific. Please see the Event section bellow
Type: boolean
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

# disableMenu

Flag to disable showing the menu on right clicks
Type: boolean
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

# disablePlusMinusKeys

Flag to disable plus / minus key binding events
Type: boolean
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

# disableShowShortcuts

Flag to disable showing shortcuts
Type: boolean
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

# disableTabPanel

Flag to disable the tab panels
Type: boolean
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

# disableToolbar

Flag to disable showing the toolbar
Type: boolean
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

# disableUndoRedoKeys

Flag to disable undo / redo key binding events
Type: boolean
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

# disableWheel

Flag to disable wheel.
Type: boolean
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

# disableWindow

Flag to disable resizing the canvas when the window is resized.
Type: boolean
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

# infoStartTime

Time in milliseconds to keep track of time
Type: integer Private
Default: Javascript new Date().getTime()
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

# infoTimeIn

Time in milliseconds to start showing info after a mouse over
Type: integer
Default: 50
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

# infoTimeOut

Time in milliseconds to wait between updates for the mouse over info to show up
Type: integer
Default: 3000
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

# lazyLoad

Load canvas only if shown in viewport
Type: boolean
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

# maxItemMenuCheckbox

Maximum number of items in a menu before it becomes a scroll box
Type: integer
Default: 10
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

# maxSubMenus

Maximum number of submenus in the context menus
Type: integer
Default: 25
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

# movable

Flag to disable moving the canvas by dragging the mouse from the move image in the toolbar
Type: boolean
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

# playable

Flag to make the plot playable if there are after rendering functions
Type: boolean
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

# resizable

Flag to disable resizing the canvas by dragging the mouse over the edges
Type: boolean
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

# resizableX

Flag to disable resizing the width of the canvas by dragging the mouse over the edges
Type: boolean
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

# resizableY

Flag to disable resizing the height of canvas by dragging the mouse over the edges
Type: boolean
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

# showMousePositionOnDrag

Flag to show/hide the mouse position when dragging in relation to the zero coordinate (top-right) of the canvas
Type: boolean
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

# showPrimaryMenus

Flag to show/hide the primary menus in toolbar
Type: boolean
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

# skipClick

Flag to skip click events after a mouse down event in visualizations where there is a drag capabilities
Type: boolean Private
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

# toolbarItems

Array containing the items in the toolbar. All items included by default
Type: array
Default: [Save, History, Move, Table, Tabs, Explore, Lasso, Customize, Password, Maximize]
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

# toolbarSize

Height for the toolbar in graphs
Type: integer
Default: 30
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

# toolbarType

Toolbar type
Type: string
Default: under
Options: over, under, fixed
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

⇧