Data Point Attributes

General attributes for data points in scatter and one dimensional plots


colorBy option
Name of a variable annotation or a sample name or the string 'variable' to color the variables.
Default: false
Options: false, variable
colorKey object
Object to assign custom colors to sample annotations and variable annotations included in the data object. 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 each key could be either: (1) a scalar with a valid color scheme (see this.meta.def.colorSchemes), or (2) an array with valid colors, or (3) an object to specify custom colors for each of the values of the annotation. A default color will be assigned to a data point whose value was not included the object. CanvasXpress will handle string and numeric annotation approprietly. However, if an object is specified like that one in number (3) the annotation will be treated as categorical even if the annotation is numeric.
Default: false
connectBy option
Name of a variable annotation to connect the variables.
Default: false
Options: false
The color for the connectBy lines
Default: rgb(204,204,204)
ellipseBy option
Utility to create error ellipses in Scatter plots
@funtion getZData
Default: false
Options: false, variable
motionBy option
Utility to create dynamic filtering of data in Scatter plots
Default: false
Options: false, variable
outlineBy string
Name of the annotation for the outline when drawing a multidimensional Heatmap
See also: outlineByData
Default: false
Used in: Heatmap
outlineByData string
String that identify the object containing a two dimensional array with values used to color the outline data points when drawing a multidimensional Heatmap. It must be located within the data.y object (for example: data.y.data4)
See also: outlineBy
Default: false
Used in: Heatmap
patternBy option
Name of a variable annotation or a sample name or the string 'variable' to pattern the variables. When patternByData is specified patternBy is used for the title in the legend.
See also: patternByData
Default: false
Options: false, variable
patternByData string
String that identify the object containing a two dimensional array with values used to pattern the data points when drawing a multidimensional Heatmap. It must be located within the data.y object (for example: data.y.data4)
See also: patternBy
Default: false
Used in: Heatmap
patternKey object
Object to assign custom patterns to sample annotations and variable annotations included in the data object. 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. A default pattern will be assigned to a data point whose value was not included the object.
Default: false
shapeBy option
Name of a variable annotation or a sample name or the string 'variable' to shape the variables. When shapeByData is specified shapeBy is used for the title in the legend.
See also: shapeByData
Default: false
Options: false, variable
shapeByData string
String that identify the object containing a two dimensional array with values used to shape data points when drawing a multidimensional Heatmap. It must be located within the data.y object (for example: data.y.data2)
See also: shapeBy
Default: false
Used in: Heatmap
shapeByShape option
String that identify the shape to use in regular and multidimensional heatmaps. shapeByData will take precedence over this property.
Default: false
Options: false, sphere, square, triangle, star, rhombus, octagon, oval, plus, minus, mdavid
Used in: Heatmap
shapeKey object
Object to assign custom shapes to sample annotations and variable annotations included in the data object. 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. A default shape will be assigned to a data point whose value was not included the object.
Default: false
sizeBy option
Name of a variable annotation or a sample name or the string 'variable' to size the variables. When sizeByData is specified sizeBy is used for the title in the legend.
See also: sizeByData
Default: false
Options: false, variable
sizeByData string
String that identify the object containing a two dimensional array with values used to size data points when drawing a multidimensional Heatmap. It must be located within the data.y object (for example: data.y.data3)
See also: sizeBy
Default: false
Used in: Heatmap
sizeKey object
Object to assign custom sizes to sample annotations and variable annotations included in the data object. 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. A default size will be assigned to a data point whose value was not included the object.
Default: false
treemapBy array
Array of sample annotations to treemap the variables. The array may also include 'sample' to use as last level.
Default: []