appendFooterRow

Class: mlreportgen.dom.FormalTable
Package: mlreportgen.dom

Append row to table footer

Syntax

rowObjOut = appendFooterRow(tableObj,rowObj)

Description

rowObjOut = appendFooterRow(tableObj,rowObj) appends a row of table entries to the footer of a table.

Examples

Append a Table Footer

Create, format, and append a formal table.

import mlreportgen.dom.*;
myReport = Document('myDoc','html');

table = FormalTable({'row1 - col1' 'row1 - col2 ';...
    'row2 - col1' 'row2 - col2'});
table.Style = {Border('double'),ColSep('solid'),RowSep('solid')};
append(myReport,table);

Create a row (and its entries) for the footer. Use bold text for the text in the row.

rowForFooter = TableRow();
rowForFooter.Style = {Bold(true)};
col1Title = TableEntry('Column 1 footer');
col2Title = TableEntry('Column 2 footer');
append(rowForFooter,col1Title);
append(rowForFooter,col2Title);

Append the footer row and display the report.

footerRow = appendFooterRow(table,rowForFooter);

close(myReport);
rptview('myDoc','html');

Input Arguments

tableObj — Table

mlreportgen.dom.FormalTable object

Table that contains the footer to append a row to.

rowObj — Row to append to table footer

mlreportgen.dom.TableRow object

Row to append to the table footer, specified as an mlreportgen.dom.TableRow object.

Output Arguments

rowObjOut — Row appended to table footer

mlreportgen.dom.TableRow object

Row appended to the table footer, represented by an mlreportgen.dom.TableRow object.