Skip to content

Console output

Functions:

Name Description
create_series_table

Create a rich Table from the series data.

create_studies_table

Create a rich Table from the studies data.

create_series_table

create_series_table(
    series: list[SeriesData],
    title: str = "Series found",
    columns: list[ColumnLayout] | None = None,
) -> Table

Create a rich Table from the series data.

Parameters:

Name Type Description Default

series

list[SeriesData]

series to display.

required

title

str

table title.

'Series found'

columns

list[ColumnLayout] | None

columns to display. If None uses the default columns.

None

Returns:

Type Description
Table

table

create_studies_table

create_studies_table(
    studies: list[StudyData],
    title: str = "Studies found",
    columns: list[ColumnLayout] | None = None,
) -> Table

Create a rich Table from the studies data.

Parameters:

Name Type Description Default

studies

list[StudyData]

studies to display.

required

title

str

table title.

'Studies found'

columns

list[ColumnLayout] | None

columns to display. If None uses the default columns.

None

Returns:

Type Description
Table

table