mlreportgen.dom.FormalTable Class

Namespace: mlreportgen.dom

Formal table

Description

Defines a formal table, which is a table that has a body and optionally a table header, a table footer, or both. The table header, body, and footer are mlreportgen.dom.TableHeader, mlreportgen.dom.TableBody, and mlreportgen.dom.TableFooter objects, respectively.

The mlreportgen.dom.FormalTable class is a handle class.

Creation

Description

formalTableObj = FormalTable creates an empty formal table. Use this constructor as the starting point to create a formal table from scratch.

formalTableObj = FormalTable(ncols) creates an empty formal table having the specified number of columns.

formalTableObj = FormalTable(body) creates a formal table with the body content specified. The constructor converts basic MATLAB^® types to corresponding DOM objects. For example, the constructor converts character vectors to mlreportgen.dom.Text objects.

formalTableObj = FormalTable(body,styleName) creates a formal table having the specified body content and style.

formalTableObj = FormalTable(header,body) creates a formal table with a header and a body using the specified contents, and an empty footer.

formalTableObj = FormalTable(header,body,styleName) creates a formal table using the specified content and style. The table has an empty footer.

formalTableObj = FormalTable(header,body,footer) creates a formal table with the specified content for the body, header, and footer.

Note

Microsoft^® Word automatically combines consecutive tables with matching style names into a single table. To render consecutive tables as separate tables in DOCX reports, do one of these options:

• Set the style names of the consecutive tables to different values.

• Insert some content in between the tables. For example, insert an empty mlreportgen.dom.Paragraph element between the tables.

Input Arguments

ncols — Number of columns in table

numeric value

Number of columns in a table, specified as a numeric value.

Data Types: double

body — Table body content

two-dimensional numeric array | two-dimensional categorical array | two-dimensional cell array

Table body content, specified as:

• A two-dimensional numeric array

• A two-dimensional categorical array

• A two-dimensional cell array that can contain:

  • Character vectors

  • One- or two-dimensional cell array

  • double

  • mlreportgen.dom.Text object

  • mlreportgen.dom.Paragraph object

  • mlreportgen.dom.Image object

  • mlreportgen.dom.Table object

  • mlreportgen.dom.FormalTable object

  • mlreportgen.dom.OrderedList object

  • mlreportgen.dom.UnorderedList object

  • mlreportgen.dom.ExternalLink object

  • mlreportgen.dom.InternalLink object

  • mlreportgen.dom.CharEntity object

styleName — Style for table

string scalar | character vector

Style for the table, specified as a character vector or string scalar. The style in this property must be defined in the template used to create the document that contains this table.

header — Header content

two-dimensional numeric array | two-dimensional cell array of character vectors

The cell array may contain:

• Character vectors

• One- or two-dimensional cell array

• double

• mlreportgen.dom.Text object

• mlreportgen.dom.Paragraph object

• mlreportgen.dom.Image object

• mlreportgen.dom.Table object

• mlreportgen.dom.FormalTable object

• mlreportgen.dom.OrderedList object

• mlreportgen.dom.UnorderedList object

• mlreportgen.dom.ExternalLink object

• mlreportgen.dom.InternalLink object

• mlreportgen.dom.CharEntity object

footer — Footer content

two-dimensional numeric array | two-dimensional cell array of character vectors

The cell array may contain:

• Character vectors

• One- or two-dimensional cell array

• double

• mlreportgen.dom.Text object

• mlreportgen.dom.Paragraph object

• mlreportgen.dom.Image object

• mlreportgen.dom.Table object

• mlreportgen.dom.FormalTable object

• mlreportgen.dom.OrderedList object

• mlreportgen.dom.UnorderedList object

• mlreportgen.dom.ExternalLink object

• mlreportgen.dom.InternalLink object

• mlreportgen.dom.CharEntity object

Properties

BackgroundColor — Background color

[] (default) | character vector | string scalar

Background color that contains a CSS color name or a hexadecimal RGB value, specified as a character vector or string scalar.

• To use the name of a color, specify a CSS color name. For a list of CSS color names, seehttps://www.w3.org/wiki/CSS/Properties/color/keywords.

• To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, "#0000ff" specifies blue.

Note

Setting the BackgroundColor property adds a mlreportgen.dom.BackgroundColor format object to the Style property. Setting the BackgroundColor property to an empty value removes the object.

