@@ -247,29 +247,29 @@ def to_image(
247
247
- 'webp'
248
248
- 'svg'
249
249
- 'pdf'
250
- - 'eps' (Kaleido v0.* only ) (Requires the poppler library to be installed and on the PATH)
250
+ - 'eps' (deprecated ) (Requires the poppler library to be installed and on the PATH)
251
251
252
252
If not specified, will default to:
253
- - `plotly.io.defaults.default_format` or `plotly.io.kaleido.scope.default_format` if engine is "kaleido"
254
- - `plotly.io.orca.config.default_format` if engine is "orca"
253
+ - `plotly.io.defaults.default_format` if engine is "kaleido"
254
+ - `plotly.io.orca.config.default_format` if engine is "orca" (deprecated)
255
255
256
256
width: int or None
257
257
The width of the exported image in layout pixels. If the `scale`
258
258
property is 1.0, this will also be the width of the exported image
259
259
in physical pixels.
260
260
261
261
If not specified, will default to:
262
- - `plotly.io.defaults.default_width` or `plotly.io.kaleido.scope.default_width` if engine is "kaleido"
263
- - `plotly.io.orca.config.default_width` if engine is "orca"
262
+ - `plotly.io.defaults.default_width` if engine is "kaleido"
263
+ - `plotly.io.orca.config.default_width` if engine is "orca" (deprecated)
264
264
265
265
height: int or None
266
266
The height of the exported image in layout pixels. If the `scale`
267
267
property is 1.0, this will also be the height of the exported image
268
268
in physical pixels.
269
269
270
270
If not specified, will default to:
271
- - `plotly.io.defaults.default_height` or `plotly.io.kaleido.scope.default_height` if engine is "kaleido"
272
- - `plotly.io.orca.config.default_height` if engine is "orca"
271
+ - `plotly.io.defaults.default_height` if engine is "kaleido"
272
+ - `plotly.io.orca.config.default_height` if engine is "orca" (deprecated)
273
273
274
274
scale: int or float or None
275
275
The scale factor to use when exporting the figure. A scale factor
@@ -278,14 +278,14 @@ def to_image(
278
278
less than 1.0 will decrease the image resolution.
279
279
280
280
If not specified, will default to:
281
- - `plotly.io.defaults.default_scale` or `plotly.io.kaleido.scope.default_scale` if engine is "kaleido"
282
- - `plotly.io.orca.config.default_scale` if engine is "orca"
281
+ - `plotly.io.defaults.default_scale` if engine is "kaleido"
282
+ - `plotly.io.orca.config.default_scale` if engine is "orca" (deprecated)
283
283
284
284
validate: bool
285
285
True if the figure should be validated before being converted to
286
286
an image, False otherwise.
287
287
288
- engine: str
288
+ engine (deprecated) : str
289
289
Image export engine to use. This parameter is deprecated and Orca engine support will be
290
290
dropped in the next major Plotly version. Until then, the following values are supported:
291
291
- "kaleido": Use Kaleido for image export
@@ -433,31 +433,31 @@ def write_image(
433
433
- 'webp'
434
434
- 'svg'
435
435
- 'pdf'
436
- - 'eps' (Kaleido v0.* only ) (Requires the poppler library to be installed and on the PATH)
436
+ - 'eps' (deprecated ) (Requires the poppler library to be installed and on the PATH)
437
437
438
438
If not specified and `file` is a string then this will default to the
439
439
file extension. If not specified and `file` is not a string then this
440
440
will default to:
441
- - `plotly.io.defaults.default_format` or `plotly.io.kaleido.scope.default_format` if engine is "kaleido"
442
- - `plotly.io.orca.config.default_format` if engine is "orca"
441
+ - `plotly.io.defaults.default_format` if engine is "kaleido"
442
+ - `plotly.io.orca.config.default_format` if engine is "orca" (deprecated)
443
443
444
444
width: int or None
445
445
The width of the exported image in layout pixels. If the `scale`
446
446
property is 1.0, this will also be the width of the exported image
447
447
in physical pixels.
448
448
449
449
If not specified, will default to:
450
- - `plotly.io.defaults.default_width` or `plotly.io.kaleido.scope.default_width` if engine is "kaleido"
451
- - `plotly.io.orca.config.default_width` if engine is "orca"
450
+ - `plotly.io.defaults.default_width` if engine is "kaleido"
451
+ - `plotly.io.orca.config.default_width` if engine is "orca" (deprecated)
452
452
453
453
height: int or None
454
454
The height of the exported image in layout pixels. If the `scale`
455
455
property is 1.0, this will also be the height of the exported image
456
456
in physical pixels.
457
457
458
458
If not specified, will default to:
459
- - `plotly.io.defaults.default_height` or `plotly.io.kaleido.scope.default_height` if engine is "kaleido"
460
- - `plotly.io.orca.config.default_height` if engine is "orca"
459
+ - `plotly.io.defaults.default_height` if engine is "kaleido"
460
+ - `plotly.io.orca.config.default_height` if engine is "orca" (deprecated)
461
461
462
462
scale: int or float or None
463
463
The scale factor to use when exporting the figure. A scale factor
@@ -466,14 +466,14 @@ def write_image(
466
466
less than 1.0 will decrease the image resolution.
467
467
468
468
If not specified, will default to:
469
- - `plotly.io.defaults.default_scale` or `plotly.io.kaleido.scope.default_scale` if engine is "kaleido"
470
- - `plotly.io.orca.config.default_scale` if engine is "orca"
469
+ - `plotly.io.defaults.default_scale` if engine is "kaleido"
470
+ - `plotly.io.orca.config.default_scale` if engine is "orca" (deprecated)
471
471
472
472
validate: bool
473
473
True if the figure should be validated before being converted to
474
474
an image, False otherwise.
475
475
476
- engine: str
476
+ engine (deprecated) : str
477
477
Image export engine to use. This parameter is deprecated and Orca engine support will be
478
478
dropped in the next major Plotly version. Until then, the following values are supported:
479
479
- "kaleido": Use Kaleido for image export
@@ -582,8 +582,7 @@ def write_images(
582
582
provided to the `fig` argument.
583
583
Specify format as a `str` to apply the same format to all exported images.
584
584
If not specified, and the corresponding `file` argument has a file extension, then `format` will default to the
585
- file extension. Otherwise, will default to `plotly.io.defaults.default_format`
586
- or `plotly.io.kaleido.scope.default_format`.
585
+ file extension. Otherwise, will default to `plotly.io.defaults.default_format`.
587
586
588
587
width: int, None, or list of (int or None)
589
588
The width of the exported image in layout pixels. If the `scale`
@@ -593,8 +592,7 @@ def write_images(
593
592
Use a list to specify widths for each figure or dict in the list
594
593
provided to the `fig` argument.
595
594
Specify width as an `int` to apply the same width to all exported images.
596
- If not specified, will default to `plotly.io.defaults.default_width`
597
- or `plotly.io.kaleido.scope.default_width`.
595
+ If not specified, will default to `plotly.io.defaults.default_width`.
598
596
599
597
height: int, None, or list of (int or None)
600
598
The height of the exported image in layout pixels. If the `scale`
@@ -604,8 +602,7 @@ def write_images(
604
602
Use a list to specify heights for each figure or dict in the list
605
603
provided to the `fig` argument.
606
604
Specify height as an `int` to apply the same height to all exported images.
607
- If not specified, will default to `plotly.io.defaults.default_height`
608
- or `plotly.io.kaleido.scope.default_height`.
605
+ If not specified, will default to `plotly.io.defaults.default_height`.
609
606
610
607
scale: int, float, None, or list of (int, float, or None)
611
608
The scale factor to use when exporting the figure. A scale factor
@@ -616,8 +613,7 @@ def write_images(
616
613
Use a list to specify scale for each figure or dict in the list
617
614
provided to the `fig` argument.
618
615
Specify scale as an `int` or `float` to apply the same scale to all exported images.
619
- If not specified, will default to `plotly.io.defaults.default_scale`
620
- or `plotly.io.kaleido.scope.default_scale`.
616
+ If not specified, will default to `plotly.io.defaults.default_scale`.
621
617
622
618
validate: bool or list of bool
623
619
True if the figure should be validated before being converted to
0 commit comments