Feature Request: Remove traces by name using plotlyProxy()
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- R
- Sterne
- 2.7k
- Forks
- 641
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
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!
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Lesen von inst/htmlwidgets/plotly.js, insbesondere der Behandlung von plotlyProxyInvoke und der bestehenden Cross Talk-bezogenen Funktionalität, die im Issue erwähnt wird. Reproduziere anschließend die bereitgestellte Shiny-App und vergleiche das Verhalten von deleteTraces bei Trace-Namen und Trace-Indizes. Fertig ist die Arbeit, wenn das Beispiel den ausgewählten Trace anhand seines Namens entfernen kann, ohne die bestehende Verwendung von Indizes zu beeinträchtigen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, r
- Bereich
- data-visualization
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100