Example: "blue"

Example: "#0000ff"

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Body — Table body

mlreportgen.dom.TableBody object

The table constructor creates a mlreportgen.dom.TableBody object and assigns it to this property when the formal table is constructed. You cannot subsequently set this property. However, you can append content to the table body and set its properties via this property.

Attributes:

GetAccess	public
SetAccess	private
Transient	true
NonCopyable	true

Border — Type of border to draw

[] (default) | "dashed" | "dashdotstroked" | "dashsmallgap" | ...

Type of border to draw, specified as one of these values:

Border Style	Description	Supported in Microsoft Word	Supported in HTML and PDF
"dashed"	Dashed line	yes	yes
"dashdotstroked"	Line with alternating diagonal dashes and dot	yes	yes
"dashsmallgap"	Dashed line with a small gap between dashes	yes	yes
"dotted"	Dotted line	yes	yes
"dotdash"	Line with alternating dots and dashes	yes	no
"dotdotdash"	Line with alternating double dots and a dash	yes	no
"double"	Double line	yes	yes
"doublewave"	Double wavy line	yes	no
"groove"	3-D effect grooved line	no	yes
"hidden"	No line When there is a conflicting border style, the "hidden" border style takes precedence over the conflicting border style, which results in no line displaying.	no	yes
"inset"	3-D effect line	no	yes
"none"	No line When there is a conflicting border style, the conflicting border style takes precedence over "none", which results in the conflicting border style displaying.	yes	yes
"outset"	3-D effect line	yes	yes
"ridge"	3-D effect ridged line	no	yes
"single"	Single line	yes	yes
"solid"	Single line	no	yes
"thick"	Thick line	yes	no
"thickthinlargegap"	Dashed line with alternating thick and thin dashes with a large gap	yes	no
"thickthinmediumgap"	Dashed line with alternating thick and thin dashes with a medium gap	yes	no
"thickthinsmallgap"	Dashed line with alternating thick and thin dashes with a small gap	yes	no
"thinthicklargegap"	Dashed line with alternating thin and thick dashes with a large gap	yes	no
"thinthickmediumgap"	Dashed line with alternating thin and thick dashes with a medium gap	yes	no
"thinthicksmallgap"	Dashed line with alternating thin and thick dashes with a small gap	yes	no
"thinthickthinlargegap"	Dashed line with alternating thin and thick dashes with a large gap	yes	no
"thinthickthinmediumgap"	Dashed line with alternating thin and thick dashes with a medium gap	yes	no
"thinthickthinsmallgap"	Dashed line with alternating thin and thick dashes with a small gap	yes	no
"threedemboss"	Embossed effect line	yes	no
"threedengrave"	Engraved effect line	yes	no
"triple"	Triple line	yes	no
"wave"	Wavy line	yes	no

Note

For Microsoft Word reports, when you assign an mlreportgen.dom.Border object to the Style property of an mlreportgen.dom.TableHeaderEntry, mlreportgen.dom.TableEntry, or mlreportgen.dom.HorizontalRule object, the reporter does not support "inset" or "outset" styles for this property.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

BorderCollapse — Whether to collapse borders of adjacent cells into single border

[] (default) | "on" | "off"

Whether to collapse borders of adjacent cells into a single border, specified as:

• "on" — Collapses borders of adjacent cells into a single border

• "off" — Keeps the borders of adjacent cells

Note

This property applies only to HTML documents.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

BorderColor — Border color

[] (default) | character vector | string scalar

Color of the border, specified as a character vector or string scalar that contains a CSS color name or hexadecimal RGB value.

• To use the name of a color, specify a CSS color name. For a list of CSS color names, seehttps://www.w3.org/wiki/CSS/Properties/color/keywords.

• To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, "#0000ff" specifies blue.

Example: "blue"

Example: "#0000ff"

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

BorderWidth — Table border width

[] (default) | character vector | string scalar | ...

Table border width, specified as character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "10px" specifies 10 pixels. Valid abbreviations are:

• "px" — Pixels

• "cm" — Centimeters

• "in" — Inches

• "mm" — Millimeters

• "pc" — Picas

• "pt" — Points

Example: "2pt"

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

ColSep — Style of line separating columns

[] (default) | "dashed" | "dashdotstroked" | "dashsmallgap" | ...

Style of the line that separates the columns of a table or table section, specified as one of these values:

