rs_rich.layout

Generated from the type stubs by scripts/gen_python_api.py; do not edit.

rich.layout: Layout, a region divided into rows and columns.

ColumnSplitter

Bases: Splitter

rich.layout.ColumnSplitter: children stacked.

get_tree_icon

get_tree_icon() -> str

divide

divide(children: Iterable[Layout], region: Region) -> List[Tuple[Layout, Region]]

Layout

rich.layout.Layout: divide a fixed height into rows or columns.

splitters instance-attribute

splitters: Dict[str, type]

size instance-attribute

size: Optional[int]

minimum_size instance-attribute

minimum_size: int

ratio instance-attribute

ratio: int

name instance-attribute

name: Optional[str]

visible instance-attribute

visible: bool

splitter instance-attribute

splitter: Splitter

renderable property

renderable: RenderableType

children property

children: List[Layout]

map property

map: Dict[Layout, LayoutRender]

tree property

tree: Tree

get

get(name: str) -> Optional[Layout]

split

split(*layouts: Union[Layout, RenderableType], splitter: Union[Splitter, str] = 'column') -> None

add_split

add_split(*layouts: Union[Layout, RenderableType]) -> None

split_row

split_row(*layouts: Union[Layout, RenderableType]) -> None

split_column

split_column(*layouts: Union[Layout, RenderableType]) -> None

unsplit

unsplit() -> None

update

update(renderable: RenderableType) -> None

refresh_screen

refresh_screen(console: Console, layout_name: str) -> None

render

render(console: Console, options: ConsoleOptions) -> Dict[Layout, LayoutRender]

LayoutError

Bases: Exception

rich.layout.LayoutError: a layout related error.

LayoutRender

Bases: NamedTuple

rich.layout.LayoutRender: one leaf's region and rendered lines.

region instance-attribute

region: Region

render instance-attribute

render: List[List[Segment]]

NoSplitter

Bases: LayoutError

rich.layout.NoSplitter: the requested splitter does not exist.

Region

Bases: NamedTuple

rich.region.Region: a rectangle of the screen.

x instance-attribute

x: int

y instance-attribute

y: int

width instance-attribute

width: int

height instance-attribute

height: int

RowSplitter

Bases: Splitter

rich.layout.RowSplitter: children side by side.

get_tree_icon

get_tree_icon() -> str

divide

divide(children: Iterable[Layout], region: Region) -> List[Tuple[Layout, Region]]

Splitter

rich.layout.Splitter: divides a region among child layouts.

name instance-attribute

name: str