bosing.Stack¶

class bosing.Stack(*children, direction=None, margin=None, alignment=None, phantom=False, duration=None, max_duration=Ellipsis, min_duration=Ellipsis, label=None)¶

基类：Element

A stack layout element.

Each child element occupies some channels and has a duration. Stack layout will put children as close as possible without changing the order of children with common channels. Two layout orders are available: Direction.Backward and Direction.Forward. The default order is Direction.Backward.

参数:

*children (Element) -- Child elements.
direction (str | Direction) -- Layout order. Defaults to 'backward'.

alignment¶

children¶

direction¶

duration¶

label¶

margin¶

max_duration¶

measure()¶

Measure the minimum total duration required by the element.

This value includes both inner duration and outer margin of the element.

This value is a minimum total duration wanted by the element. If the element is a child of other element, the final total duration will be determined by alignment option and parent container type.

min_duration¶

phantom¶

plot(ax=None, *, channels=None, max_depth=5, show_label=True)¶

Plot arrange result with the element as root.

参数:

ax (matplotlib.axes.Axes | None) -- Axes to plot. If None, matplotlib.pyplot.gca is used.
channels (Sequence[str] | None) -- Channels to plot. If None, all channels are plotted.
max_depth (int) -- Maximum depth to plot. Defaults to 5.
show_label (bool) -- Whether to show label of elements. Defaults to True.

返回:

Axes with the plot.

返回类型:

matplotlib.axes.Axes

with_children(*children)¶

Create a new stack layout with different children.

Using this method may be more readable than specifying children in the constructor.

stack = Stack(direction='forward').with_children(
    element1,
    element2,
)

参数:: *children (Element) -- New child elements.
返回:: New stack layout.
返回类型:: Stack