XlsExportDataFrameFilter#

class pyCGM2.Processing.exporter.XlsExportDataFrameFilter#

Filter for exporting a pandas DataFrame or a list of pandas DataFrames as XLS or XLSX spreadsheets.

dataframes#

List of DataFrames to be exported.

Type:

List[pd.DataFrame]

__init__()#

Methods

__init__()

export(outputName[, path, excelFormat])

Export the DataFrame(s) as XLS or XLSX spreadsheet(s).

setDataFrames(dataframes)

Set the DataFrame(s) to be exported.

export(outputName: str, path: str | None = None, excelFormat: str = 'xls')#

Export the DataFrame(s) as XLS or XLSX spreadsheet(s).

Parameters:
  • outputName (str) – Base filename for the output file(s), without extension.

  • path (Optional[str]) – Directory path for the output file(s). If None, the current directory is used.

  • excelFormat (str) – Desired spreadsheet format (‘xls’ or ‘xlsx’).

setDataFrames(dataframes: DataFrame | List[DataFrame])#

Set the DataFrame(s) to be exported.

Parameters:

dataframes (Union[pd.DataFrame, List[pd.DataFrame]]) – A single DataFrame or a list of DataFrames.