Skip to content

Commit 7e793b1

Browse files
author
yankev
committed
edited docstrings
1 parent 68d7c18 commit 7e793b1

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

plotly/offline/offline.py

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,17 @@ def plot(figure_or_data,
265265
auto_open (default=True) -- If True, open the saved file in a
266266
web browser after saving.
267267
This argument only applies if `output_type` is 'file'.
268+
**config_options -- This will take in other keywords that will
269+
configure other options of your plot including mode bar buttons and
270+
interactivity in your chart. Take a look at:
271+
https://plot.ly/javascript/configuration-options/ for a full list of
272+
possible keywords. For example we can add the keyword `displaylogo`
273+
to False which would remove the Plotly logo in the top right corner.
274+
```
275+
iplot([{"x": [1, 2, 3], "y": [3, 1, 6]}], show_link=True,
276+
link_text="Send Here", displaylogo=False)
277+
```
278+
268279
"""
269280
if output_type not in ['div', 'file']:
270281
raise ValueError(
@@ -381,6 +392,18 @@ def plot_mpl(mpl_fig, resize=False, strip_style=False,
381392
auto_open (default=True) -- If True, open the saved file in a
382393
web browser after saving.
383394
This argument only applies if `output_type` is 'file'.
395+
**config_options -- This will take in other keywords that will
396+
configure other options of your plot including mode bar buttons and
397+
interactivity in your chart. Take a look at:
398+
https://plot.ly/javascript/configuration-options/ for a full list of
399+
possible keywords. For example we can add the keyword `displaylogo`
400+
to False which would remove the Plotly logo in the top right corner.
401+
402+
```
403+
iplot([{"x": [1, 2, 3], "y": [3, 1, 6]}], show_link=True,
404+
link_text="Send Here", displaylogo=False)
405+
```
406+
384407
385408
Example:
386409
```
@@ -436,6 +459,18 @@ def iplot_mpl(mpl_fig, resize=False, strip_style=False,
436459
has become outdated with your version of
437460
graph_reference.json or if you need to include
438461
extra, unnecessary keys in your figure.
462+
**config_options -- This will take in other keywords that will
463+
configure other options of your plot including mode bar buttons and
464+
interactivity in your chart. Take a look at:
465+
https://plot.ly/javascript/configuration-options/ for a full list of
466+
possible keywords. For example we can add the keyword `displaylogo`
467+
to False which would remove the Plotly logo in the top right corner.
468+
469+
```
470+
iplot([{"x": [1, 2, 3], "y": [3, 1, 6]}], show_link=True,
471+
link_text="Send Here", displaylogo=False)
472+
```
473+
439474
440475
Example:
441476
```
@@ -492,4 +527,3 @@ def enable_mpl_offline(resize=False, strip_style=False,
492527
formatter.for_type(matplotlib.figure.Figure,
493528
lambda fig: iplot_mpl(fig, resize, strip_style, verbose,
494529
show_link, link_text, validate))
495-

0 commit comments

Comments
 (0)