mlreportgen.dom.FormalTable 类
命名空间: mlreportgen.dom
正式表
描述
定义一个正式表,该表具有表体,并且可以选择具有表头、表脚,或者两者兼有。表头、表体、表脚分别是 mlreportgen.dom.TableHeader、mlreportgen.dom.TableBody、mlreportgen.dom.TableFooter 对象。
mlreportgen.dom.FormalTable 类是一个 handle 类。
创建对象
描述
创建一个空的正式表。使用此构造函数作为起点从头开始创建正式表。formalTableObj = FormalTable
创建一个具有指定列数的空的正式表。 formalTableObj = FormalTable(ncols)
创建一个具有指定正文内容的正式表。构造函数将基本 MATLAB® 类型转换为相应的 DOM 对象。例如,构造函数将字符向量转换为 formalTableObj = FormalTable(body)mlreportgen.dom.Text 对象。
注意
Microsoft® Word 会自动将具有匹配样式名称的连续表合并为一个表。要在 DOCX 报告中将连续的表作为单独的表呈现,请执行以下选项之一:
将连续表的样式名称设置为不同的值。
在表之间插入一些内容。例如,在表之间插入一个空的
mlreportgen.dom.Paragraph元素。
输入参量
表中的列数,指定为数值。
数据类型: double
表体内容,指定为:
二维数值数组
二维分类数组
二维元胞数组可包含:
字符向量
一维或二维元胞数组
doublemlreportgen.dom.Text对象mlreportgen.dom.Paragraph对象mlreportgen.dom.Image对象mlreportgen.dom.Table对象mlreportgen.dom.FormalTable对象mlreportgen.dom.OrderedList对象mlreportgen.dom.UnorderedList对象mlreportgen.dom.ExternalLink对象mlreportgen.dom.InternalLink对象mlreportgen.dom.CharEntity对象
表样式,指定为字符向量或字符串标量。此属性中的样式必须在用于创建包含此表的文档的模板中定义。
元胞数组可能包含:
字符向量
一维或二维元胞数组
doublemlreportgen.dom.Text对象mlreportgen.dom.Paragraph对象mlreportgen.dom.Image对象mlreportgen.dom.Table对象mlreportgen.dom.FormalTable对象mlreportgen.dom.OrderedList对象mlreportgen.dom.UnorderedList对象mlreportgen.dom.ExternalLink对象mlreportgen.dom.InternalLink对象mlreportgen.dom.CharEntity对象
元胞数组可能包含:
字符向量
一维或二维元胞数组
doublemlreportgen.dom.Text对象mlreportgen.dom.Paragraph对象mlreportgen.dom.Image对象mlreportgen.dom.Table对象mlreportgen.dom.FormalTable对象mlreportgen.dom.OrderedList对象mlreportgen.dom.UnorderedList对象mlreportgen.dom.ExternalLink对象mlreportgen.dom.InternalLink对象mlreportgen.dom.CharEntity对象
属性
包含 CSS 颜色名称或十六进制 RGB 值的背景颜色,指定为字符向量或字符串标量。
要使用颜色名称,请指定一个 CSS 颜色名称。要查看 CSS 颜色名称列表,请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
要指定十六进制 RGB 格式,请使用
#作为第一个字符,并使用两位十六进制数作为红色、绿色和蓝色值。例如,"#0000ff"指定蓝色。
注意
设置 BackgroundColor 属性会将 mlreportgen.dom.BackgroundColor 格式的对象添加到 Style 属性。将 BackgroundColor 属性设置为空值将删除该对象。
示例: "blue"
示例: "#0000ff"
属性:
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" | 无线条 当存在冲突的边框样式时, | 否 | 是 |
"inset" | 三维效果线 | 否 | 是 |
"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 |
是否将相邻单元格的边界合并为单一边界,指定为:
"on"- 将相邻单元格的边框合并为一个边框"off"- 保持相邻单元格的边界
注意
此属性仅适用于 HTML 文档。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char | string
边框的颜色,指定为包含 CSS 颜色名称或十六进制 RGB 值的字符向量或字符串标量。
要使用颜色名称,请指定一个 CSS 颜色名称。有关 CSS 颜色名称的列表,请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
要指定十六进制 RGB 格式,请使用
#作为第一个字符,并使用两位十六进制数作为红色、绿色和蓝色值。例如,"#0000ff"指定蓝色。
示例: "blue"
示例: "#0000ff"
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char | string
表边框宽度,指定为字符向量或字符串标量,其中包含一个数字后跟一个测量单位的缩写。例如,"10px" 指定 10 像素。有效的缩写是:
"px"- 像素"cm"- 厘米"in"- 英寸"mm"- 毫米"pc"- 派卡"pt"- 点
示例: "2pt"
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char | string
表或表部分列之间的分隔线样式,指定为以下值之一:
| 边框样式 | 描述 | 支持在 Microsoft Word 中使用。 | 支持 HTML 和 PDF |
|---|---|---|---|
"dashed" | 虚线 | 是 | 是 |
"dashdotstroked" | 斜划线和点交替出现的线 | 是 | 是 |
"dashsmallgap" | 划线之间有小间隙的虚线 | 是 | 是 |
"dotted" | 点线 | 是 | 是 |
"dotdash" | 点划线交替出现的线 | 是 | 否 |
"dotdotdash" | 双点和划线交替出现的线 | 是 | 否 |
"double" | 双线 | 是 | 是 |
"doublewave" | 双波浪线 | 是 | 否 |
"groove" | 三维效果凹槽线 | 否 | 是 |
"hidden" | 无线条 当存在冲突的边框样式时, | 否 | 是 |
"inset" | 三维效果线 | 否 | 是 |
"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 颜色名称的列表,请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
要指定十六进制 RGB 格式,请使用
#作为第一个字符,并使用两位十六进制数作为红色、绿色和蓝色值。例如,"#0000ff"指定蓝色。
示例: "blue"
示例: "#0000ff"
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char | string
表列分隔线的宽度,指定为字符向量或字符串标量,其中包含一个数字,后跟一个测量单位的缩写。有效的缩写是:
"px"- 像素"cm"- 厘米"in"- 英寸"mm"- 毫米"pc"- 派卡"pt"- 点
示例: "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
表构造函数在构造正式表时,创建一个表脚对象并将其赋给此属性。您随后无法设置此属性。但是,您可以将内容追加到表体并通过此属性设置其属性。
属性:
GetAccess | public |
SetAccess | private |
Transient | true |
NonCopyable | true |
表的水平对齐方式,指定为以下值之一:
"center""left""right"
注意
要防止 PDF 报告中大型表溢出,请设置 Width 属性。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char | string
表构造函数在构造正式表时,创建一个表头对象,并将其赋值给此属性。您随后无法设置此属性。但是,您可以将内容追加到表体并通过此属性设置其属性。
属性:
GetAccess | public |
SetAccess | private |
Transient | true |
NonCopyable | true |
自 R2024a 起
使表列可排序的选项,指定为数值或逻辑值 1 (true) 或 0 (false)。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: logical
表内容是否保持在同一页面上,指定为数值或逻辑值 1 (true) 或 0 (false)。默认值为空,相当于 true。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: logical
表的左边距,指定为字符向量或字符串标量,包含一个数字和一个测量单位的缩写。有效的缩写是:
"px"- 像素"cm"- 厘米"in"- 英寸"mm"- 毫米"pc"- 派卡"pt"- 点
示例: "10pt" 指定 10 个点
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char | string
表或表部分行之间的分隔线样式,指定为以下值之一:
| 边框样式 | 描述 | 支持在 Microsoft Word 中使用。 | 支持 HTML 和 PDF |
|---|---|---|---|
"dashed" | 虚线 | 是 | 是 |
"dashdotstroked" | 斜划线和点交替出现的线 | 是 | 是 |
"dashsmallgap" | 划线之间有小间隙的虚线 | 是 | 是 |
"dotted" | 点线 | 是 | 是 |
"dotdash" | 点划线交替出现的线 | 是 | 否 |
"dotdotdash" | 双点和划线交替出现的线 | 是 | 否 |
"double" | 双线 | 是 | 是 |
"doublewave" | 双波浪线 | 是 | 否 |
"groove" | 三维效果凹槽线 | 否 | 是 |
"hidden" | 无线条 当存在冲突的边框样式时, | 否 | 是 |
"inset" | 三维效果线 | 否 | 是 |
"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 颜色名称的列表,请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
要指定十六进制 RGB 格式,请使用
#作为第一个字符,并使用两位十六进制数作为红色、绿色和蓝色值。例如,"#0000ff"指定蓝色。
示例: "blue"
示例: "#0000ff"
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char | string
行分隔线的宽度,指定为字符向量或字符串标量,其中包含一个数字,后跟一个测量单位的缩写。例如,"10px" 指定 10 像素。有效的缩写是:
"px"- 像素"cm"- 厘米"in"- 英寸"mm"- 毫米"pc"- 派卡"pt"- 点
示例: "5pt"
属性:
NonCopyable | true |
数据类型: char | string
表条目使用的样式,指定为格式对象元胞数组。此属性指定的样式适用于表条目内容,而不适用于条目本身。例如,您可以使用此属性来定义表条目的字体大小,但不能定义条目边框的类型或颜色。要指定边框,请设置每个条目的 Style 属性。
注意
请小心,不要无意中覆盖该属性的先前设置。例如,设置表属性 TableEntriesHAlign 会将 HAlign 格式对象附加到此属性。要避免覆盖此属性,请在设置其他将格式附加到此属性的表属性之前设置此属性。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: cell
表条目的内边距,指定为字符向量或字符串标量,其中包含一个数字后跟一个测量单位的缩写。有效的缩写是:
"px"- 像素"cm"- 厘米"in"- 英寸"mm"- 毫米"pc"- 派卡"pt"- 点
示例: "10px" 指定 10 像素
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char | string
表宽,指定为字符向量或字符串标量,包含一个数字后跟一个测量单位的缩写。例如,“100%”指定 PDF 报告中页面宽度的 100%,Word 报告中页面宽度的 100% 减去边距。有效的缩写包括:
px- 像素cm- 厘米in- 英寸mm- 毫米pc- 派卡pt- 点%- 百分比
示例: "5pt" 指定五磅
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char | string
文档或文档部分样式表中的样式名称,指定为字符向量或字符串标量。您可以为正式表的任何部分设置此属性。设置此属性将覆盖文档中为正式表指定的默认样式。
如果您为 Word 文档的某个部分指定了 StyleName,则必须明确指定该部分中每列的宽度,以确保所有部分具有相同的宽度。Word 没有内置的正式表支持。为了解决此问题,DOM 接口将正式表表示为三个表,每节一个,嵌入在 3×1 表中。
此属性不支持包含连字符的默认 Word 文档样式名称。要使用包含连字符的默认 Word 文档样式名称,请在自定义 Word 模板中定义表样式,然后使用该模板创建文档或文档部分。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
数据类型: char | string
此文档元素对象的格式规范,指定为 DOM 格式对象数组。此属性指定的格式将覆盖此元素的 StyleName 属性指定的相应格式。不适用于此文档元素对象的格式将被忽略。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
文档元素的自定义属性,指定为 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
方法
方法 | 用途 |
|---|---|
| 将一行表条目追加到表 |
将行追加到表脚 | |
将行追加到表头 | |
使用 | 复制表格 |
版本历史记录
在 R2014b 中推出mlreportgen.dom.Table、mlreportgen.dom.FormalTable 和 mlreportgen.dom.MATLABTable 表中的 datetime 数组现在将显示为数组中存储的时间点。
| R2024b 之前 | 自 R2024b 开始 |
|---|---|
|
|
|
使用 mlreportgen.dom.FormalTable 类中的 isSortable 属性使 HTML 表列可排序。
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.
选择网站
选择网站以获取翻译的可用内容,以及查看当地活动和优惠。根据您的位置,我们建议您选择:。
您也可以从以下列表中选择网站:
如何获得最佳网站性能
选择中国网站(中文或英文)以获得最佳网站性能。其他 MathWorks 国家/地区网站并未针对您所在位置的访问进行优化。
美洲
- América Latina (Español)
- Canada (English)
- United States (English)
欧洲
- 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)
![Three columns showing a datetime array, an integer, and a string. The datetime object displays as [1x1 datetime].](rn24b_datetime_old.png)
