本页采用了机器翻译。点击此处可查看英文原文。

mlreportgen.dom.MATLABTable 类

命名空间: mlreportgen.dom
超类: mlreportgen.dom.FormalTable

MATLAB 表

全页展开

描述

使用 mlreportgen.dom.MATLABTable 类的对象将 MATLAB® 表转换为 DOM 表。

mlreportgen.dom.MATLABTable 类是一个 handle 类。

类属性

HandleCompatible
true
ConstructOnLoad
true

创建对象

描述

MLTableObj = mlreportgen.dom.MATLABTable(table) 根据指定的 MATLAB 表创建一个表对象。

示例

MLTableObj = mlreportgen.dom.MATLABTable(table,stylename) 创建表对象并将 StyleName 属性设置为 stylename。定义用于生成包含此表的报告的模板中的样式。

输入参量

全部展开

MATLAB table，用于生成 DOM 表，指定为 MATLAB 表。

属性

全部展开

背景色，指定为包含 CSS 颜色名称、十六进制 RGB 值或十进制 RGB 值的字符向量或字符串标量。

格式值
CSS 颜色名称指定一个 CSS 颜色名称。有关 CSS 颜色名称的列表，请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
十六进制 RGB 值使用格式 "#RRGGBB"。使用 # 作为第一个字符，并使用两位十六进制数作为红色、绿色和蓝色的值。您可以使用大写或小写字母。
十进制 RGB 颜色值请使用格式 "rgb(r,g,b)"，其中 r、g 和 b 是以逗号分隔的正整数，分别表示红色、绿色和蓝色的值。每个值的范围必须介于 0 和 255 之间。

设置 BackgroundColor 属性会将 mlreportgen.dom.BackgroundColor 格式的对象添加到 Style 属性。将 BackgroundColor 属性设置为空值将删除该对象。

示例: "red" 使用 CSS 颜色名称指定红色。

示例: "#0000ff" 使用十六进制 RGB 值指定蓝色。

示例: "rgb(128,0,128)" 使用十进制 RGB 颜色值指定紫色。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

表构造函数在构造正式表时创建一个 mlreportgen.dom.TableBody 对象并将其赋值给该属性。您随后无法设置此属性。但是，您可以将内容追加到表体并通过此属性设置其属性。

属性：

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

要绘制的边框类型，指定为以下值之一：

边框样式描述支持在 Microsoft® Word 中使用。支持 HTML 和 PDF
"dashed"虚线是是
"dashdotstroked"斜划线和点交替出现的线是是
"dashsmallgap"划线之间有小间隙的虚线是是
"dotted"点线是是
"dotdash"点划线交替出现的线是否
"dotdotdash"双点和划线交替出现的线是否
"double"双线是是
"doublewave"双波浪线是否
"groove"三维效果凹槽线否是
"hidden"

无线条

当存在冲突的边框样式时，"hidden" 边框样式将优先于冲突的边框样式，导致不显示边框线。

否是
"inset"三维效果线否是
"none"

无线条

当边框样式发生冲突时，冲突的边框样式将优先于 "none"，从而导致冲突的边框样式显示出来。

是是
"outset"三维效果线是是
"ridge"三维效果脊状线否是
"single"单线是是
"solid"单线否是
"thick"粗线是否
"thickthinlargegap"粗划线和细划线交替，间隙较大是否
"thickthinmediumgap"粗划线和细划线交替，间隙适中是否
"thickthinsmallgap"粗划线和细划线交替，间隙较小是否
"thinthicklargegap"细划线和粗划线交替，间隙较大是否
"thinthickmediumgap"细划线和粗划线交替，间隙适中是否
"thinthicksmallgap"细划线和粗划线交替，间隙较小是否
"thinthickthinlargegap"细划线和粗划线交替，间隙较大是否
"thinthickthinmediumgap"细划线和粗划线交替，间隙适中是否
"thinthickthinsmallgap"细划线和粗划线交替，间隙较小是否
"threedemboss"浮雕效果线是否
"threedengrave"雕刻效果线是否
"triple"三线是否
"wave"波浪线是否

