Main Content

mlreportgen.dom.Table Class

Namespace: mlreportgen.dom

Informal table

Description

Use objects of the mlreportgen.dom.Table class to define an informal table, which is a table that has only a body. It does not have separate header or footer sections.

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

Class Attributes

HandleCompatible
true
ConstructOnLoad
true

Creation

Description

tableObj = mlreportgen.dom.Table(nCols) creates an empty table and sets the NCol property to nCols. Use this syntax as the starting point for creating a table.

example

tableObj = mlreportgen.dom.Table(array) creates a table whose content is specified by array. The constructor converts basic MATLAB® types to corresponding DOM types. For example, it changes character vectors to mlreportgen.dom.Text objects.

tableObj = mlreportgen.dom.Table(array,style) creates a table and sets the Style property to style. The style specified by style must be defined in the template used to create the document to which this table is appended.

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 the following 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

expand all

Table body content, specified as:

  • A two-dimensional numeric array

  • A two-dimensional categorical array

  • A two-dimensional string array

  • A two-dimensional cell array that contains arrays, data types, or objects of these type:

    • Character vector

    • String scalar

    • One-dimensional or two-dimensional cell array

    • Items of data type 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

    • mlreportgen.dom.LineBreak object

Properties

expand all

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

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:

NonCopyable
true

Data Types: char | string

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

Border ValueDescriptionSupported Output Types

"dashed"

Dashed line

HTML, PDF, Word

"dashdotstroked"

Line with alternating diagonal dashes and dot

Word

"dashsmallgap"

Dashed line with a small gap between dashes

Word

"dotted"

Dotted line

HTML, PDF, Word

"dotdash"

Line with alternating dots and dashes

Word

"dotdotdash"

Line with alternating double dots and a dash

Word

"double"

Double line

HTML, PDF, Word

"doublewave"

Double wavy line

Word

"groove"

3-D effect grooved line

HTML, 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, PDF

"inset"

3-D effect line

HTML, PDF, Word

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

HTML, PDF, Word

"outset"

3-D effect line

HTML, PDF, Word

"ridge"

3-D effect ridged line

HTML, PDF

"single"

Single line

Word

"solid"

Single line

HTML, 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

Attributes:

NonCopyable
true

Data Types: char | string

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

Note

This property applies only to HTML documents.

Attributes:

NonCopyable
true

Data Types: char | string