Border Style	Description	Supported in Microsoft Word	Supported in HTML and PDF
"dashed"	Dashed line	yes	yes
"dashdotstroked"	Line with alternating diagonal dashes and dot	yes	yes
"dashsmallgap"	Dashed line with a small gap between dashes	yes	yes
"dotted"	Dotted line	yes	yes
"dotdash"	Line with alternating dots and dashes	yes	no
"dotdotdash"	Line with alternating double dots and a dash	yes	no
"double"	Double line	yes	yes
"doublewave"	Double wavy line	yes	no
"groove"	3-D effect grooved line	no	yes
"hidden"	No line When there is a conflicting border style, the "hidden" border style takes precedence over the conflicting border style, which results in no line displaying.	no	yes
"inset"	3-D effect line	no	yes
"none"	No line When there is a conflicting border style, the conflicting border style takes precedence over "none", which results in the conflicting border style displaying.	yes	yes
"outset"	3-D effect line	yes	yes
"ridge"	3-D effect ridged line	no	yes
"single"	Single line	yes	yes
"solid"	Single line	no	yes
"thick"	Thick line	yes	no
"thickthinlargegap"	Dashed line with alternating thick and thin dashes with a large gap	yes	no
"thickthinmediumgap"	Dashed line with alternating thick and thin dashes with a medium gap	yes	no
"thickthinsmallgap"	Dashed line with alternating thick and thin dashes with a small gap	yes	no
"thinthicklargegap"	Dashed line with alternating thin and thick dashes with a large gap	yes	no
"thinthickmediumgap"	Dashed line with alternating thin and thick dashes with a medium gap	yes	no
"thinthicksmallgap"	Dashed line with alternating thin and thick dashes with a small gap	yes	no
"thinthickthinlargegap"	Dashed line with alternating thin and thick dashes with a large gap	yes	no
"thinthickthinmediumgap"	Dashed line with alternating thin and thick dashes with a medium gap	yes	no
"thinthickthinsmallgap"	Dashed line with alternating thin and thick dashes with a small gap	yes	no
"threedemboss"	Embossed effect line	yes	no
"threedengrave"	Engraved effect line	yes	no
"triple"	Triple line	yes	no
"wave"	Wavy line	yes	no

Note

For Microsoft Word reports, when you assign an mlreportgen.dom.Border object to the Style property of an mlreportgen.dom.TableHeaderEntry, mlreportgen.dom.TableEntry, or mlreportgen.dom.HorizontalRule object, the reporter does not support "inset" or "outset" styles for this property.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

ColSepColor — Color of line separating columns

[] (default) | character vector | string scalar

Color of the lines that separate the columns, specified as a character vector or string scalar that contains a CSS color name or a hexadecimal RGB value.

• To use the name of a color, specify a CSS color name. For a list of CSS color names, seehttps://www.w3.org/wiki/CSS/Properties/color/keywords.

• To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, "#0000ff" specifies blue.

Example: "blue"

Example: "#0000ff"

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

ColSepWidth — Width of line separating table columns

[] (default) | character vector | string scalar

Width of the line separating table columns, specified as a character vector or string scalar that contains a number followed by an abbreviation of a unit of measurement. Valid abbreviations are:

• "px" — Pixels

• "cm" — Centimeters

• "in" — Inches

• "mm" — Millimeters

• "pc" — Picas

• "pt" — Points

Example: "10pt" specifies 10 points

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

ColSpecGroups — Properties of group of columns in table

[] (default) | array of mlreportgen.dom.TableColSpecGroup objects

Properties of group of columns in the table, specified as an array of mlreportgen.dom.TableColSpecGroup objects. The first object applies to the first group of columns, the second object to the second group, and so on. Specify the number of columns that belong to each group by using the Span property of the TableColSpecGroup object. For example, if the first object has a span of 2, it applies to the first two columns. If the second group has a span of 3, it applies to the next three columns, and so on.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

FlowDirection — Text flow direction

[] (default) | "ltr" | "rtl"

Text flow direction, specified as one of these values:

• "ltr" — Text flows from left to right

• "rtl" — Text flows from right to left

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Footer — Footer for this table

mlreportgen.dom.TableFooter object

The table constructor creates a table footer object and assigns it to this property when the formal table is constructed. You cannot subsequently set this property. However, you can append content to the table body and set its properties via this property.

Attributes:

GetAccess	public
SetAccess	private
Transient	true
NonCopyable	true

HAlign — Horizontal alignment of table

[] (default) | "center" | "left" | "right"

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

• "center"

• "left"

• "right"

Note

To prevent the overflow of large tables in PDF reports, set the Width property.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Header — Table header

mlreportgen.dom.TableHeader object

The table constructor creates a table header object and assigns it to this property when the formal table is constructed. You cannot subsequently set this property. However, you can append content to the table body and set its properties via this property.

Attributes:

GetAccess	public
SetAccess	private
Transient	true
NonCopyable	true

isSortable — Option to make table columns sortable (HTML only)

false or 0 (default) | true or 1

Since R2024a

Option to make table columns sortable, specified as a numeric or logical 1 (true) or 0 (false).

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: logical

KeepWithinPage — Whether table contents stay on same page

[] (default) | true or 1 | false or 0

Whether the table contents stay on the same page, specified as a numeric or logical 1 (true) or 0 (false). The default value is empty and is equivalent to true.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: logical

OuterLeftMargin — Left margin of table

[] (default) | character vector | string scalar

Left margin of the table, specified as a character vector or string scalar that contains a number followed by an abbreviation of a unit of measurement. Valid abbreviations are:

• "px" — Pixels

• "cm" — Centimeters

• "in" — Inches

• "mm" — Millimeters

• "pc" — Picas

• "pt" — Points

Example: "10pt" specifies 10 points

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

RowSep — Style of lines separating rows

[] (default) | "dashed" | "dashdotstroked" | "dashsmallgap" | ...

Style of the lines that separate the rows of a table or table section, specified as one of these values:

Border Style	Description	Supported in Microsoft Word	Supported in HTML and PDF
"dashed"	Dashed line	yes	yes
"dashdotstroked"	Line with alternating diagonal dashes and dot	yes	yes
"dashsmallgap"	Dashed line with a small gap between dashes	yes	yes
"dotted"	Dotted line	yes	yes
"dotdash"	Line with alternating dots and dashes	yes	no
"dotdotdash"	Line with alternating double dots and a dash	yes	no
"double"	Double line	yes	yes
"doublewave"	Double wavy line	yes	no
"groove"	3-D effect grooved line	no	yes
"hidden"	No line When there is a conflicting border style, the "hidden" border style takes precedence over the conflicting border style, which results in no line displaying.	no	yes
"inset"	3-D effect line	no	yes
"none"	No line When there is a conflicting border style, the conflicting border style takes precedence over "none", which results in the conflicting border style displaying.	yes	yes
"outset"	3-D effect line	yes	yes
"ridge"	3-D effect ridged line	no	yes
"single"	Single line	yes	yes
"solid"	Single line	no	yes
"thick"	Thick line	yes	no
"thickthinlargegap"	Dashed line with alternating thick and thin dashes with a large gap	yes	no
"thickthinmediumgap"	Dashed line with alternating thick and thin dashes with a medium gap	yes	no
"thickthinsmallgap"	Dashed line with alternating thick and thin dashes with a small gap	yes	no
"thinthicklargegap"	Dashed line with alternating thin and thick dashes with a large gap	yes	no
"thinthickmediumgap"	Dashed line with alternating thin and thick dashes with a medium gap	yes	no
"thinthicksmallgap"	Dashed line with alternating thin and thick dashes with a small gap	yes	no
"thinthickthinlargegap"	Dashed line with alternating thin and thick dashes with a large gap	yes	no
"thinthickthinmediumgap"	Dashed line with alternating thin and thick dashes with a medium gap	yes	no
"thinthickthinsmallgap"	Dashed line with alternating thin and thick dashes with a small gap	yes	no
"threedemboss"	Embossed effect line	yes	no
"threedengrave"	Engraved effect line	yes	no
"triple"	Triple line	yes	no
"wave"	Wavy line	yes	no

Note

For Microsoft Word reports, when you assign an mlreportgen.dom.Border object to the Style property of an mlreportgen.dom.TableHeaderEntry, mlreportgen.dom.TableEntry, or mlreportgen.dom.HorizontalRule object, the reporter does not support "inset" or "outset" styles for this property.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

RowSepColor — Color of lines separating table rows

[] (default) | character vector | string scalar

Color of the lines that separate table rows, specified as a character vector or string scalar that contains a CSS color name or a hexadecimal RGB value.

