, file, validate=True, pretty=False, remove_uids=True, engine=None)

Convert a figure to JSON and write it to a file or writeable object

  • fig – Figure object or dict representing a figure

  • file (str or writeable) – A string representing a local file path or a writeable object (e.g. a pathlib.Path object or an open file descriptor)

  • pretty (bool (default False)) – True if JSON representation should be pretty-printed, False if representation should be as compact as possible.

  • remove_uids (bool (default True)) – True if trace UIDs should be omitted from the JSON representation

  • engine (str (default None)) –

    The JSON encoding engine to use. One of:
    • ”json” for an engine based on the built-in Python json module

    • ”orjson” for a faster engine that requires the orjson package

    • ”auto” for the “orjson” engine if available, otherwise “json”

    If not specified, the default engine is set to the current value of


Return type