Data sorting

Data sorting related parameters


sortCaseSensitive boolean
Whether to use case sensitive in ascii sorting. Almost 'private' parameters used within the different CanvasXpress UIs.
Default: false
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.
Default: []
sortDir option
Default direction for data sorting. Almost 'private' parameters used within the different CanvasXpress UIs.
Default: ascending
Options: ascending, descending