report.Table

report.Table#

class Table#

Bases: ReportItem

Represents a table within a report, with configurable data and headers.

Attributes

data: list[str | Delta | DataItem]#

A list of table data entries, which can be either strings or Delta objects.

section_title: str, optional#

The title of the table section.

headers: Optional[list[str]]#

List of column headers for the table, default is None.

Default:

None

select_indices: list[int], optional#

Specific indices to select for the chart.

Default:

None

formatter: str | list[str, optional], optional#

Formatter can be a single str (e.g. “.4g”) or a list of str of the same length as data

Default:

None

Additional Constructors

classmethod from_file(filename)#

Load a Flow360BaseModel from a .json file.

Parameters:

filename (str)

Return type:

Flow360BaseModel

Methods

get_requirements()#

Returns requirements for this item

calculate_table_data(context)#

Calculate raw table data (headers + rows) without formatting.

Returns:

(headers, rows)

headers: list of column names (strings) rows: list of rows, each row is a list of cell values

Parameters:

context (ReportContext)

Return type:

Tuple[List[str], List[List]]

to_dataframe(context)#

Convert calculated data into a Pandas DataFrame for unit-testing or external usage.

Parameters:

context (ReportContext)

get_doc_item(context, settings=None)#

Returns a LaTeX doc item (Tabulary) for the table, using previously calculated data.

Parameters:

  • context (ReportContext)

  • settings (Settings | None)

Return type:

None

help(methods=False)#

Print fields and methods of a Flow360BaseModel using rich.

Parameters:

methods (bool)

Return type:

None

to_file(filename, **kwargs)#

Export Flow360BaseModel instance to a .json file.

Parameters:
Return type:

None