plotly/plotly.R

New feature request: a modeBarButtonsToKeep argument in the config function

Open

#1,740 opened on Apr 7, 2020

View on GitHubContributor guide
 (2 comments) (3 reactions) (0 assignees)R (643 forks)github user discovery
good-for-first-time-contributionhelp wanted

Repository metrics

Stars
 (2,671 stars)
PR merge metrics
 (Avg merge 1d 16h) (2 merged PRs in 30d)

Description

Currently plotly has a function to remove listed mode bar buttons.

It'd be nice if it had a function to keep listed mode bar buttons, and to drop the rest.

Otherwise the code is quite long-winded if a user only wants to keep one button, such as the camera.

This argument could be called modeBarButtonsToKeep

library(dplyr)
library(ggplot2)

plot <- ggplot(iris) +
  geom_point(aes(Sepal.Width, Sepal.Length))

plotly::ggplotly(plot) %>% 
  plotly::config(modeBarButtonsToRemove = list("zoom2d", "pan2d", "zoomIn2d", "zoomOut2d", 
"autoScale2d","resetScale2d", "hoverClosestCartesian", "hoverCompareCartesian", 
"sendDataToCloud", "toggleHover", "resetViews", "toggleSpikelines", "resetViewMapbox", 
"toggleSpikelines", "resetViewMapbox", "lasso2d", "select2d"))

Contributor guide

Research direction
Look at the existing modeBarButtonsToRemove implementation in the plotly.R source code to understand how config parameters are handled, then add a similar argument modeBarButtonsToKeep that filters the mode bar buttons to only those specified.
Tech stack
r
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RPlotly package knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60