Skip to contents

Apply the uniform Legend inputs to a plotly figure

Source: R/plot_legend.R
apply_legend_inputs.Rd

Reads the inputs created by uniform_legend_inputs_ui() (legend.show, legend.font.family, legend.font.color, legend.title.size and legend.text.size) and applies them with apply_legend_styling(). An input that has not reported yet (NULL) leaves its property unchanged, so the legend stays visible until legend.show is FALSE.

Usage

apply_legend_inputs(fig, input, isolate_fn = isolate)

Arguments

fig

A plotly figure object.

input

Shiny input object (or a list) containing the legend fields.

isolate_fn

Function to isolate reactive values. Defaults to shiny::isolate.

Value

The plotly figure with the legend inputs applied.

See also

uniform_legend_inputs_ui(), reset_legend_inputs(), apply_legend_styling()

Author

Jared Andrews

Examples

fig <- plotly::plot_ly(iris,
    x = ~Sepal.Length, y = ~Sepal.Width,
    color = ~Species, type = "scatter", mode = "markers"
)
legend_input <- list(
    legend.show = TRUE, legend.font.family = "Courier New", legend.font.color = "#333333",
    legend.title.size = 16, legend.text.size = 12
)
apply_legend_inputs(fig, legend_input, isolate_fn = identity)