Skip to content

Commit ef6e68d

Browse files
committed
Add engine docstring to figure image export methods
1 parent 827af91 commit ef6e68d

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

packages/python/plotly/plotly/basedatatypes.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3172,6 +3172,12 @@ def to_image(self, *args, **kwargs):
31723172
True if the figure should be validated before being converted to
31733173
an image, False otherwise.
31743174
3175+
engine: str
3176+
Image export engine to use:
3177+
- "kaleido": Use Kaleido for image export
3178+
- "orca": Use Orca for image export
3179+
- "auto" (default): Use Kaleido if installed, otherwise use orca
3180+
31753181
Returns
31763182
-------
31773183
bytes
@@ -3231,6 +3237,11 @@ def write_image(self, *args, **kwargs):
32313237
True if the figure should be validated before being converted to
32323238
an image, False otherwise.
32333239
3240+
engine: str
3241+
Image export engine to use:
3242+
- "kaleido": Use Kaleido for image export
3243+
- "orca": Use Orca for image export
3244+
- "auto" (default): Use Kaleido if installed, otherwise use orca
32343245
Returns
32353246
-------
32363247
None

0 commit comments

Comments
 (0)