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

Legends API

# legend

legend array
Custom legends : Array of objects [{ size : [], shape : [], shapeColor : [], line : [], lineColor : [], lineStart : [], lineEnd : [], text : [], x : number, y : number, title : string }]
Default: []
Used in: Network

# legendBackgroundColor

legendBackgroundColor color
Color for the legend background
See also: legendBox
Default: rgba(255,255,255,0)
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# legendBox

legendBox boolean
Flag to create a box around the legend
See also: legendBackgroundColor, legendBoxColor
Default: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# legendBoxColor

legendBoxColor color
Color for the box around the legend
See also: legendBox
Default: rgb(204,204,204)
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# legendColor

legendColor color
Color for the legends
Default: rgb(0,0,0)
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# legendColumns

legendColumns integer
Number of columns for the variable legends in one dimensional plots
Default: 1
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# legendFontSize

legendFontSize integer
Font size for the legends. Be aware that auto scaling font must be turned off for this property to take effect. A more convenient way to modify the size is to use the legend scaling factor
See also: autoScaleFont, legendScaleFontFactor
Default: 12
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# legendFontStyle

legendFontStyle option
Font style for the legend.
Default:
Options: , bold, italic, bold italic
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# legendInside

legendInside boolean
Position the legend inside the graphs
See also: legendPosition, legendPositionAuto
Default: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# legendOrder

legendOrder object
Object to specify custom order for the levels in the legends. The key of the object is the name of an annotation in the data.x object, or the name of an annotation in the data.z object. The value for element is an array with the levels for the corresponding factor
Default: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# legendPosition

legendPosition option
Position for the legend in the graphs. If legendInside is true the all the options apply but if legendInside is false only right and bottom are valid options
See also: legendInside, legendPositionAuto
Default: right
Options: topRight, right, bottomRight, bottom, bottomLeft, left, topLeft, top
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# legendPositionAuto

legendPositionAuto boolean
Automatically select best position for the legend outside the graphs; either left or bottom.
See also: legendInside, legendPosition
Default: false
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# legendScaleFontFactor

legendScaleFontFactor float
Scaling factor used to increase or decrease legend font size in the canvas.
Default: 1
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# showLegend

showLegend boolean
Flag to show or not the legend in the graphs
Default: true
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

# showLegendTitle

showLegendTitle boolean
Flag to show or not the legend title in the graphs
Default: true
Used in: Area, AreaLine, Bar, Boxplot, DotLine, Dotplot, Heatmap, Line, Network, ParallelCoordinates, Pie, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, TagCloud, Tree, Treemap

⇧