注意

对于 Microsoft Word 报告，当您将 mlreportgen.dom.Border 对象分配给 mlreportgen.dom.TableHeaderEntry、mlreportgen.dom.TableEntry 或 mlreportgen.dom.HorizontalRule 对象的 Style 属性时，报告器不支持此属性的 "inset" 或 "outset" 样式。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

是否将相邻单元格的边界合并为单一边界，指定为：

  • "on" - 将相邻单元格的边框合并为一个边框

  • "off" - 保持相邻单元格的边界

注意

此属性仅适用于 HTML 文档。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

边框颜色，指定为字符向量或字符串标量，其中包含 CSS 颜色名称、十六进制 RGB 值或十进制 RGB 值。

格式值
CSS 颜色名称指定一个 CSS 颜色名称。有关 CSS 颜色名称的列表，请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
十六进制 RGB 值使用格式 "#RRGGBB"。使用 # 作为第一个字符，并使用两位十六进制数作为红色、绿色和蓝色的值。您可以使用大写或小写字母。
十进制 RGB 颜色值请使用格式 "rgb(r,g,b)"，其中 r、g 和 b 是以逗号分隔的正整数，分别表示红色、绿色和蓝色的值。每个值的范围必须介于 0 和 255 之间。

示例: "red" 使用 CSS 颜色名称指定红色。

示例: "#0000ff" 使用十六进制 RGB 值指定蓝色。

示例: "rgb(128,0,128)" 使用十进制 RGB 颜色值指定紫色。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

表边框宽度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个计量单位的缩写。例如，"10px" 指定 10 像素。有效的缩写是：

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

您也可以通过省略单位来指定像素值。例如，"5" 指定 5 像素。

示例: "2pt"

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

表或表部分列之间的分隔线样式，指定为以下值之一：

边框样式描述支持在 Microsoft Word 中使用。支持 HTML 和 PDF
"dashed"虚线是是
"dashdotstroked"斜划线和点交替出现的线是是
"dashsmallgap"划线之间有小间隙的虚线是是
"dotted"点线是是
"dotdash"点划线交替出现的线是否
"dotdotdash"双点和划线交替出现的线是否
"double"双线是是
"doublewave"双波浪线是否
"groove"三维效果凹槽线否是
"hidden"

无线条

当存在冲突的边框样式时，"hidden" 边框样式将优先于冲突的边框样式，导致不显示边框线。

否是
"inset"三维效果线否是
"none"

无线条

当边框样式发生冲突时，冲突的边框样式将优先于 "none"，从而导致冲突的边框样式显示出来。

是是
"outset"三维效果线是是
"ridge"三维效果脊状线否是
"single"单线是是
"solid"单线否是
"thick"粗线是否
"thickthinlargegap"粗划线和细划线交替，间隙较大是否
"thickthinmediumgap"粗划线和细划线交替，间隙适中是否
"thickthinsmallgap"粗划线和细划线交替，间隙较小是否
"thinthicklargegap"细划线和粗划线交替，间隙较大是否
"thinthickmediumgap"细划线和粗划线交替，间隙适中是否
"thinthicksmallgap"细划线和粗划线交替，间隙较小是否
"thinthickthinlargegap"细划线和粗划线交替，间隙较大是否
"thinthickthinmediumgap"细划线和粗划线交替，间隙适中是否
"thinthickthinsmallgap"细划线和粗划线交替，间隙较小是否
"threedemboss"浮雕效果线是否
"threedengrave"雕刻效果线是否
"triple"三线是否
"wave"波浪线是否

注意

对于 Microsoft Word 报告，当您将 mlreportgen.dom.Border 对象分配给 mlreportgen.dom.TableHeaderEntry、mlreportgen.dom.TableEntry 或 mlreportgen.dom.HorizontalRule 对象的 Style 属性时，报告器不支持此属性的 "inset" 或 "outset" 样式。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

表列分隔线的线条颜色，指定为包含 CSS 颜色名称、十六进制 RGB 值或十进制 RGB 值的字符向量或字符串标量。

