rich.layout

class rich.layout.ColumnSplitter

将布局区域拆分为多个列。

divide(children, region)

在多个子布局中划分一个区域。

参数

• children (Sequence(Layout)) -- 许多子布局。

• region (Region) -- 要分割的矩形区域。

返回类型

Iterable[Tuple[Layout, Region]]

get_tree_icon()

获取layout中使用的图标(Emoji)。tree

返回类型

str

class rich.layout.Layout(renderable=None, *, name=None, size=None, minimum_size=1, ratio=1, visible=True)

可将固定高度划分为行或列的呈现器。

参数

• renderable (RenderableType, optional) -- 可呈现内容，或占位符为无。默认为无。

• name (str, optional) -- 布局的可选标识符。默认为无。

• size (int, optional) -- 可选固定大小的布局。默认为无。

• minimum_size (int, optional) -- 布局的最小尺寸。默认为1。

• ratio (int, optional) -- 灵活布局的可选比例。默认为1。

• visible (bool, optional) -- 布局的可见性。默认为True。

add_split(*layouts)

将新布局(S)添加到现有拆分。

参数

*layouts (Union[Layout, RenderableType]) -- 位置参数应该是可呈现的或(子)布局实例。

返回类型

None

property children: List[Layout]

获取(可见)布局子项。

get(name)

获取命名布局，如果该布局不存在，则不获取。

参数

name (str) -- 布局的名称。

返回

Layout实例；如果未找到布局，则为None。

返回类型

Optional[Layout]

property map: Dict[Layout, LayoutRender]

获取上次渲染的贴图。

refresh_screen(console, layout_name)

刷新子布局。

参数

• console (Console) -- 要呈现布局的控制台实例。

• layout_name (str) -- 布局的名称。

返回类型

None

render(console, options)

渲染子布局。

参数

• console (Console) -- 控制台实例。

• options (ConsoleOptions) -- 控制台选项。

返回

将布局映射到区域、线的元组的词典

返回类型

RenderMap

property renderable: Union[ConsoleRenderable, RichCast, str]

布局可渲染。

split(*layouts, splitter='column')

将布局拆分为多个子布局。

参数

• *layouts (Layout) -- 位置参数应为(子)布局实例。

• splitter (Union[Splitter, str]) -- 拆分器实例或拆分器名称。

返回类型

None

split_column(*layouts)

将版面拆分为一列(版面堆叠在一起)。

参数

*layouts (Layout) -- 位置参数应为(子)布局实例。

返回类型

None

split_row(*layouts)

将布局拆分为一行(并排布局)。

参数

*layouts (Layout) -- 位置参数应为(子)布局实例。

返回类型

None

property tree: Tree

获得一个可渲染的树来显示布局结构。

unsplit()

将拆分重置为初始状态。

返回类型

None

update(renderable)

更新可渲染。

参数

renderable (RenderableType) -- 新的可渲染对象。

返回类型

None

exception rich.layout.LayoutError

与布局相关的错误。

class rich.layout.LayoutRender(region, render)

单个布局渲染。

参数

• region (Region) --

• render (List[List[Segment]]) --

region: Region

字段号0的别名

render: List[List[Segment]]

字段号%1的别名

exception rich.layout.NoSplitter

请求的拆分器不存在。

class rich.layout.RowSplitter

将布局区域拆分为多行。

divide(children, region)

在多个子布局中划分一个区域。

参数

• children (Sequence(Layout)) -- 许多子布局。

• region (Region) -- 要分割的矩形区域。

返回类型

Iterable[Tuple[Layout, Region]]

get_tree_icon()

获取layout中使用的图标(Emoji)。tree

返回类型

str

class rich.layout.Splitter

拆分器的基类。

abstract divide(children, region)

在多个子布局中划分一个区域。

参数

• children (Sequence(Layout)) -- 许多子布局。

• region (Region) -- 要分割的矩形区域。

返回类型

Iterable[Tuple[Layout, Region]]

abstract get_tree_icon()

获取layout中使用的图标(Emoji)。tree

返回类型

str