linkeR (version 0.1.3)

register_plotly: Register a Plotly Component

Description

register_plotly registers a Plotly component for linking with other components. The default behavior uses plotly's built-in point selection highlighting, which is simple and works reliably across all plot types.

Usage

register_plotly(
  session,
  registry,
  plotly_output_id,
  data_reactive,
  shared_id_column,
  event_types = c("plotly_click"),
  source = NULL,
  click_handler = NULL
)

Value

NULL (invisible). This function is called for its side effects.

Arguments

session

Shiny session object

registry

A link registry created by create_link_registry()

plotly_output_id

Character string: the outputId of your plotlyOutput

data_reactive

Reactive expression returning the data frame for the plot

shared_id_column

Character string: name of the ID column

event_types

Character vector: plotly event types to listen for

source

Character string: plotly source identifier for event tracking

click_handler

Optional function: custom selection update handler. Function signature: function(plot_proxy, selected_data, session) where selected_data is the row from data_reactive() or NULL to clear selection.

Examples

# \donttest{
  # Create a mock session for the example
  session <- shiny::MockShinySession$new()

  # Create a registry
  registry <- create_link_registry(session)

  # Sample reactive data
  my_data <- shiny::reactive({
    data.frame(
      id = 1:5,
      name = c("A", "B", "C", "D", "E"),
      value = 11:15
    )
  })

  # Register a plotly component
  register_plotly(
    session,
    registry,
    plotly_output_id = "my_plot",
    data_reactive = my_data,
    shared_id_column = "id"
  )

  # Verify registration
  print(registry$get_components())
# }