Public Member Functions
None	__init__ (self, Optional[RenderableType] renderable=None, *Optional[str] name=None, Optional[int] size=None, int minimum_size=1, int ratio=1, bool visible=True)

Result	__rich_repr__ (self)

RenderableType	renderable (self)

List["Layout"]	children (self)

RenderMap	map (self)

Optional["Layout"]	get (self, str name)

"Layout"	__getitem__ (self, str name)

"Tree"	tree (self)

None	split (self, *Union["Layout", RenderableType] layouts, Union[Splitter, str] splitter="column")

None	add_split (self, *Union["Layout", RenderableType] layouts)

None	split_row (self, *Union["Layout", RenderableType] layouts)

None	split_column (self, *Union["Layout", RenderableType] layouts)

None	unsplit (self)

None	update (self, RenderableType renderable)

None	refresh_screen (self, "Console" console, str layout_name)

RenderMap	render (self, Console console, ConsoleOptions options)

RenderResult	__rich_console__ (self, Console console, ConsoleOptions options)

Public Attributes
	size

	minimum_size

	ratio

	name

	visible

	splitter

Static Public Attributes
dict	splitters = {"row": RowSplitter, "column": ColumnSplitter}

Protected Member Functions
RegionMap	_make_region_map (self, int width, int height)

Protected Attributes
	_renderable

	_lock

	_render_map

Detailed Description

A renderable to divide a fixed height in to rows or columns.

Args:
    renderable (RenderableType, optional): Renderable content, or None for placeholder. Defaults to None.
    name (str, optional): Optional identifier for Layout. Defaults to None.
    size (int, optional): Optional fixed size of layout. Defaults to None.
    minimum_size (int, optional): Minimum size of layout. Defaults to 1.
    ratio (int, optional): Optional ratio for flexible layout. Defaults to 1.
    visible (bool, optional): Visibility of layout. Defaults to True.

Member Function Documentation

◆ _make_region_map()

RegionMap pip._vendor.rich.layout.Layout._make_region_map	(		self,
		int	width,
		int	height
	)

protected

Create a dict that maps layout on to Region.

◆ add_split()

None pip._vendor.rich.layout.Layout.add_split	(		self,
		*Union["Layout", RenderableType]	layouts
	)

Add a new layout(s) to existing split.

Args:
    *layouts (Union[Layout, RenderableType]): Positional arguments should be renderables or (sub) Layout instances.

◆ children()

List["Layout"] pip._vendor.rich.layout.Layout.children ( self )

Gets (visible) layout children.

◆ get()

Optional["Layout"] pip._vendor.rich.layout.Layout.get	(		self,
		str	name
	)

Get a named layout, or None if it doesn't exist.

Args:
    name (str): Name of layout.

Returns:
    Optional[Layout]: Layout instance or None if no layout was found.

◆ map()

RenderMap pip._vendor.rich.layout.Layout.map ( self )

Get a map of the last render.

◆ refresh_screen()

None pip._vendor.rich.layout.Layout.refresh_screen	(		self,
		"Console"	console,
		str	layout_name
	)

Refresh a sub-layout.

Args:
    console (Console): Console instance where Layout is to be rendered.
    layout_name (str): Name of layout.

◆ render()

RenderMap pip._vendor.rich.layout.Layout.render	(		self,
		Console	console,
		ConsoleOptions	options
	)

Render the sub_layouts.

Args:
    console (Console): Console instance.
    options (ConsoleOptions): Console options.

Returns:
    RenderMap: A dict that maps Layout on to a tuple of Region, lines

◆ renderable()

RenderableType pip._vendor.rich.layout.Layout.renderable ( self )

Layout renderable.

◆ split()

None pip._vendor.rich.layout.Layout.split	(		self,
		*Union["Layout", RenderableType]	layouts,
		Union[Splitter, str]	splitter = `"column"`
	)

Split the layout in to multiple sub-layouts.

Args:
    *layouts (Layout): Positional arguments should be (sub) Layout instances.
    splitter (Union[Splitter, str]): Splitter instance or name of splitter.

◆ split_column()

None pip._vendor.rich.layout.Layout.split_column	(		self,
		*Union["Layout", RenderableType]	layouts
	)

Split the layout in to a column (layouts stacked on top of each other).

Args:
    *layouts (Layout): Positional arguments should be (sub) Layout instances.

◆ split_row()

None pip._vendor.rich.layout.Layout.split_row	(		self,
		*Union["Layout", RenderableType]	layouts
	)

Split the layout in to a row (layouts side by side).

Args:
    *layouts (Layout): Positional arguments should be (sub) Layout instances.

◆ tree()

"Tree" pip._vendor.rich.layout.Layout.tree ( self )

Get a tree renderable to show layout structure.

◆ unsplit()

None pip._vendor.rich.layout.Layout.unsplit ( self )

Reset splits to initial state.

◆ update()

None pip._vendor.rich.layout.Layout.update	(		self,
		RenderableType	renderable
	)

Update renderable.

Args:
    renderable (RenderableType): New renderable object.

The documentation for this class was generated from the following file:

docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/rich/layout.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes