Skip to content

add the word background to bgcolor description so it will get indexed by algolia #2155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

add the word background to bgcolor description so it will get indexed by algolia #2155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/python/plotly/codegen/resources/plot-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57324,14 +57324,14 @@
"role": "style",
"dflt": "#fff",
"editType": "plot",
"description": "Sets the color of paper where the graph is drawn."
"description": "Sets the background color of the paper where the graph is drawn."
},
"plot_bgcolor": {
"valType": "color",
"role": "style",
"dflt": "#fff",
"editType": "layoutstyle",
"description": "Sets the color of plotting area in-between x and y axes."
"description": "Sets the background color of the plotting area in-between x and y axes."
},
"separators": {
"valType": "string",
Expand Down
12 changes: 6 additions & 6 deletions packages/python/plotly/plotly/graph_objs/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96070,7 +96070,7 @@ def orientation(self, val):
@property
def paper_bgcolor(self):
"""
Sets the color of paper where the graph is drawn.
Sets the background color of the paper where the graph is drawn.

The 'paper_bgcolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
Expand Down Expand Up @@ -96153,7 +96153,7 @@ def piecolorway(self, val):
@property
def plot_bgcolor(self):
"""
Sets the color of plotting area in-between x and y axes.
Sets the background color of the plotting area in-between x and y axes.

The 'plot_bgcolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
Expand Down Expand Up @@ -98684,14 +98684,14 @@ def _prop_descriptions(self):
"polar" subplots. Rotates the entire polar by the given
angle in legacy polar charts.
paper_bgcolor
Sets the color of paper where the graph is drawn.
Sets the background color of the paper where the graph is drawn.
piecolorway
Sets the default pie slice colors. Defaults to the main
`colorway` used for trace colors. If you specify a new
list here it can still be extended with lighter and
darker colors, see `extendpiecolors`.
plot_bgcolor
Sets the color of plotting area in-between x and y
Sets the background color of the plotting area in-between x and y
axes.
polar
plotly.graph_objects.layout.Polar instance or dict with
Expand Down Expand Up @@ -99198,14 +99198,14 @@ def __init__(
"polar" subplots. Rotates the entire polar by the given
angle in legacy polar charts.
paper_bgcolor
Sets the color of paper where the graph is drawn.
Sets the background color of the paper where the graph is drawn.
piecolorway
Sets the default pie slice colors. Defaults to the main
`colorway` used for trace colors. If you specify a new
list here it can still be extended with lighter and
darker colors, see `extendpiecolors`.
plot_bgcolor
Sets the color of plotting area in-between x and y
Sets the background color of the plotting area in-between x and y
axes.
polar
plotly.graph_objects.layout.Polar instance or dict with
Expand Down
4 changes: 2 additions & 2 deletions packages/python/plotly/plotly/graph_objs/_figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ def __init__(
polar by the given angle in legacy polar
charts.
paper_bgcolor
Sets the color of paper where the graph is
Sets the background color of the paper where the graph is
drawn.
piecolorway
Sets the default pie slice colors. Defaults to
Expand All @@ -379,7 +379,7 @@ def __init__(
extended with lighter and darker colors, see
`extendpiecolors`.
plot_bgcolor
Sets the color of plotting area in-between x
Sets the background color of the plotting area in-between x
and y axes.
polar
plotly.graph_objects.layout.Polar instance or
Expand Down
4 changes: 2 additions & 2 deletions packages/python/plotly/plotly/graph_objs/_figurewidget.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ def __init__(
polar by the given angle in legacy polar
charts.
paper_bgcolor
Sets the color of paper where the graph is
Sets the background color of the paper where the graph is
drawn.
piecolorway
Sets the default pie slice colors. Defaults to
Expand All @@ -379,7 +379,7 @@ def __init__(
extended with lighter and darker colors, see
`extendpiecolors`.
plot_bgcolor
Sets the color of plotting area in-between x
Sets the background color of the plotting area in-between x
and y axes.
polar
plotly.graph_objects.layout.Polar instance or
Expand Down
4 changes: 2 additions & 2 deletions packages/python/plotly/plotly/validators/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ def __init__(self, plotly_name="layout", parent_name="", **kwargs):
polar by the given angle in legacy polar
charts.
paper_bgcolor
Sets the color of paper where the graph is
Sets the background color of the paper where the graph is
drawn.
piecolorway
Sets the default pie slice colors. Defaults to
Expand All @@ -290,7 +290,7 @@ def __init__(self, plotly_name="layout", parent_name="", **kwargs):
extended with lighter and darker colors, see
`extendpiecolors`.
plot_bgcolor
Sets the color of plotting area in-between x
Sets the background color of the plotting area in-between x
and y axes.
polar
plotly.graph_objects.layout.Polar instance or
Expand Down