Skip to content

documented overwrite argument in update_* #173

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

Merged
merged 1 commit into from
Nov 11, 2019
Merged

documented overwrite argument in update_* #173

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
documented overwrite argument in update_*
  • Loading branch information
@emmanuelle
emmanuelle committed Nov 5, 2019
commit 2a25e1bba2fc41e4bbc0c7ae766e92694b892f45
23 changes: 20 additions & 3 deletions python/creating-and-updating-figures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ jupyter:
extension: .md
format_name: markdown
format_version: '1.1'
jupytext_version: 1.1.6
jupytext_version: 1.1.1
kernelspec:
display_name: Python 3
language: python
Expand All @@ -31,8 +31,8 @@ jupyter:
page_type: example_index
permalink: python/creating-and-updating-figures/
redirect_from:
- python/user-guide/
- python/user-g/
- python/user-guide/
- python/user-g/
thumbnail: thumbnail/creating-and-updating-figures.png
v4upgrade: true
---
Expand Down Expand Up @@ -438,6 +438,23 @@ fig.update_traces(
fig.show()
```

### Overwrite existing properties when using update methods

`update_layout` and `update_traces` have an `overwrite` keyword argument, defaulting to False, in which case updates are applied recursively to the *existing* nested property structure. When set to True, the prior value of existing properties is overwritten with the provided value.

In the example below, the red color of markers is overwritten when updating `marker` in `update_traces` with `overwrite=True`. Note that setting instead `marker_opacity` with the magic underscore would not overwrite `marker_color` because properties would be overwritten starting only at the level of `marker.opacity`.

```python
import plotly.graph_objects as go
fig = go.Figure(go.Bar(x=[1, 2, 3], y=[6, 4, 9],
marker_color="red")) # will be overwritten below
fig.update_traces(
overwrite=True,
marker={"opacity": 0.4}
)
fig.show()
```

#### The for each trace method
Suppose the updates that you want to make to a collection of traces depend on the current values of certain trace properties. The `update_traces` method cannot handle this situation, but the `for_each_trace` method can.

Expand Down