plotly / plotly/plotly.R

Account for trace specific layoutAttributes when warning about attribute names

Open
#994 5 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

maintenance
Dominant language
R
Stars
2.7k
Forks
641
PR merge metrics
No merged PRs in 30d

Description

This shouldn't throw a warning

> plot_ly(ggplot2::diamonds, x = ~cut, y = ~price, color = ~clarity, type = "box") %>% layout(boxmode = "group")

Warning message:
'layout' objects don't have these attributes: 'boxmode'
Valid attributes include:
'font', 'title', 'titlefont', 'autosize', 'width', 'height', 'margin', 'paper_bgcolor', 'plot_bgcolor', 'separators', 'hidesources', 'smith', 'showlegend', 'dragmode', 'hovermode', 'xaxis', 'yaxis', 'ternary', 'scene', 'geo', 'mapbox', 'radialaxis', 'angularaxis', 'direction', 'orientation', 'legend', 'annotations', 'shapes', 'images', 'updatemenus', 'sliders', 'calendar', 'barmode', 'bargap', 'mapType'
> Schema$traces$box$layoutAttributes$boxmode
$valType
[1] "enumerated"

$values
[1] "group"   "overlay"

$dflt
[1] "overlay"

Originally posted in https://community.plot.ly/t/not-a-real-error-for-boxmode/2596

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the warning with the plot_ly(..., type = "box") and layout(boxmode = "group") example. Start by tracing how layout attributes are validated against the schema, then compare that lookup with Schema$traces$box$layoutAttributes$boxmode. Done means boxmode is accepted for the box trace and the warning is no longer emitted.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
data-visualization
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.