• To use the name of a color, specify a CSS color name. For a list of CSS color names, seehttps://www.w3.org/wiki/CSS/Properties/color/keywords.

• To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. For example, "#0000ff" specifies blue.

Example: "blue"

Example: "#0000ff"

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

RowSepWidth — Width of row separator

[] (default) | character vector | string scalar

Width of the row separator, specified as character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "10px" specifies 10 pixels. Valid abbreviations are:

• "px" — Pixels

• "cm" — Centimeters

• "in" — Inches

• "mm" — Millimeters

• "pc" — Picas

• "pt" — Points

Example: "5pt"

Attributes:

NonCopyable

true

Data Types: char | string

TableEntriesStyle — Style to use for table entries

[] (default) | cell array of format objects

Style to use for the table entries, specified as a cell array of format objects. The styles specified by this property apply to the content of the table entries and not to the entries themselves. For example, you can use this property to define the font size of the table entries but not the type or color of the entry borders. To specify the borders, set the Style property of each entry.

Note

Be careful not to inadvertently overwrite a previous setting of this property. For example, setting the table TableEntriesHAlign property appends an HAlign format object to this property. To avoid overwriting this property, set this property before setting other table properties that append formats to this property.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: cell

TableEntriesInnerMargin — Inner margin for table entries

[] (default) | character vector | string scalar

Inner margin for the table entries, specified as character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. Valid abbreviations are:

• "px" — Pixels

• "cm" — Centimeters

• "in" — Inches

• "mm" — Millimeters

• "pc" — Picas

• "pt" — Points

Example: "10px" specifies 10 pixels

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Width — Table width

[] (default) | character vector | string scalar

Table width, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "100%" specifies 100% of the page width in a PDF report, and 100% of the page width, minus the margins, for a Word report. Valid abbreviations are::

• px — Pixels

• cm — Centimeters

• in — Inches

• mm — Millimeters

• pc — Picas

• pt — Points

• % — Percent

Example: "5pt" specifies five points

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

StyleName — Style name in document or document part style sheet

[] (default) | string scalar | character vector

Style name in the document or document part style sheet, specified as a character vector or string scalar. You can set this property for any section of a formal table. Setting this property overrides the default style specified for formal tables in the document.

If you specify the StyleName of a section for a Word document, you must explicitly specify the width of each column in the section to ensure that all sections have the same width. Word has no built-in support for formal tables. To handle this, the DOM interface represents a formal table as three tables, one for each section, embedded in a 3x1 table.

This property does not support default Word document style names that have hyphens. To use a default Word document style name that has a hyphen, define the table style in a custom Word template and create the document or document part by using that template.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Style — Format specification

{} (default) | array of DOM format objects

Format specification for this document element object, specified as an array of DOM format objects. The formats specified by this property override corresponding formats specified by the StyleName property of this element. Formats that do not apply to this document element object are ignored.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

CustomAttributes — Custom attributes of document element

[] (default) | array of mlreportgen.dom.CustomAttribute objects

Custom attributes of the document element, specified as an array of mlreportgen.dom.CustomAttribute objects. The custom attributes must be supported by the output format of the document element to which this object is appended.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Parent — Parent of this object

document element object

Parent of this object, specified as a document element object. A document element must have only one parent.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Children — Children of this object

array of document element objects

Children of this object, specified as an array of document element objects. This property contains the document element objects appended using the append method.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Tag — Tag

character vector | string scalar

Tag, specified as a character vector or string scalar. The DOM API 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. Use this value to help identify where an issue occurs during document generation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Id — Object identifier

character vector | string scalar

Object identifier, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Methods

Public Methods

Method	Purpose
append Use FormalTable.append similar to how you use TableRow.append.	Append a row of table entries to table
appendFooterRow	Append row to table footer
appendHeaderRow	Append row to table header
clone Use FormalTable.clone the same way you use Paragraph.clone.	Copy the table

Version History

Introduced in R2014b

R2024b: datetime Array Display in Tables

datetime arrays in mlreportgen.dom.Table, mlreportgen.dom.FormalTable, and mlreportgen.dom.MATLABTable tables will now display as the point in time stored in the array.

Before R2024b	Starting R2024b

R2024a: Sortable HTML Table Columns

Make HTML table columns sortable by using the using the isSortable property in the mlreportgen.dom.FormalTable class.