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
creates an empty table and sets the tableObj
= mlreportgen.dom.Table(nCols
)NCol
property to nCols
. Use this syntax as
the starting point for creating a table.
creates a table whose content is specified by tableObj
= mlreportgen.dom.Table(array
)array
. The
constructor converts basic MATLAB® types to corresponding DOM types. For example, it changes
character vectors to mlreportgen.dom.Text
objects.
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
array
— Table body content
two-dimensional numeric array | two-dimensional categorical array | two-dimensional cell array | two-dimensional string array
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
objectmlreportgen.dom.Paragraph
objectmlreportgen.dom.Image
objectmlreportgen.dom.Table
objectmlreportgen.dom.FormalTable
objectmlreportgen.dom.OrderedList
objectmlreportgen.dom.UnorderedList
objectmlreportgen.dom.ExternalLink
objectmlreportgen.dom.InternalLink
objectmlreportgen.dom.CharEntity
objectmlreportgen.dom.LineBreak
object
Properties
BackgroundColor
— Background color
[]
(default) | character vector | string scalar
Background color that consists of a CSS color name or a hexadecimal RGB value, specified as a character vector or string scalar.
For a list of CSS color names, see https://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:
NonCopyable | true |
Data Types: char
| string
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 line | HTML, PDF, Word |
| Line with alternating diagonal dashes and dot | Word |
| Dashed line with a small gap between dashes | Word |
| Dotted line | HTML, PDF, Word |
| Line with alternating dots and dashes | Word |
| Line with alternating double dots and a dash | Word |
| Double line | HTML, PDF, Word |
| Double wavy line | Word |
| 3-D effect grooved line | HTML, PDF |
| No line The | HTML, PDF |
| 3-D effect line | HTML, PDF, Word |
| No line The | HTML, PDF, Word |
| 3-D effect line | HTML, PDF, Word |
| 3-D effect ridged line | HTML, PDF |
| Single line | Word |
| Single line | HTML, PDF |
| Thick line | Word |
| Dashed line with alternating thick and thin dashes with a large gap | Word |
| Dashed line with alternating thick and thin dashes with a medium gap | Word |
| Dashed line with alternating thick and thin dashes with a small gap | Word |
| Dashed line with alternating thin and thick dashes with a medium gap | Word |
| Dashed line with alternating thin and thick dashes, with a medium gap | Word |
| Dashed line with alternating thin and thick dashes with a small gap | Word |
| Dashed line with alternating thin and thick dashes with a large gap | Word |
| Dashed line with alternating thin and thick dashes with a medium gap | Word |
| Dashed line with alternating thin and thick dashes with a small gap | Word |
| Embossed effect line | Word |
| Engraved effect line | Word |
| Triple line | Word |
| Wavy line | Word |
Attributes:
NonCopyable | true |
Data Types: char
| string
BorderCollapse
— Collapse borders of adjacent cells into single border (HTML only)
[] (determined by browser) | "on"
| "off"
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
BorderColor
— Border color
[]
(default) | character vector | string scalar
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
BorderWidth
— Table border width
"px"
| "cm"
| "in"
| ...
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
ColSep
— Style of line separating columns
"none"
| "solid"
| "dot"
| ...
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
ColSepColor
— Color of line separating columns
[]
(default) | character vector | string scalar
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.
For a list of CSS color names, see https://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:
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 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
ColSpecGroups
— Properties of group of columns in table
[]
(default) | 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.
Attributes:
NonCopyable | true |
FlowDirection
— Text flow direction
[]
(default) | "ltr"
| "rtl"
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
HAlign
— Horizontal alignment of this table
[]
(default) | "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.
Attributes:
NonCopyable | true |
Data Types: char
| string
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:
NonCopyable | true |
Data Types: logical
NCols
— Number of columns in this table
integer
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
NRows
— Number of rows in this table
integer
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
OuterLeftMargin
— Left margin of table
[]
(default) | character vector | string scalar
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
RowSep
— Style of lines separating rows
[]
(default) | character vector | string scalar
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
RowSepColor
— Color of lines separating table rows
[]
(default) | character vector | string scalar
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.
For a list of CSS color names, see https://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:
NonCopyable | true |
Data Types: char
| string
RowSepWidth
— Width of row separator
[]
(default) | character vector | string scalar
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
TableEntriesHAlign
— Horizontal alignment of table entries
"center"
(default) | "left"
| "right"
Horizontal alignment of table entries, specified as "center"
,
"left"
, or "right"
.
Attributes:
NonCopyable | true |
Data Types: char
| string
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"
Attributes:
NonCopyable | true |
Data Types: char
| string
TableEntriesInnerMargin
— Inner margin for table entries
[]
(default) | character vector | string scalar
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
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.
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
Width
— Table width
[]
(default) | character vector | string scalar
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
— pixelscm
— centimetersin
— inchesmm
— millimeterspc
— picaspt
— points%
— percent
Example: "5pt"
Attributes:
NonCopyable | true |
Data Types: char
| string
StyleName
— Name of stylesheet-defined style
[]
(default) | character vector | string scalar
Style name, specified as a character vector or 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
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:
NonCopyable | true |
CustomAttributes
— Custom attributes of document element
[]
(default) | array of mlreportgen.dom.CustomAttribute
objects
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
— Parent of mlreportgen.dom.Table
object
document element object
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
— Children of mlreportgen.dom.Table
object
array of document element objects
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
— Tag for mlreportgen.dom.Table
object
character vector | string scalar
Tag for the 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
Id
— Object identifier for mlreportgen.dom.Table
object
character vector | string scalar
Object identifier for the 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
Examples
Create a Table
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 R2015bR2024b: 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 |
---|---|
|
|
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: United States.
You can also select a web site from the following list
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)
Asia Pacific
- Australia (English)
- India (English)
- New Zealand (English)
- 中国
- 日本Japanese (日本語)
- 한국Korean (한국어)