Sets how a figure responds to, and shows, selections of points linked with
crosstalk. A figure is linked when its data come from a
crosstalk::SharedData (give one as the data_frame of a px_*()
function, pipe one into go_figure() and add traces with formulas such as
add_scatter(x = ~col), or link traces with set_crosstalk_keys()):
selecting points then selects the rows with the same keys in every view of the same
crosstalk group, such as other plots, crosstalk::filter_select() inputs,
DT tables or leaflet maps. Linked figures highlight on click by default;
highlight() changes that.
Arguments
- p
A
go_figure()(e.g. from apx_*()function) or a plotly htmlwidget.- on
The event that selects points:
"plotly_click","plotly_hover","plotly_selected"(box or lasso selection) or"plotly_selecting"(selection while dragging).NULLturns selecting from this plot off.- off
The event that clears the selection:
"plotly_doubleclick","plotly_deselect"or"plotly_relayout". The default matcheson:"plotly_deselect"for selections, otherwise"plotly_doubleclick".NULLturns clearing off.- persistent
Whether new selections add to the current one rather than replace it. Holding the shift key while selecting does this too.
- dynamic
Whether to show a colour picker for the selection colour.
- color
The selection colour (several, for
dynamic = TRUE): R colour names, hex colours or CSS colours such as"rgba(255,0,0,0.5)".NULLkeeps the points' own colours and dims the rest.- selectize
Whether to show a searchable dropdown of the keys, which selects them; or a list of selectize.js options for it.
- defaultValues
Keys selected when the figure is first shown.
- opacityDim
Opacity multiplier (0 to 1) of points not selected.
- selected
Trace attributes of the selected points, made with
attrs_selected().- debounce
Milliseconds to wait before selecting, for frequent events such as
"plotly_hover"and"plotly_selecting".- ...
Unused.
- opacity
Opacity of the selected points.
Details
The options match the plotly package's highlight(), and highlight()
also works on plotly htmlwidgets.
Examples
sd <- crosstalk::SharedData$new(px_data_iris())
px_scatter(sd, x = ~sepal_width, y = ~sepal_length, color = ~species) |>
highlight(on = "plotly_selected", color = "red")