格式值
CSS 颜色名称指定一个 CSS 颜色名称。有关 CSS 颜色名称的列表，请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
十六进制 RGB 值使用格式 "#RRGGBB"。使用 # 作为第一个字符，并使用两位十六进制数作为红色、绿色和蓝色的值。您可以使用大写或小写字母。
十进制 RGB 颜色值请使用格式 "rgb(r,g,b)"，其中 r、g 和 b 是以逗号分隔的正整数，分别表示红色、绿色和蓝色的值。每个值的范围必须介于 0 和 255 之间。

示例: "red" 使用 CSS 颜色名称指定红色。

示例: "#0000ff" 使用十六进制 RGB 值指定蓝色。

示例: "rgb(128,0,128)" 使用十进制 RGB 颜色值指定紫色。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

表列分隔线的宽度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个计量单位的缩写。有效的缩写是：

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

您也可以通过省略单位来指定像素值。例如，"5" 指定 5 像素。

示例: "10pt" 指定 10 磅

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

表中列组的属性，指定为 mlreportgen.dom.TableColSpecGroup 对象数组。第一个对象应用于第一组列，第二个对象应用于第二组列，依此类推。使用 Span 对象的 TableColSpecGroup 属性指定属于每个组的列数。例如，如果第一个对象的跨度为 2，则它适用于前两列。如果第二组的跨度为 3，则它将应用于接下来的三列，依此类推。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

文本流方向，指定为以下值之一：

  • "ltr" - 文本从左到右流动

  • "rtl" - 文本从右向左流动

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

表的水平对齐方式，指定为以下值之一：

  • "center"

  • "left"

  • "right"

注意

要防止 PDF 报告中大型表溢出，请设置 Width 属性。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

表构造函数在构造正式表时，创建一个表头对象，并将其赋值给此属性。您随后无法设置此属性。但是，您可以将内容追加到表体并通过此属性设置其属性。

属性：

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

标题的水平规则，指定为 mlreportgen.dom.HorizontalRule 对象。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

表内容是否保留在同一页上，指定为逻辑 1 (true) 或 0 (false)。当您指定：。默认值为空，相当于 true。

  • 1 (true) - 表内容保持在同一页上

  • 0 (false) - 表内容可延续至下一页。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: logical

列数，指定为整数。

属性：

SetAccess
private
NonCopyable
true

数据类型: uint64

表的左边距，指定为字符向量或字符串标量，包含一个数字和一个计量单位的缩写。有效的缩写是：

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

您也可以通过省略单位来指定像素值。例如，"5" 指定 5 像素。

示例: "10pt" 指定 10 磅

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

是否启用包含行名的首列，指定为逻辑值 1 (true) 或 0 (false)。当您指定：

  • 1 (true) - 启用包含行名的第一列。MATLAB 表对象必须定义行名。

  • 0 (false) - 请勿启用包含行名的第一列。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: logical

表或表部分行之间的分隔线样式，指定为以下值之一：

边框样式描述支持在 Microsoft Word 中使用。支持 HTML 和 PDF
"dashed"虚线是是
"dashdotstroked"斜划线和点交替出现的线是是
"dashsmallgap"划线之间有小间隙的虚线是是
"dotted"点线是是
"dotdash"点划线交替出现的线是否
"dotdotdash"双点和划线交替出现的线是否
"double"双线是是
"doublewave"双波浪线是否
"groove"三维效果凹槽线否是
"hidden"

无线条

当存在冲突的边框样式时，"hidden" 边框样式将优先于冲突的边框样式，导致不显示边框线。

否是
"inset"三维效果线否是
"none"

无线条

当边框样式发生冲突时，冲突的边框样式将优先于 "none"，从而导致冲突的边框样式显示出来。

