Plot Inspection

plotext exposes a small set of helpers for poking at the live state of a plot, useful when investigating layout problems or profiling renders.

Navigate

Once a tree of subplots has been built, the following methods navigate it:

parent(): returns the parent plot at the given nesting level: 0 is the plot itself, 1 (the default) its immediate parent, and so on; above the master sits the terminal object, which is its own parent.
master(): returns the master plot at the top of the tree, that is plotext.figure itself.
position(): returns the subplot position (row, col) within its parent grid, (None, None) for the master.
size(): returns the subplot size (width, height) in terminal characters.

Note

The tree itself can be printed with the log() methods, described below.

Subplots Log

The log() method, available on any plot or subplot, prints that plot and every nested subplot, one indented line each, showing position, size and grid.

The same method on plotext.terminal prints the tree from the top, the terminal included.

For example, on the plot of the subplots page example:

fig.log()

Timing

The time() method prints a timing report of the most recent show() or build(): the total elapsed time and, when full is True (the default), a per-step breakdown for each profiled section.

Note

build() renders the figure and gives back its matrix, the grid of colored characters, which can be sliced, stacked, printed and saved.

import plotext as plt

fig = plt.figure
fig.clear()
fig.draw(fig.signal(plt.sin()).lines())
fig.show()
fig.time()

Caution

This is a developer oriented tool, meant for investigating slow renders more than for everyday plotting.