mlreportgen.dom.Table class
Package: 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.
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
Table background color, 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.
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 |
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 | All output types |
| Line with alternating diagonal dashes and dot | Word |
| Dashed line with a small gap between dashes | Word |
| Dotted line | All output types |
| Line with alternating dots and dashes | Word |
| Line with alternating double dots and a dash | Word |
| Double line | All output types |
| Double wavy line | Word |
| 3-D effect grooved line | HTML and PDF |
| No line The | HTML and PDF |
| 3-D effect line | All output types |
| No line The | All output types |
| 3-D effect line | All output types |
| 3-D effect ridged line | HTML and PDF |
| Single line | Word |
| Single line | HTML and 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 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 |
| 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:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
BorderCollapse
— Whether to 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. This property applies only to HTML documents.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
BorderColor
— Border color
character vector | string scalar
Table border color, 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.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
BorderWidth
— Table border width
character vector | string scalar
Table border width, specified as a string scalar or character vector that consists of a number followed by an abbreviation of a unit of measurement. Valid abbreviations are:
px
— pixels (default)cm
— centimetersin
— inchesmm
— millimeterspc
— picaspt
— points
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Children
— Children of this DOM API object
array of DOM API objects
Children of this DOM API object, specified as an array of DOM API objects.
Attributes:
GetAccess | public |
SetAccess | private |
NonCopyable | true |
ColSep
— Style of line separating columns
character vector | string scalar
Style of the line that separates the columns of a table, specified as a character vector or string scalar.
See the description of the attribute Border
for a description of the possible values.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
ColSepColor
— Color of line separating columns
character vector | string scalar
Color of line 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.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
ColSepWidth
— Width of line separating table columns
character vector | string scalar
Width of the line separating table columns, specified as a string scalar or character vector that consists of a number followed by an abbreviation of a unit of measurement. Valid abbreviations are:
px
— pixels (default)cm
— centimetersin
— inchesmm
— millimeterspc
— picaspt
— points
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
ColSpecGroups
— Properties of group of columns in table
array of mlreportgen.dom.TableColSpecGroup
objects
Width, alignment, and other properties of a group of columns, 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 belonging 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 |
CustomAttributes
— Custom attributes for the table
array of mlreportgen.dom.CustomAttribute
objects
Custom attributes for the table, specified as an array of
mlreportgen.dom.CustomAttribute
objects. The custom
attributes must be supported by the output type of the document to which
this document element is appended.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
FlowDirection
— Text flow direction
"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:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
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.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Id
— ID for this DOM API object
character vector | string scalar
ID for this DOM API object, 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.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
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
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:
GetAccess | public |
SetAccess | private |
NonCopyable | true |
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:
GetAccess | public |
SetAccess | private |
NonCopyable | true |
OuterLeftMargin
— Left margin of document element
character vector | string scalar
Left margin of the table, specified as a string scalar or character vector that consists of a number followed by an abbreviation of a unit of measurement. Valid abbreviations are:
px
— pixels (default)cm
— centimetersin
— inchesmm
— millimeterspc
— picaspt
— points
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Parent
— Parent of this DOM API object
DOM API object
Parent of this DOM API object, specified as a DOM API object.
Attributes:
GetAccess | public |
SetAccess | private |
NonCopyable | true |
RowSep
— Style of lines separating rows
character vector | string scalar
Style of the lines that separate the rows of a table, specified as a character vector or string scalar.
See the description of the Border
property for a description of the possible
values.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
RowSepColor
— Color of lines separating table rows
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.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
RowSepWidth
— Width of lines separating table rows
character vector | string scalar
Width of the lines that separates the table rows, specified as a string scalar or character vector that consists of a number followed by an abbreviation of a unit of measurement. Valid abbreviations are:
px
— pixels (default)cm
— centimetersin
— inchesmm
— millimeterspc
— picaspt
— points
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Style
— Format for table
array of format objects
Formats that define the style of this table, specified as a cell array of
DOM format objects. The formats override the corresponding formats defined
by the stylesheet style specified by the StyleName
property.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
StyleName
— Style in document or document part style sheet
character vector | string scalar
Name of a style specified in the style sheet of the document or document part to which this table is appended, specified as a character vector or string scalar.
The style specified by the StyleName
property must be
defined in the stylesheet of the document or document part to which this
table is appended. The specified style defines the appearance of the table
in the output document, except for formats that are specified by the
Style
property of this Table
object. The format objects specified by the Style
property override formats defined by the stylesheet.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
TableEntriesHAlign
— Horizontal alignment of table entries
"center"
(default) | "left"
| "right"
Horizontal alignment of table entries, specified as one of these values:
"center"
"left"
"right"
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
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:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
TableEntriesInnerMargin
— Inner margin for table entries
character vector | string scalar
Inner margin for the table entries, specified as a string scalar or character vector that consists of a number followed by an abbreviation of a unit of measurement. Valid abbreviations are:
px
— pixels (default)cm
— centimetersin
— inchesmm
— millimeterspc
— picaspt
— points
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
TableEntriesStyle
— Style to use for table entries
cell array of format objects
Style to use for the table entries, specified as a cell array of format objects.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Tag
— Tag for this DOM API object
character vector | string scalar
Tag for this DOM API object, 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.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Width
— Table width
character vector | string scalar
Percentage of the page width, such as "100%", or a number of units of measurement, specified as a string scalar or character vector that consists of a number followed by an abbreviation of a unit of measurement. Valid abbreviations are:
px
— pixels (default)cm
— centimetersin
— inchesmm
— millimeterspc
— picaspt
— points
For Word report, the width is calculated as a percentage of the page width minus the margins.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
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 package 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
Ouvrir l'exemple
Vous possédez une version modifiée de cet exemple. Souhaitez-vous ouvrir cet exemple avec vos modifications ?
Commande MATLAB
Vous avez cliqué sur un lien qui correspond à cette commande MATLAB :
Pour exécuter la commande, saisissez-la dans la fenêtre de commande de MATLAB. Les navigateurs web ne supportent pas les commandes MATLAB.
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: .
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)