是是
"outset"三维效果线是是
"ridge"三维效果脊状线否是
"single"单线是是
"solid"单线否是
"thick"粗线是否
"thickthinlargegap"粗划线和细划线交替，间隙较大是否
"thickthinmediumgap"粗划线和细划线交替，间隙适中是否
"thickthinsmallgap"粗划线和细划线交替，间隙较小是否
"thinthicklargegap"细划线和粗划线交替，间隙较大是否
"thinthickmediumgap"细划线和粗划线交替，间隙适中是否
"thinthicksmallgap"细划线和粗划线交替，间隙较小是否
"thinthickthinlargegap"细划线和粗划线交替，间隙较大是否
"thinthickthinmediumgap"细划线和粗划线交替，间隙适中是否
"thinthickthinsmallgap"细划线和粗划线交替，间隙较小是否
"threedemboss"浮雕效果线是否
"threedengrave"雕刻效果线是否
"triple"三线是否
"wave"波浪线是否

注意

对于 Microsoft Word 报告，当您将 mlreportgen.dom.Border 对象分配给 mlreportgen.dom.TableHeaderEntry、mlreportgen.dom.TableEntry 或 mlreportgen.dom.HorizontalRule 对象的 Style 属性时，报告器不支持此属性的 "inset" 或 "outset" 样式。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

表行分隔线的线条颜色，指定为包含 CSS 颜色名称或十六进制 RGB 值的字符向量或字符串标量。

格式值
CSS 颜色名称指定一个 CSS 颜色名称。有关 CSS 颜色名称的列表，请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
十六进制 RGB 值使用格式 "#RRGGBB"。使用 # 作为第一个字符，并使用两位十六进制数作为红色、绿色和蓝色的值。您可以使用大写或小写字母。
十进制 RGB 颜色值请使用格式 "rgb(r,g,b)"，其中 r、g 和 b 是以逗号分隔的正整数，分别表示红色、绿色和蓝色的值。每个值的范围必须介于 0 和 255 之间。

示例: "red" 使用 CSS 颜色名称指定红色。

示例: "#0000ff" 使用十六进制 RGB 值指定蓝色。

示例: "rgb(128,0,128)" 使用十进制 RGB 颜色值指定紫色。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

行分隔符的宽度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个计量单位的缩写。例如，"10px" 指定 10 像素。有效的缩写是：

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

您也可以通过省略单位来指定像素值。例如，"5" 指定 5 像素。

示例: "5pt"

属性：

NonCopyable
true

数据类型: char | string

表的宽度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个计量单位的缩写。例如，“100%”指定 PDF 报告中页面宽度的 100%，Word 报告中页面宽度的 100% 减去边距。有效的缩写包括：

  • 不使用缩写 - 像素

  • px - 像素

  • cm - 厘米

  • in - 英寸

  • mm - 毫米

  • pc - 派卡

  • pt - 磅

  • % - 百分比

示例: "5pt" 指定五磅

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

表条目使用的样式，指定为格式对象元胞数组。此属性指定的样式适用于表条目内容，而不适用于条目本身。例如，您可以使用此属性来定义表条目的字体大小，但不能定义条目边框的类型或颜色。要指定边框，请设置每个条目的 Style 属性。

注意

请小心，不要无意中覆盖该属性的先前设置。例如，设置表属性 TableEntriesHAlign 会将 HAlign 格式对象追加到此属性。要避免覆盖此属性，请在设置其他将格式追加到此属性的表属性之前设置此属性。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: cell

表条目的内边距，指定为字符向量或字符串标量，其中包含一个数字，后跟一个计量单位的缩写。有效的缩写是：

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 派卡

  • "pt" - 磅

您也可以通过省略单位来指定像素值。例如，"5" 指定 5 像素。

示例: "10px" 指定 10 像素

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

此表追加到的文档或文档部件的样式表中指定的样式的名称，指定为字符向量或字符串标量。

StyleName 属性指定的样式必须在追加此表的文档或文档部件的样式表中定义。指定的样式定义输出文档中表的外观，但此 Style 对象的 MATLABTable 属性指定的格式除外。Style 属性指定的格式对象会覆盖样式表定义的格式。

