graphinglib.SmartFigure.add_elements#

SmartFigure.add_elements(*elements: Plottable | SmartFigure | None | Iterable[Plottable | None]) → Self[source]#

Adds one or more Plottable objects to the current SmartFigure.

If the SmartFigure is used as a single plot, the elements are appended to that plot. If the SmartFigure is used as a layout, the elements are applied to the grid from left to right, then top to bottom. Existing child plots are appended to, and empty positions are filled by creating new child plots as needed. This method is equivalent to using the __setitem__() method for single cells, but can only add elements spanning single subplots.

Parameters:

elementsPlottable | Iterable[Plottable]: Elements to plot in the SmartFigure. Iterables of Plottable objects can be provided to add multiple elements to the same plot. If the SmartFigure is used as a single plot, all provided elements are added to that plot. If the SmartFigure is used as a layout, the given elements are applied to the grid from left to right, then top to bottom. Existing child plots are appended to, and empty positions are filled by creating new child plots as needed. If None elements are present, the corresponding target is skipped.

Note

This method can create new 1x1 child plots when filling an existing layout, but it does not create multi-cell spans. If you want to add elements that span multiple subplots, you should use the __setitem__() method instead.

Returns:

Self: For convenience, the same SmartFigure with the added elements.