rich.layout

class rich.layout.ColumnSplitter

レイアウト領域を列に分割します。

divide(children, region)

領域を複数の子レイアウトに分割します。

パラメータ

• children (Sequence(Layout)) – 子レイアウトの数。

• region (Region) – 分割する矩形領域。

戻り値の型

Iterable[Tuple[Layout, Region]]

get_tree_icon()

layout.treeで使用されるアイコン（絵文字）を取得します。

戻り値の型

str

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

固定の高さを複数の行または列に分割するためのレンダリング可能なオブジェクトです。

パラメータ

• renderable (RenderableType, オプション) – レンダリング可能なコンテンツ、プレースホルダーの場合はNone。デフォルトはNoneです。

• name (str, オプション) – レイアウトのオプションの識別子。デフォルトはNoneです。

• size (int, オプション) – レイアウトのオプションの固定サイズ。デフォルトはNoneです。

• minimum_size (int, オプション) – レイアウトの最小サイズ。デフォルトは1です。

• ratio (int, オプション) – フレキシブルレイアウトのオプションの比率。デフォルトは1です。

• visible (bool, オプション) – レイアウトの可否。デフォルトはTrueです。

add_split(*layouts)

既存の分割に新しいレイアウトを追加します。

パラメータ

*layouts (Union[Layout, RenderableType]) – 位置引数は、レンダリング可能オブジェクトまたは（サブ）レイアウトインスタンスにする必要があります。

戻り値の型

なし

property children: List[Layout]

（表示されている）レイアウトの子を取得します。

get(name)

名前付きレイアウトを取得します。存在しない場合はNoneを返します。

パラメータ

name (str) – レイアウトの名前。

戻り値

レイアウトインスタンス、レイアウトが見つからない場合はNone。

戻り値の型

Optional[Layout]

property map: Dict[Layout, LayoutRender]

最後のレンダリングのマップを取得します。

refresh_screen(console, layout_name)

サブレ イアウトを更新します。

パラメータ

• console (Console) – レイアウトをレンダリングするコンソールインスタンス。

• layout_name (str) – レイアウトの名前。

戻り値の型

なし

render(console, options)

サブレ イアウトをレンダリングします。

パラメータ

• console (Console) – コンソールインスタンス。

• options (ConsoleOptions) – コンソールオプション。

戻り値

レイアウトを領域と行のタプルにマッピングする辞書

戻り値の型

RenderMap

property renderable: Union[ConsoleRenderable, RichCast, str]

レイアウトのレンダリング可能オブジェクト。

split(*layouts, splitter='column')

レイアウトを複数のサブレ イアウトに分割します。

パラメータ

• *layouts (Layout) – 位置引数は、（サブ）レイアウトインスタンスにする必要があります。

• splitter (Union[Splitter, str]) – スプリッターインスタンスまたはスプリッターの名前。

戻り値の型

なし

split_column(*layouts)

レイアウトを列に分割します（レイアウトは互いに積み重ねられます）。

パラメータ

*layouts (Layout) – 位置引数は、（サブ）レイアウトインスタンスにする必要があります。

戻り値の型

なし

split_row(*layouts)

レイアウトを行に分割します（レイアウトは横に並べられます）。

パラメータ

*layouts (Layout) – 位置引数は、（サブ）レイアウトインスタンスにする必要があります。

戻り値の型

なし

property tree: Tree

レイアウト構造を表示するためのツリーレンダラブルを取得します。

unsplit()

分割を初期状態にリセットします。

戻り値の型

なし

update(renderable)

レンダラブルを更新します。

パラメータ

renderable (RenderableType) – 新しいレンダラブルオブジェクト。

戻り値の型

なし

exception rich.layout.LayoutError

レイアウト関連のエラー。

class rich.layout.LayoutRender(region, render)

個々のレイアウトレンダリング。

パラメータ

• region (Region) –

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

property region

フィールド番号0のエイリアス

property render

フィールド番号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.treeで使用されるアイコン（絵文字）を取得します。

戻り値の型

str

class rich.layout.Splitter

スプリッターの基底クラス。

abstract divide(children, region)

領域を複数の子レイアウトに分割します。

パラメータ

• children (Sequence(Layout)) – 子レイアウトの数。

• region (Region) – 分割する矩形領域。

戻り値の型

Iterable[Tuple[Layout, Region]]

abstract get_tree_icon()

layout.treeで使用されるアイコン（絵文字）を取得します。

戻り値の型

str