Skip to content

Commit 6abf3f9

Browse files
committed
added new arguments to docstrings
1 parent e20da3e commit 6abf3f9

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

plotly/offline/offline.py

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ def _plot_html(figure_or_data, show_link, link_text, validate,
188188

189189
def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly',
190190
validate=True, download_image=False, format='png',
191-
_width=800, _height=600, filename='newplot'):
191+
_width=800, _height=600, filename='plot'):
192192
"""
193193
Draw plotly graphs inside an IPython notebook without
194194
connecting to an external server.
@@ -211,6 +211,14 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly',
211211
has become outdated with your version of
212212
graph_reference.json or if you need to include
213213
extra, unnecessary keys in your figure.
214+
downloage_image (default=False) -- If True, the image of the current plot
215+
will be downloaded.
216+
format (default='png') -- Specifies the format of the image to be
217+
downloaded if `downlowad_image` is True.
218+
filename (default='plot') -- Sets the name of the file your image
219+
will be saved to. The extension should not be included.
220+
_height (default=600) -- Specifies the height of the image in `px`.
221+
_width (default=800) -- Specifies the width of the image in `px`.
214222
215223
Example:
216224
```
@@ -311,6 +319,14 @@ def plot(figure_or_data,
311319
auto_open (default=True) -- If True, open the saved file in a
312320
web browser after saving.
313321
This argument only applies if `output_type` is 'file'.
322+
downloage_image (default=False) -- If True, the image of the current plot
323+
will be downloaded.
324+
format (default='png') -- Specifies the format of the image to be
325+
downloaded if `downlowad_image` is True.
326+
image_filename (default='plot') -- Sets the name of the file your image
327+
will be saved to. The extension should not be included.
328+
_height (default=600) -- Specifies the height of the image in `px`.
329+
_width (default=800) -- Specifies the width of the image in `px`.
314330
"""
315331
if output_type not in ['div', 'file']:
316332
raise ValueError(
@@ -447,6 +463,14 @@ def plot_mpl(mpl_fig, resize=False, strip_style=False,
447463
auto_open (default=True) -- If True, open the saved file in a
448464
web browser after saving.
449465
This argument only applies if `output_type` is 'file'.
466+
downloage_image (default=False) -- If True, the image of the current plot
467+
will be downloaded.
468+
format (default='png') -- Specifies the format of the image to be
469+
downloaded if `downlowad_image` is True.
470+
image_filename (default='plot') -- Sets the name of the file your image
471+
will be saved to. The extension should not be included.
472+
_height (default=600) -- Specifies the height of the image in `px`.
473+
_width (default=800) -- Specifies the width of the image in `px`.
450474
451475
Example:
452476
```
@@ -503,6 +527,14 @@ def iplot_mpl(mpl_fig, resize=False, strip_style=False,
503527
has become outdated with your version of
504528
graph_reference.json or if you need to include
505529
extra, unnecessary keys in your figure.
530+
downloage_image (default=False) -- If True, the image of the current plot
531+
will be downloaded.
532+
_format (default='png') -- Specifies the format of the image to be
533+
downloaded if `downlowad_image` is True.
534+
image_filename (default='plot') -- Sets the name of the file your image
535+
will be saved to. The extension should not be included.
536+
_height (default=600) -- Specifies the height of the image in `px`.
537+
_width (default=800) -- Specifies the width of the image in `px`.
506538
507539
Example:
508540
```

0 commit comments

Comments
 (0)