PanelsApi

The Artisan command panel (the side panel a tool such as ArtisanBail opens, with its live preview). Panels are interactive and cannot be driven headless — use the *Api creators instead — but a script that opened one through a command line can see it and close it.

from ArtisanPlugin.Scripting import PanelsApi

See also the Python package, ra.panels.

Methods

Method
Active	The command panel currently open (“Bail”, “Cutter”, “Basket”…), or null when none is.
Close	Closes the open command panel WITHOUT applying it, like its X button: the live preview is discarded and objects hidden while editing come back.

Active

string PanelsApi.Active()

The command panel currently open (“Bail”, “Cutter”, “Basket”…), or null when none is.

Returns string.

Close

string PanelsApi.Close()

Closes the open command panel WITHOUT applying it, like its X button: the live preview is discarded and objects hidden while editing come back. Returns the closed panel’s name, or null when none was open.

Returns string.