CanvasXpress: API

Predicate that populates highlightVar / highlightSmp from the data before rendering. An object (or array of objects, OR-combined) of the form { target:"variable"|"sample", stat:"mean"|"max"|"min"|"sum"|"median", operator:">"|">="|"<"|"<="|"=="|"!="|"between"|"in", value:, field: }. When field is given the annotation value is tested; otherwise the element data is aggregated across the other axis with stat. Setting highlightBy switches an unset highlightMode to "focus"

Type: object or array

Default:

Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, Oncoprint, OptionsWall, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

Color for the The single emphasis color for highlighted / selected marks. The per-axis colors varHighlightColor / smpHighlightColor / nodeHighlightColor and the interactive selectionColor all inherit this value unless individually overridden.

Type: color

Default: #fe6969

Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, Oncoprint, OptionsWall, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

De-emphasis strength (0-1) for backgrounded marks. On mouseover it is the proportion of the grey overlay applied to the whole graph (0 disables the hover overlay). In "focus" mode (highlightMode / selectionMode) it sets how present the grey of the non-focused marks is: near 0 (e.g. 0.01) gives a very light, barely-there grey, higher values a darker, more visible grey; when left at 0 focus falls back to 0.15 so the effect is visible without extra config.

Type: float

Default:

Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, Oncoprint, OptionsWall, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

How the declarative highlightSmp / highlightVar sets are rendered (shares highlight / ghost / focus with selectionMode, applied to the declarative highlight instead of the interactive selection). "highlight" (default) recolors the highlighted marks; "ghost" fades the non-highlighted marks; "focus" recolors the non-highlighted marks to grey and keeps the highlighted ones in color, drawing the audience to a few elements by de-emphasizing the rest (the storytelling-with-data focus technique, as in the gghighlight package)

Type: string

Default: highlight

Options: highlight, ghost, focus

Used in: Area, AreaLine, Bar, BarLine, Boxplot, Bubble, Bullet, Chord, Circular, Contour, Correlation, Density, DotLine, Dotplot, Dumbbell, Fish, Gantt, Genome, Heatmap, Histogram, Line, Lollipop, Map, Meter, Network, Oncoprint, OptionsWall, ParallelCoordinates, Pie, Radar, SPLOM, Sankey, Scatter2D, Scatter3D, ScatterBubble2D, Stacked, StackedLine, StackedPercent, StackedPercentLine, Streamgraph, Sunburst, TagCloud, Tree, Treemap, Venn, Violin, Waterfall

Grey Out : General grey out properties used in all graphs