mlreportgen.dom.TableBody class

Package: mlreportgen.dom
Superclasses:

Body of formal table

Description

Specifies the body of a formal table

Properties

expand all

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

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.

Color of line separating columns, specified as either:

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 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.

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.

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.

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

Format objects that specify the format of a document element.

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

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

  • 'center'

  • 'left'

  • 'right'

Data Types: char

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

  • 'top'

  • 'middle'

  • 'bottom'

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

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

Tag for the document element, specified as a character vector.

The DOM generates a session-unique tag when it creates the document element. Structure the tag as class:id, where class is the class of the element and id is the value of the Id property. You can specify a tag to replace the generated tag. Specifying your own tag can make it easier to identify where an issue occurred during document generation.

Methods

Method

Purpose

append

Appends content to a table body.

entry

Get a table entry.

row

Create a table row.