@@ -316,12 +316,13 @@ def iplot(figure_or_data, show_link=False, link_text='Export to plot.ly',
316
316
`show_link` and `link_text` set the associated options in this
317
317
dictionary if it doesn't contain them already.
318
318
auto_play (default=True) -- Whether to automatically start the animation
319
- sequence if the figure contains frames. Has no effect if the figure
320
- does not contain frames.
321
- animation_opts (default=None) -- dict of custom animation parameters to be
322
- passed to the function Plotly.animate in Plotly.js. See
319
+ sequence on page load, if the figure contains frames. Has no effect if
320
+ the figure does not contain frames.
321
+ animation_opts (default=None) -- Dict of custom animation parameters that
322
+ are used for the automatically started animation on page load. This
323
+ dict is passed to the function Plotly.animate in Plotly.js. See
323
324
https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js
324
- for available options. Has no effect if the figure
325
+ for available options. Has no effect if the figure
325
326
does not contain frames, or auto_play is False.
326
327
327
328
Example:
@@ -345,7 +346,7 @@ def iplot(figure_or_data, show_link=False, link_text='Export to plot.ly',
345
346
{'data': [{'x': [1, 4], 'y': [1, 4]}]},
346
347
{'data': [{'x': [3, 4], 'y': [3, 4]}],
347
348
'layout': {'title': 'End Title'}}]}
348
- iplot(figure,animation_opts="{ frame: {duration: 1}}" )
349
+ iplot(figure, animation_opts={' frame' : {' duration' : 1}})
349
350
```
350
351
"""
351
352
import plotly .io as pio
@@ -492,11 +493,12 @@ def plot(figure_or_data, show_link=False, link_text='Export to plot.ly',
492
493
auto_play (default=True) -- Whether to automatically start the animation
493
494
sequence on page load if the figure contains frames. Has no effect if
494
495
the figure does not contain frames.
495
- animation_opts (default=None) -- dict of custom animation parameters to be
496
- passed to the function Plotly.animate in Plotly.js. See
496
+ animation_opts (default=None) -- Dict of custom animation parameters that
497
+ are used for the automatically started animation on page load. This
498
+ dict is passed to the function Plotly.animate in Plotly.js. See
497
499
https://github.com/plotly/plotly.js/blob/master/src/plots/animation_attributes.js
498
- for available options. Has no effect if the figure does not contain
499
- frames, or auto_play is False.
500
+ for available options. Has no effect if the figure
501
+ does not contain frames, or auto_play is False.
500
502
501
503
Example:
502
504
```
@@ -509,7 +511,7 @@ def plot(figure_or_data, show_link=False, link_text='Export to plot.ly',
509
511
{'data': [{'x': [1, 4], 'y': [1, 4]}]},
510
512
{'data': [{'x': [3, 4], 'y': [3, 4]}],
511
513
'layout': {'title': 'End Title'}}]}
512
- plot(figure,animation_opts="{ frame: {duration: 1}}" )
514
+ plot(figure, animation_opts={' frame' : {' duration' : 1}})
513
515
```
514
516
"""
515
517
import plotly .io as pio
0 commit comments