API Reference

The main entry point for matplotly is the matplotly.matplotly() function. It can be used as a direct call, a decorator, or a context manager — see Quick Start for usage examples.

matplotly.matplotly(target: Figure | Any | None = None)

Interactive matplotlib figure editor.

Parameters:

target (Figure, callable, or None) –

  • Figure: opens the editor on that figure immediately.

  • callable: decorator mode — calls the function, captures plt.gcf(), and opens the editor.

  • None: returns a context manager.