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 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 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

Data sorting API

# sortCaseSensitive

sortCaseSensitive boolean
Whether to use case sensitive in ascii sorting. Almost 'private' parameters used within the different CanvasXpress UIs.
Default: false
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# sortData

sortData object
Array of arrays with sorting functions. Each function takes three parameters. The first parameter must be either 'smp' to identify the parameters are related to the samples, 'var' to identify the parameters are related to the variables, or 'cat' to identify a sample or variable category. The second parameter can be either 'smp' to indicate to sort the sample indices or 'var' to indicate to sort the variable indices. The third parameter is the value for the key referenced by the first parameter. A special case for this parameter could be 'samples' or 'variables' to indicate to sort by the names of the samples or variables respectively. Here are some examples to sort the samples in the data: [ ['cat', 'smp', 'Factor1'] ] : Sort the samples by the sample category 'Factor1' [ ['var', 'smp', 'Variable1'] ] : Sort the samples by the value of the 'Variable1' [ ['cat', 'smp', 'samples'] ] : Sort the samples by their name. Important!!!! This parameter will clean the data and remove any variables not used in the dataset at load time.
Default: []
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

# sortDir

sortDir option
Default direction for data sorting. Almost 'private' parameters used within the different CanvasXpress UIs.
Default: ascending
Options: ascending, descending
Used in: Area, AreaLine, Bar, BarLine, Boxplot, Circular, DotLine, Dotplot, Gantt, Heatmap, Line, ParallelCoordinates, Pie, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine

⇧