mlreportgen.dom.TableFooter class

Package: mlreportgen.dom
Superclasses:

Formal table footer

Description

Specifies the content and format of a formal table footer.

Properties

Children — Children of document element

array of DOM objects

Children of this document element, specified as an array of DOM objects. This property is read-only.

ColSep — Style of line separating columns

character vector

The style of the line separating the columns of a table or table section (header, body, footer), as specified by an mlreportgen.dom.ColSep object.

See the description of the Border property for a description of the possible values.

ColSepColor — Color of line separating columns

character vector

Color of line separating columns, specified as either:

• Name of a color. The name must be a CSS color name. See https://www.crockford.com/wrrrld/color.html.

• A hexadecimal RGB (truecolor) value as #RRGGBB. For example, #0000ff is a shade of blue.

ColSepWidth — Width of line separating table columns

character vector

Width of the line separating table columns, in the form valueUnits. Use one of these abbreviations for the Units:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

For example, for a column separator of 3 points, set the ColSepWidth property to '3pt'.

Id — ID for this document element

character vector | string scalar

ID for this document element, specified as a character vector or string scalar. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Parent — Parent of document element

DOM object

Parent of this document element, specified as a DOM object. This property is read-only.

RowSep — Style of lines separating rows

character vector

The style of a line separating the rows of a table or table section (header, body, or footer).

See the description of the Border property for a description of the possible values.

RowSepColor — Color of lines separating table rows

character vector

Color of lines separating table rows, specified as one of these values:

• The name of a color. See the mlreportGen.dom.Color class reference page for a list of supported colors.

• A hexadecimal RGB (truecolor) value as #RRGGBB. For example, #0000ff is a shade of blue.

RowSepWidth — Width of lines separating table rows

character vector

Width of lines separating table rows in the form valueUnits, where Units is an abbreviation for the units. Use one of these abbreviations:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Style — Format for the table footer

array of format objects

Array of format objects (such as Bold objects) that specify the format for the table footer.

This property overrides corresponding formats defined by the style sheet style specified by the StyleName property.

StyleName — Style in the document or document part style sheet

character vector

Name of a style specified in the style sheet of the document or document part to which the table footer is appended

Data Types: char

TableEntriesHAlign — Horizontal alignment of table entries

'center' (default) | 'left' | 'right'

Horizontal alignment of table entries, specified as 'center', 'left', or 'right'.

Data Types: char

TableEntriesInnerMargin — Inner margin for table entries

character vector

The inner margin is the margin between table cell content and the cell borders in the form valueUnits where Units is an abbreviation for the units. Valid abbreviations are:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

TableEntriesStyle — Style to use for table entries

cell array

Cell array of format objects that specify the format for table entries.

TableEntriesVAlign — Vertical alignment of table cell content

'top' | 'middle' | 'bottom'

Vertical alignment of table cell content, specified as one of these values:

• 'top'

• 'middle'

• 'bottom'

Tag — Tag for this document element

character vector | string scalar

Tag for this document element, specified as a character vector or string scalar.

The DOM generates a session-unique tag as part of the creation of this object. The generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value of the Id property of the object. Specifying your own tag value can help you to identify where an issue occurred during document generation.

Methods

Method	Purpose
append	Appends a row of table entries to this table footer.
entry	Get a footer entry
row	Get a footer row