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

Circular Graphs API

# arcSegmentsRadius

arcSegmentsRadius array
Array containing the proportion of the radius for each arc segment in the circular plot. If not specified then all radius will be the same. The plot will be scaled based of the largest value in the array
See also: arcSegmentsRadius
Default: []
Used in: Circular

# arcSegmentsSeparation

arcSegmentsSeparation integer
Number of degrees to separate the arc segments in the circular plots. The arc segments can be set with the segregateSampleBy property.
Default: 8
Used in: Circular

# bubbleColor

bubbleColor color
Default color for the bubbles. Only applicable to the bubble subtype.
Default: rgba(204,204,204,0.33)
Used in: Circular

# chordColor

chordColor option
Color the ribbon according to either the source or the target of the connection
Default: source
Options: source, target
Used in: Circular

# chordThickness

chordThickness integer
Relative length in pixels of the chord thickness in the circular graphs. Only applicable to the chord subtype.
Default: 28
Used in: Circular

# circularAnchorColor

circularAnchorColor color
Default color for the circular anchor.
Default: rgb(0,0,255)
Used in: Circular

# circularAnchorLength

circularAnchorLength integer
Length in pixels of the height of the circular anchor
Default: 15
Used in: Circular

# circularAnchors2Align

circularAnchors2Align option
Position to align the anchors2 in circular plot
Default: outside
Options: inside, outside
Used in: Circular

# circularAnchorsAlign

circularAnchorsAlign option
Position to align the anchors in circular plot
Default: inside
Options: inside, outside
Used in: Circular

# circularArc

circularArc integer
Number of degrees to extend the circular graph.
Default: 360
Used in: Circular

# circularCenterProportion

circularCenterProportion float
Proportion of the center of the circular graph to use as void; that is the fraction of the radius in the middle of the graph.
Default: 0.3
Used in: Circular

# circularConnectionsTransparency

circularConnectionsTransparency float
Percentage of transparency applied to the connections in the circular graphs
Default: 0.5
Used in: Circular

# circularDataPosition

circularDataPosition option
Position to align the data in 2D radial graphs and ideograms
Default: distributed
Options: absolute, distributed
Used in: Circular

# circularLabelsAlign

circularLabelsAlign option
Position to align the variable and sample names in circular plot
Default: outside
Options: inside, outside
Used in: Circular

# circularLetterSeparationFactor

circularLetterSeparationFactor float
Factor to adjust the spacing between letters in the circular graphs. The greater the number the closer the letters in the labels
Default: 1.5
Used in: Circular

# circularRotate

circularRotate integer
Number of degrees to rotate the circular graph to adjust the starting point.
Default:
Used in: Circular

# circularScalesAlign

circularScalesAlign option
Position to align the percent and radial axes in circular plot
Default: inside
Options: inside, outside
Used in: Circular

# circularType

circularType option
Property to set the subtype of circular graph. If set to sunburst or bubble then smpOverlays can be used to build a hierarchy for the graph.
Default: normal
Options: normal, radar, sunburst, chord, bubble
Used in: Circular

# connections

connections array
Array to store connections in circular graphs
Default: []
Used in: Circular

# ideogram

ideogram option
Ideogram. Additional ideograms can be loaded by appending to the CanvasXpress.chromosomes object. The format of the ideogram is based on the R data for 'USCS.hg19.chr'
CanvasXpress.chromosomes = {
  hg19 : {
    order : [ 1, 2, 3, 4, 5, 6, 7, 8, ...],
    data : {
      1 : [ [ 0, 2300000, "p36.33", "gneg" ], ...],
      2 : [ [ 0, 4300000, "p25.3", "gneg" ], ...],
    }
  }
}
Default: hg38
Options: hg19, hg38
Used in: Circular

# ideogramChromosome

ideogramChromosome string
Factor name included in the 'data.z' object used to map to the chromosome number.
Default: chr
Used in: Circular

# ideogramChromosomePosition

ideogramChromosomePosition string
Factor name included in the 'data.z' object used to map to the chromosome position.
Default: pos
Used in: Circular

# overlayLevelOrientation

overlayLevelOrientation option
Orientation to show the segregation levels
Default: circular
Options: perpendicular, circular
Used in: Circular

# rAxis

rAxis string
Radial axis for circular plots. It must be the name of a variable. Only applicable to 2 Dimensional circular plots.
Default: false
Used in: Circular

# rAxisZero

rAxisZero boolean
Flag to force the rAxis property to start from zero otherwise it starts from the minimum value.
Default: false
Used in: Circular

# ringGraphType

ringGraphType array
Array containing the graph type for each ring in the circular plot.
See also: ringOrder
Default: []
Used in: Circular

# ringGraphWeight

ringGraphWeight array
Array containing the proportion of the dimensions for each data ring in the circular plot. It must be a value between 0.1 and 1. If not specified then all ring will be weighted the same.
See also: ringOrder
Default: []
Used in: Circular

# ringSeparation

ringSeparation integer
Number of pixels to separate the rings in the circular plots.
Default: 5
Used in: Circular

# ringsOrder

ringsOrder array
Array containing the order of the rings. The array includes the levels of the factor specified as either segregateSamplesBy when show the ideogram or segregateVariablesBy when there is no ideogram. It may also include any of the following terms: 'dendrogram', 'ideogram', 'labels', 'scale', 'percent' and 'data'. If there are sample overlays, the array may also contain any of the factor names include in the this.data.x object. This array supersede any other configurations for example for the sample overlays. CanvasXpress will honored all other configurations if left empty.
See also: ringOrder
Default: []
Used in: Circular

# showCircularConnections

showCircularConnections boolean
Flag to show connections in circular graphs
Default: true
Used in: Circular

# showIdeogram

showIdeogram boolean
Show Human Chromosome Ideogram. Force plot to be two dimensional.
Default: false
Used in: Circular

# smpLabelOrientation

smpLabelOrientation option
Orientation to show the sample names
Default: perpendicular
Options: perpendicular, circular
Used in: Circular

⇧