Skip to content

Commit 07fd630

Browse files
committed
Merge branch 'kaleido-docs-updates' of https://github.com/plotly/plotly.py into kaleido-docs-updates
2 parents 7b8061b + c290b5f commit 07fd630

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/python/static-image-export.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ It's also possible to generate static images using [Orca](https://github.com/plo
5656

5757
### Chrome
5858

59-
Kaleido uses Chrome for static image generation. Versions of Kaleido prior to v1 included Chrome. Kaleido v1 and later uses Chrome that's available on the machine on which it's running. If you need to install Chrome for static image generation, Plotly provides a CLI.
59+
Kaleido uses Chrome for static image generation. Versions of Kaleido prior to v1 included Chrome. Kaleido v1 and later uses the Chrome that's available on the machine on which it's running. If you need to install Chrome for static image generation, Plotly provides a CLI.
6060

6161
Run `plotly_get_chrome` to install Chrome.
6262

@@ -73,7 +73,7 @@ pio.install_chrome()
7373

7474
Plotly figures have a `write_image` method to write a figure to a file. `write_image` supports PNG, JPEG, WebP, SVG, and PDF.
7575

76-
To export a figure using `write_image`, call `write_image` on the figure with the filename where you want to save the figure on the figure. The file format is inferred from the extension:
76+
To export a figure using `write_image`, call `write_image` on the figure, and pass as an argument the filename where you want to save the figure. The file format is inferred from the extension:
7777

7878

7979
### Raster Formats
@@ -132,7 +132,7 @@ fig.write_image("images/fig1.eps")
132132

133133
### Specify a Format
134134

135-
In the earlier example, Plotly inferred the image format from the extension of the filename. You can also specify this with the `format` parameter.
135+
In the earlier example, Plotly inferred the image format from the extension of the filename. You can also specify the format explicitly using the `format` parameter.
136136

137137
~~~python
138138
import plotly.express as px
@@ -194,7 +194,7 @@ fig.to_image(format="png", engine="kaleido")
194194

195195
Previous examples on this page access `write_image` and `to_image` as methods on Plotly Figure objects. This functionality is also available via the `plotly.io` subpackage.
196196

197-
The following example uses the `write_image` function from `plotly.io`. The function takes the figure or a `dict` representing a figure (as shown in the example) as it's first argument.
197+
The following example uses the `write_image` function from `plotly.io`. The function takes the figure or a `dict` representing a figure (as shown in the example) as its first argument.
198198

199199

200200
~~~python
@@ -214,7 +214,7 @@ pio.write_image(fig, "fig.png")
214214

215215
## Image Export Settings (Kaleido)
216216

217-
As well as configuring height, width, and other settings by passing arguments when calling `write_image` and `to_image`, you can specify defaults to be used.
217+
As well as configuring height, width, and other settings by passing arguments when calling `write_image` and `to_image`, you can also set a single default to be used throughout the duration of the program.
218218

219219
### Available Settings
220220

0 commit comments

Comments
 (0)