plotly / plotly/plotly.R

Feature Request: Remove traces by name using plotlyProxy()

Aperta
#1,248 3 commenti 5 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
R
Stelle
2.7k
Fork
641
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

I originally posted this as a long shot stack overflow question, but I'm suspecting the functionality I'm looking for might require some new code.

When using plotlyProxy(), adding new traces with a name attribute is very straightforward. However, removing a trace by name does not appear to be possible. Reviewing the plotly.Js function reference, it appears that the JavaScript methods exclusively use indices, so this might require an additional javascript method to match names to trace numbers.

The example shiny app below illustrates the functionality I'm looking for. In the screenshot, when the user clicked the "Remove Trace" button, trace xxx would be removed.

plotlyproxy

library(shiny)
library(plotly)

ui <- fluidPage(
  textInput("TraceName", "Trace Name"),
  actionButton("Add","Add Trace"),
  actionButton("Remove","Remove Trace"),
  plotlyOutput("MyPlot")
)

server <- function(input,output,session) {

  ## Creating the plot
  output$MyPlot <- renderPlotly({
    plot_ly() %>%
      layout(showlegend  = TRUE)
  })

  ## Adding traces is smooth sailing
  observeEvent(input$Add,{
    plotlyProxy("MyPlot", session) %>%
      plotlyProxyInvoke("addTraces", list(x = rnorm(10),y = rnorm(10),
                                          type = "scatter",mode = "markers",
                                          name = input$TraceName))
  })

  ## Ideal Solution (that does not work)
  observeEvent(input$Remove,{
    plotlyProxy("MyPlot", session) %>%
      plotlyProxyInvoke("deleteTraces", input$TraceName)
  })

}

JavaScript is not my strong suit, but it seems like one way to support this would be to add a new method in htmlwidgets/plotly.js, perhaps called traceNamesToIDs. Then, the steps might look something like the following.

DeleteTraceNames <- c("xxx")
MyPlotProxy <- plotlyProxy("MyPlot", session)
TraceNumberList <- plotlyProxyInvoke(MyPlotProxy, "traceNamesToIds", )) ## Returns c(0)
plotlyProxyInvoke(MyPlotProxy ,"deleteTraces", TraceNumberList )

I'm not quite sure, but as I read through htmlwidgets/plotly.js, it seems like there is already some very similar functionality in the codebase to support Cross Talk integration.

Alternatively, if the deleteTraces method could be modified to directly accept names as a character input, that seems like the most intuitive usage from a user standpoint. However, this might result in breaking changes for users who wrote code based on trace numbers depending on the details of implementation.

plotlyProxy("MyPlot", session) %>%
    plotlyProxyInvoke("deleteTraces", c("xxx"))

If some implementation of this functionality could be added in future versions, I think it could make a substantial difference in the ease of use!

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia leggendo inst/htmlwidgets/plotly.js, in particolare la gestione di plotlyProxyInvoke e le funzionalità esistenti relative a Cross Talk menzionate nell’issue. Riproduci quindi l’app Shiny fornita e confronta il comportamento di deleteTraces usando il nome della trace e l’indice della trace. Il lavoro è completato quando l’esempio può rimuovere la trace selezionata per nome senza interrompere l’uso esistente basato sugli indici.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, r
Ambito
data-visualization
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.