@@ -90,10 +90,11 @@ def to_json_plotly(plotly_object, pretty=False, engine=None):
90
90
representation should be as compact as possible.
91
91
92
92
engine: str (default None)
93
- The JSON encoding engine to use. One of:
94
- - "json" for an engine based on the built-in Python json module
95
- - "orjson" for a faster engine that requires the orjson package
96
- - "auto" for the "orjson" engine if available, otherwise "json"
93
+ The JSON encoding engine to use. One of:\n
94
+ - "json" for an engine based on the built-in Python json module
95
+ - "orjson" for a faster engine that requires the orjson package
96
+ - "auto" for the "orjson" engine if available, otherwise "json"
97
+
97
98
If not specified, the default engine is set to the current value of
98
99
plotly.io.json.config.default_engine.
99
100
@@ -193,10 +194,11 @@ def to_json(fig, validate=True, pretty=False, remove_uids=True, engine=None):
193
194
True if trace UIDs should be omitted from the JSON representation
194
195
195
196
engine: str (default None)
196
- The JSON encoding engine to use. One of:
197
- - "json" for an engine based on the built-in Python json module
198
- - "orjson" for a faster engine that requires the orjson package
199
- - "auto" for the "orjson" engine if available, otherwise "json"
197
+ The JSON encoding engine to use. One of:\n
198
+ - "json" for an engine based on the built-in Python json module
199
+ - "orjson" for a faster engine that requires the orjson package
200
+ - "auto" for the "orjson" engine if available, otherwise "json"
201
+
200
202
If not specified, the default engine is set to the current value of
201
203
plotly.io.json.config.default_engine.
202
204
@@ -244,10 +246,11 @@ def write_json(fig, file, validate=True, pretty=False, remove_uids=True, engine=
244
246
True if trace UIDs should be omitted from the JSON representation
245
247
246
248
engine: str (default None)
247
- The JSON encoding engine to use. One of:
248
- - "json" for an engine based on the built-in Python json module
249
- - "orjson" for a faster engine that requires the orjson package
250
- - "auto" for the "orjson" engine if available, otherwise "json"
249
+ The JSON encoding engine to use. One of:\n
250
+ - "json" for an engine based on the built-in Python json module
251
+ - "orjson" for a faster engine that requires the orjson package
252
+ - "auto" for the "orjson" engine if available, otherwise "json"
253
+
251
254
If not specified, the default engine is set to the current value of
252
255
plotly.io.json.config.default_engine.
253
256
Returns
@@ -306,11 +309,11 @@ def from_json_plotly(value, engine=None):
306
309
A JSON string or bytes object
307
310
308
311
engine: str (default None)
309
- The JSON decoding engine to use. One of:
310
- - if "json", parse JSON using built in json module
311
- - if "orjson", parse using the faster orjson module, requires the orjson
312
+ The JSON decoding engine to use. One of:\n
313
+ - if "json", parse JSON using built in json module
314
+ - if "orjson", parse using the faster orjson module, requires the orjson
312
315
package
313
- - if "auto" use orjson module if available, otherwise use the json module
316
+ - if "auto" use orjson module if available, otherwise use the json module
314
317
315
318
If not specified, the default engine is set to the current value of
316
319
plotly.io.json.config.default_engine.
@@ -377,11 +380,11 @@ def from_json(value, output_type="Figure", skip_invalid=False, engine=None):
377
380
True if invalid figure properties should be silently ignored.
378
381
379
382
engine: str (default None)
380
- The JSON decoding engine to use. One of:
381
- - if "json", parse JSON using built in json module
382
- - if "orjson", parse using the faster orjson module, requires the orjson
383
+ The JSON decoding engine to use. One of:\n
384
+ - if "json", parse JSON using built in json module
385
+ - if "orjson", parse using the faster orjson module, requires the orjson
383
386
package
384
- - if "auto" use orjson module if available, otherwise use the json module
387
+ - if "auto" use orjson module if available, otherwise use the json module
385
388
386
389
If not specified, the default engine is set to the current value of
387
390
plotly.io.json.config.default_engine.
@@ -419,8 +422,8 @@ def read_json(file, output_type="Figure", skip_invalid=False, engine=None):
419
422
Parameters
420
423
----------
421
424
file: str or readable
422
- A string containing the path to a local file or a read-able Python
423
- object (e.g. a pathlib.Path object or an open file descriptor)
425
+ A string containing the path to a local file or a read-able Python
426
+ object (e.g. a pathlib.Path object or an open file descriptor)
424
427
425
428
output_type: type or str (default 'Figure')
426
429
The output figure type or type name.
@@ -431,11 +434,11 @@ def read_json(file, output_type="Figure", skip_invalid=False, engine=None):
431
434
True if invalid figure properties should be silently ignored.
432
435
433
436
engine: str (default None)
434
- The JSON decoding engine to use. One of:
435
- - if "json", parse JSON using built in json module
436
- - if "orjson", parse using the faster orjson module, requires the orjson
437
+ The JSON decoding engine to use. One of:\n
438
+ - if "json", parse JSON using built in json module
439
+ - if "orjson", parse using the faster orjson module, requires the orjson
437
440
package
438
- - if "auto" use orjson module if available, otherwise use the json module
441
+ - if "auto" use orjson module if available, otherwise use the json module
439
442
440
443
If not specified, the default engine is set to the current value of
441
444
plotly.io.json.config.default_engine.
0 commit comments