textual.strip
This module contains the Strip
class and related objects.
A Strip
contains the result of rendering a widget.
See Line API for how to use Strips.
Strip ¶
Represents a 'strip' (horizontal line) of a Textual Widget.
A Strip is like an immutable list of Segments. The immutability allows for effective caching.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
segments |
Iterable[Segment]
|
An iterable of segments. |
required |
cell_length |
int | None
|
The cell length if known, or None to calculate on demand. |
None
|
adjust_cell_length ¶
align
classmethod
¶
Align a list of strips on both axis.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
strips |
list[Strip]
|
A list of strips, such as from a render. |
required |
style |
Style
|
The Rich style of additional space. |
required |
width |
int
|
Width of container. |
required |
height |
int | None
|
Height of container. |
required |
horizontal |
AlignHorizontal
|
Horizontal alignment method. |
required |
vertical |
AlignVertical
|
Vertical alignment method. |
required |
Returns:
Type | Description |
---|---|
Iterable[Strip]
|
An iterable of strips, with additional padding. |
apply_filter ¶
Apply a filter to all segments in the strip.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
filter |
LineFilter
|
A line filter object. |
required |
Returns:
Type | Description |
---|---|
Strip
|
A new Strip. |
apply_meta ¶
apply_offsets ¶
apply_style ¶
blank
classmethod
¶
crop ¶
crop_extend ¶
crop_pad ¶
Crop the strip to cell_length
, and add optional padding.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cell_length |
int
|
Cell length of strip prior to padding. |
required |
left |
int
|
Additional padding on the left. |
required |
right |
int
|
Additional padding on the right. |
required |
style |
Style
|
Style of any padding. |
required |
Returns:
Type | Description |
---|---|
Strip
|
Cropped and padded strip. |
discard_meta ¶
divide ¶
extend_cell_length ¶
from_lines
classmethod
¶
Convert lines (lists of segments) to a list of Strips.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
lines |
list[list[Segment]]
|
List of lines, where a line is a list of segments. |
required |
cell_length |
int | None
|
Cell length of lines (must be same) or None if not known. |
None
|
Returns:
Type | Description |
---|---|
list[Strip]
|
List of strips. |
index_to_cell_position ¶
Given a character index, return the cell position of that character.
This is the sum of the cell lengths of all the characters before the character
at index
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
index |
int
|
The index to convert. |
required |
Returns:
Type | Description |
---|---|
int
|
The cell position of the character at |
join
classmethod
¶
simplify ¶
StripRenderable ¶
A renderable which renders a list of strips into lines.