Border color, specified as a character vector or string scalar that consists of a CSS color name (see https://www.w3.org/wiki/CSS/Properties/color/keywords) or a hexadecimal RGB (truecolor) value in the form #RRGGBB.

Example: 'blue'

Example: '#0000ff'

Attributes:

NonCopyable
true

Data Types: char | string

Table border width, specified in the form valueUnits, where Units is an abbreviation for the units. Valid abbreviations are:

  • "px" — pixels

  • "cm" — centimeters

  • "in" — inches

  • "mm" — millimeters

  • "pc" — picas

  • "pt" — points

Example: "2pt"

Attributes:

NonCopyable
true

Data Types: char | string

Style of the line that separates the columns of a table or table section, specified as a string scalar or a character vector. See the Border property for a table of valid entries.

Attributes:

NonCopyable
true

Data Types: char | string

Color of lines separating columns specified as a character vector or string scalar that consists of a CSS color name or a hexadecimal RGB value.

Example: "blue"

Example: "#0000ff"

Attributes:

NonCopyable
true

Data Types: char | string

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

  • "px" — pixels

  • "cm" — centimeters

  • "in" — inches

  • "mm" — millimeters

  • "pc" — picas

  • "pt" — points

Example: "10pt"

Attributes:

NonCopyable
true

Data Types: char | string

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.

Attributes:

NonCopyable
true

Direction for text to flow, specified as one of these values:

  • "ltr" — Text flows from left to right

  • "rtl" — Text flows from right to left

Attributes:

NonCopyable
true

Data Types: char | string

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.

Attributes:

NonCopyable
true

Data Types: char | string

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:

NonCopyable
true

Data Types: logical

Number of table columns, specified as an integer. To specify the number of columns, create a table by using the syntax mlreportgen.dom.Table(nCols). Otherwise, the Table constructor determines the number of columns from the table content. If you add rows to a table or entries to a row and the number of columns changes, the value of the NCols property updates. If the rows do not all have the same number of entries, the row with the largest number of table entries determines the number of columns in the table.

Attributes:

SetAccess
private
NonCopyable
true

Data Types: uint64

Number of rows in this table, specified as an integer. The Table constructor determines the number of rows from the table content. If you add rows to the table, the value of the NRows property updates.

Attributes:

SetAccess
private
NonCopyable
true

Data Types: uint64

Left margin of the table, specified as a character vector or string scalar that consists of 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"

Attributes:

NonCopyable
true

Data Types: char | string

Style of the lines that separate the rows of the table, specified as a character vector or string scalar.

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

Attributes:

NonCopyable
true

Data Types: char | string

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

Example: "blue"

Example: "#0000ff"

Attributes:

NonCopyable
true

Data Types: char | string

Width of the row separator, specified in the form valueUnits where Units is an abbreviation for the units. Valid abbreviations are:

  • "px" — pixels

  • "cm" — centimeters

  • "in" — inches

  • "mm" — millimeters

  • "pc" — picas

  • "pt" — points

Example: "5pt"

Attributes:

NonCopyable
true

Data Types: char | string

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

Attributes:

NonCopyable
true

Data Types: char | string

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

  • "top"

  • "middle"

  • "bottom"

Attributes:

NonCopyable
true

Data Types: char | string

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

  • "cm" — centimeters

  • "in" — inches

  • "mm" — millimeters

  • "pc" — picas

  • "pt" — points

Attributes:

NonCopyable
true

Data Types: char | string

Style to use for the table entries, specified as a cell array of format objects.

Note

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

Note

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

Attributes:

NonCopyable
true

Data Types: cell

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

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

  • % — percent

Example: "5pt"

Attributes:

NonCopyable
true

Data Types: char | string

Style name, specified as a character vector or a string scalar. The style name is the name of a style specified in the style sheet of the document or document part to which this element is appended. The specified style defines the appearance of this element in the output document unless overridden by the formats specified by the Style property of this element. To learn more about using style sheets, see Use Style Sheet Styles.

Note

Microsoft Word output ignores the style name.

Attributes:

NonCopyable
true

Data Types: char | string

Format specification for this document element object, specified as an array of 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 element are ignored.

Attributes:

NonCopyable
true

Data Types: cell

Custom attributes of this 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:

NonCopyable
true

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

Attributes:

SetAccess
private
NonCopyable
true

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

Attributes:

SetAccess
private
NonCopyable
true

Tag for mlreportgen.dom.Table object, 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. Specify your own tag value to help you identify where to look when an issue occurs during document generation.

Attributes:

NonCopyable
true

Data Types: char | string

Object identifier for mlreportgen.dom.Table object, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object. You can specify your own value for Id.

Attributes:

NonCopyable
true

Data Types: char | string

Methods

expand all

Examples

collapse all

In this example, you create a table by using a Table object and specify its properties.

Import the DOM API namespace so that you do not have to use long, fully qualified names.

import mlreportgen.dom.*;

Create a Document object and open it.

d = Document("myreport","html");
open(d); 

Create a table object and specify its content by using a 5-by-5 MATLAB array. The number array is converted to a table of DOM objects of the same dimension.

t = Table(magic(5));

Specify the row height.

t.Style = {RowHeight("1in")};

Specify the width and style of row and column separators.

t.Border = "solid";
t.BorderWidth = "1px";
t.ColSep = "solid";
t.ColSepWidth = "1";
t.RowSep = "solid";
t.RowSepWidth = "1";

Set the style for the table entries.

t.TableEntriesStyle = [t.TableEntriesStyle {FontFamily("Arial"),Width("1in"),Color("red"),Bold}];

Set the horizontal and vertical alignment for the text in the table.

t.TableEntriesHAlign = "center";
t.TableEntriesVAlign = "middle";

Add the table to the document.

append(d,t);

Close the document and view the report.

close(d);
rptview(d);

Version History

Introduced in R2015b