Skip to content

Commit 9d14e21

Browse files
committed
almost always
1 parent d7d6a51 commit 9d14e21

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

notebooks/creating-updating-figures.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,8 @@ fig.show()
242242

243243
Magic underscore notation is supported throughout the graph objects API, and it can often significantly simplify operations involving deeply nested properties.
244244

245+
> Note: When you see keyword arguments with underscores passed to a graph object constructor or method, it is almost always safe to assume that it is an application of magic underscore notation. We have to say "almost always" rather than "always" because there are a few property names in the plotly schema that contain underscores: error_x, error_y, error_z, copy_xstyle, copy_ystyle, copy_zstyle, paper_bgcolor, and plot_bgcolor. These were added back in the early days of the library (2012-2013) before we standardized on banning underscores from property names.
246+
245247
### The update layout method
246248
Graph object figures support an `update_layout` method that may be used to update multiple nested properties of a figure's layout. Here is an example of updating the text and font size of a figure's title using `update_layout`.
247249

0 commit comments

Comments
 (0)