mlreportgen.dom.TableBody class

Package: mlreportgen.dom
Superclasses:

Body of formal table

Description

Specifies the body of a formal table

Properties

Children — Children of this object

cell array of objects

This read-only property lists child elements of this object.

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 a 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 document element

character vector

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

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.

Parent — Parent of document element

DOM object

This read-only property lists the parent of this document element.

Style — Format specification

array of format objects

Format objects that specify the format of a document element.

Stylename — Table body style name

character vector

The style specified by styleName must be defined in the template used to create the document element to which this table body is appended.

TableEntriesHAlign — Horizontal alignment of table entries

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

Horizontal alignment of table entries, specified as one of these values:

• 'center'

• 'left'

• 'right'

Data Types: char

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'

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.

Tag — Tag for document element

character vector

Tag for document element, specified as a character vector.

A session-unique ID is generated as part of document element creation. The generated tag has the form CLASS:ID, where CLASS is the class of the element and ID is the value of the Id property of the object. You can specify a tag to replace the generated tag.

For example, to make it easier to identify where an issue occurred during document generation, you can specify your own tag value.

Methods

Method	Purpose
append	Appends content to a table body.
entry	Get a table entry.
row	Create a table row.