您可以设置任何正式表节的 StyleName 属性。设置 StyleName 会覆盖正式表本身指定的样式。但是，如果对 Word 文档执行此操作，则必须明确指定节中每列的宽度，以确保所有节都有相同的宽度。Word 与 HTML 和 PDF 不同，它没有内置对正式表的支持。为了处理此问题，DOM 接口将正式表表示为三个表，每节一个，嵌入在一个 3×1 的表中。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

此文档元素对象的格式规范，指定为 DOM 格式对象元胞数组。此属性指定的格式将覆盖此元素的 StyleName 属性指定的相应格式。不适用于此文档元素对象的格式将被忽略。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: cell

文档元素的自定义属性，指定为 mlreportgen.dom.CustomAttribute 对象数组。自定义属性必须被此对象所追加到的文档元素的输出格式支持。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

此对象的父对象，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

此对象的子对象，指定为文档元素对象数组。此属性包含使用 append 方法追加的文档元素对象。

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

标记，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标记。生成的标记形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。使用此值来帮助确定在文档生成过程中出现的问题的位置。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

目标标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

方法

全部展开

示例

全部折叠

打开实时脚本

此示例从具有行名的 MATLAB 表创建 DOM 表。该示例生成两个包含 DOM 表的报告。在第一份报告中，表的行名列没有标记。在第二份报告中，行名称列有一个标记。

创建一个 MATLAB 表，显示患者的年龄、体重和身高。使用 RowNames 选项通过患者的姓氏来识别每一行。 

LastName = {'Sanchez';'Johnson';'Lee';'Diaz';'Brown'};
Age = [38;43;38;40;49];
Weight = [176;163;131;133;119];
Height = [71;69;64;67;64];
mltable = table(Age,Weight,Height,'RowNames',LastName)
mltable=5×3 table
    38    176    71
    43    163    69
    38    131    64
    40    133    67
    49    119    64

MATLAB 表有五行和三列。行名不是表的一部分。它们存储在表的属性中。

从 mlreportgen.dom.MATLABTable 表创建一个 MATLAB 对象。 

import mlreportgen.dom.*
mltableObj = MATLABTable(mltable);

创建一个文档并将 MATLABTable 对象追加到该文档。关闭并查看文档。

d = Document('MyMATLABTable1','docx');
append(d,mltableObj);
close(d);
rptview(d);

以下是生成的报告中的表：

DOM 表是一个正式的表，它有表头和表主体。表体共五行四列。第一列由 MATLAB 表行名称组成。

再次生成报告，这次为行名称列添加标记。要指定标记，请用标记文本替换表标题行第一个条目中的空文本。要在标记下方画一条线，请将 RowNamesRule 对象的 MATLABTable 属性设置为 true。

LastName = {'Sanchez';'Johnson';'Lee';'Diaz';'Brown'};
Age = [38;43;38;40;49];
Weight = [176;163;131;133;119];
Height = [71;69;64;67;64];
mltable = table(Age,Weight,Height,'RowNames',LastName);
import mlreportgen.dom.*
mltableObj = MATLABTable(mltable);
th = mltableObj.Header;
thentry11 = entry(th,1,1);
thentry11.Children(1).Children(1).Content = 'Names';
mltableObj.RowNamesRule = true;
d = Document('MyMATLABTable2','docx');
append(d,mltableObj);
close(d);
rptview(d);

以下是生成的报告中的表：

提示

  • 当您在表条目中包含大量内容时，表可能无法完全显示在报告页面上。如果某个表无法完全显示在 DOCX 报告页面上，Microsoft Word 将无法打开该报告。为确保表能适配 DOCX 报告，请设置内容较多的表条目的宽度和高度。要设置宽度，请使用 mlreportgen.dom.Width 类。要设置高度，请使用 mlreportgen.dom.Height 类。为避免删除现有格式，请将新的表条目样式与现有样式合并：

    te = TableEntry(domObj);
te.Style = [te.Style, {Width("1in"), Height("1in")}];
append(row,te);
    若要将该格式应用于表中的所有表条目，请使用表对象的 TableEntriesStyle 属性。

版本历史记录

在 R2016b 中推出

全部展开

另请参阅

|

主题