mlreportgen.dom.MATLABTable class

Package: mlreportgen.dom
Superclasses:

MATLAB table

Description

Converts a MATLAB^® table to a DOM table.

Construction

MLTableObj = MATLABTable(table) creates a table object based on the specified MATLAB table.

MLTableObj = MATLABTable(table,stylename) creates the table object and applies the specified table style. Define the style in the template used to generate the report containing this table.

Input Arguments

table — MATLAB table

MATLAB table

MATLAB table.

Data Types: double

stylename — Style to apply to table

character vector

Style to apply to the table, specified as a character vector.

Properties

BackgroundColor — Background color

[] (default) | character vector | string scalar

Background color, specified as a character vector or string scalar that consists of a CSS color name (see https://www.crockford.com/wrrrld/color.html) or a hexadecimal RGB (truecolor) value in the form #RRGGBB.

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

Example: 'blue'

Example: '#0000ff'

Body — Table body

mlreportgen.dom.TableBody object

The table constructor creates a table body 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.

Border — Type of border to draw

'solid' | 'single' | 'dashed' | 'none' | ...

Type of border to draw, specified as one of the values in the table.

Border Value	Description	Supported Output Types
'dashed'	Dashed line	All output types
'dashdotstroked'	Line with alternating diagonal dashes and dot	Word
'dashsmallgap'	Dashed line with a small gap between dashes	Word
'dotted'	Dotted line	All output types
'dotdash'	Line with alternating dots and dashes	Word
'dotdotdash'	Line with alternating double dots and a dash	Word
'double'	Double line	All output types
'doublewave'	Double wavy line	Word
'groove'	3-D effect grooved line	HTML and PDF
'hidden'	No line The 'none' border type also produces no line. However, conflicting borders are handled differently for 'hidden' types than for 'none' types. The 'hidden' border type takes precedence over a conflicting border type. A conflicting border type takes precedence over the 'none' type.	HTML and PDF
'inset'	3-D effect line	All output types
'none'	No line The 'hidden' border type also produces no line. However, conflicting borders are handled differently for 'hidden' types than for 'none' types. The 'hidden' border type takes precedence over a conflicting border type. A conflicting border type takes precedence over the 'none' type.	All output types
'outset'	3-D effect line	All output types
'ridge'	3-D effect ridged line	HTML and PDF
'single'	Single line	Word
'solid'	Single line	HTML and PDF
'thick'	Thick line	Word
'thickthinlargegap'	Dashed line with alternating thick and thin dashes with a large gap	Word
'thickthinmediumgap'	Dashed line with alternating thick and thin dashes with a medium gap	Word
'thickthinsmallgap'	Dashed line with alternating thick and thin dashes with a small gap	Word
'thinthicklargegap'	Dashed line with alternating thin and thick dashes with a medium gap	Word
'thinthickmediumgap'	Dashed line with alternating thin and thick dashes, with a medium gap	Word
'thinthicksmallgap'	Dashed line with alternating thin and thick dashes with a small gap	Word
'thinthickthinlargegap'	Dashed line with alternating thin and thick dashes with a large gap	Word
'thinthickthinmediumgap'	Dashed line with alternating thin and thick dashes with a medium gap	Word
'thinthickthinsmallgap'	Dashed line with alternating thin and thick dashes with a small gap	Word
'threedemboss'	Embossed effect line	Word
'threedengrave'	Engraved effect line	Word
'triple'	Triple line	Word
'wave'	Wavy line	Word

BorderCollapse — Collapse borders of adjacent cells into single border (HTML only)

'on' | 'off'

A value of 'on' collapses borders of adjacent cells into a single border. A value of 'off' keeps borders of adjacent cells.

BorderColor — Border color

character vector

Border color, 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.

BorderWidth — Table border width

character vector

Table border width, specified 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

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

ColSpecGroups — Properties of group of columns in table

array of mlreportgen.dom.TableColSpecGroup objects

An array of mlreportgen.dom.TableColSpecGroup objects that specifies the width, alignment, and other properties of a group of columns. 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 belonging to each group 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.

CustomAttributes — Custom attributes for document element

array of mlreportgen.doc.CustomAttribute objects

The custom attributes must be supported by the output type of the document to which this document element is appended.

FlowDirection — Column flow direction

'ltr' | 'rtl'

Column flow direction, specified as:

• 'ltr' — Flow from left to right (column 1 is to the left in the table).

• 'rtl' — Flow from right to left (column 1 is to the right in the table).

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.

HAlign — Horizontal alignment of this table

'center' | 'left' | 'right'

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

• 'center'

• 'left'

• 'right'

Note

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

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.

HeaderRule — Horizontal rule for the heading

mlreportgen.dom.HorizontalRule object

Horizontal rule for the heading, specified as an mlreportgen.dom.HorizontalRule object.

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.

NCols — Number of columns

integer

Number of columns, specified as an integer.

OuterLeftMargin — Left margin (indentation) of document element

character vector

Left indentation in the form valueUnits. Units is an abbreviation for the units. Valid abbreviations are:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Parent — Parent of document element

DOM object

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

RowNamesRule — Turn on the rule on row names column

logical

Property to turn on the rule on the first column that contains the row names, specified as logical. The MATLAB table object must define the row names.

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 row separator

character vector

You can specify:

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

RowSepWidth — Width of row separator

character vector

Width of the row separator, specified 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

Style — Format for table

array of format objects

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

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

StyleName — Style in 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 this table is appended.

The style that specifies the appearance of this table in the output document, for formats not specified by the Style property.

You can set the StyleName property of any formal table section. Setting StyleName overrides the style specified by the formal table itself. However, if you do this for a Word document, you must explicitly specify the width of each column in a section to ensure that all sections have the same width. Word, unlike HTML and PDF, 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 3-by-1 table.

TableEntriesStyle — Style to use for table entries

cell array

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

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

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.

Width — Table width

character vector

A percentage (for example, '100%') of the page width (minus margins for Word reports) or a number of units of measurement, having the format valueUnits. Units is an abbreviation for the units. These are valid abbreviations:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Methods

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

Examples

Create a Table Using a MATLABTable Object

This example shows how to use a MATLABTable object to add a table to a report. This example adds a rule for the row name column.

% Create a MATLAB table from workspace variables
load patients;
BloodPressure = [Systolic Diastolic];
patients = table(Gender,Age,Smoker,BloodPressure);
patients.Properties.RowNames = LastName;

% Create a report and create the MATLABTable object 
rpt = mlreportgen.dom.Document('MyFileName','pdf');
tbl = mlreportgen.dom.MATLABTable(patients);

% Add a header for the row name column and add a rule
tbl.Header.row(1).Children(1).append('Names');
tbl.RowNamesRule = true;

% Add the table to the report
append(rpt,tbl);
close(rpt);

% Display the report 
rptview(rpt.OutputPath);