mlreportgen.dom.MATLABTable class

Пакет: mlreportgen.dom
Суперклассы: mlreportgen.dom.FormalTable

Описание

Используйте объект 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.

  • Для списка названий цвета CSS см. https://www.w3.org/wiki/CSS/Properties/color/keywords.

  • Чтобы задать шестнадцатеричный формат RGB, используйте # как первый символ и 2D цифра шестнадцатеричные числа для красных, зеленых, и синих значений. Например, "#0000ff" задает синий.

Установка BackgroundColor свойство добавляет mlreportgen.dom.BackgroundColor объект формата к Style свойство. Установка BackgroundColor свойство к пустому значению удаляет объект.

Пример: 'blue'

Пример: "#0000ff"

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Табличное тело в виде mlreportgen.dom.TableBody объект. Табличный конструктор создает табличный объект тела и присваивает его этому свойству, когда формальная таблица создается. Вы не можете впоследствии установить это свойство. Однако можно добавить содержимое к табличному телу и установить его свойства при помощи этого свойства.

Атрибуты:

GetAccess
public
SetAccess
private
NonCopyable
true

Тип границы, чтобы чертить в виде одного из значений в таблице.

Ограничьте значениеОписаниеПоддерживаемые выходные типы

"dashed"

Пунктирная линия

Все выходные типы

"dashdotstroked"

Линия с переменными диагональными тире и точкой

Word

"dashsmallgap"

Пунктирная линия с маленьким разрывом между тире

Word

"dotted"

Пунктирная линия

Все выходные типы

"dotdash"

Линия с чередованием точек и тире

Word

"dotdotdash"

Линия с чередованием двойных точек и тире

Word

"double"

Двойная линия

Все выходные типы

"doublewave"

Удвойте волнистую линию

Word

"groove"

3-D эффект формировал канавки линия

HTML и PDF

"hidden"

Никакая линия

"none" тип границы также не продолжает линии. Однако конфликтные границы обработаны по-другому для "hidden" типы, чем для "none" типы. "hidden" тип границы более приоритетен по сравнению с конфликтным типом границы. Конфликтный тип границы более приоритетен по сравнению с "none" ввод.

HTML и PDF

"inset"

3-D линия эффекта

Все выходные типы

"none"

Никакая линия

"hidden" тип границы также не продолжает линии. Однако конфликтные границы обработаны по-другому для "hidden" типы, чем для "none" типы. "hidden" тип границы более приоритетен по сравнению с конфликтным типом границы. Конфликтный тип границы более приоритетен по сравнению с "none" ввод.

Все выходные типы

"outset"

3-D линия эффекта

Все выходные типы

"ridge"

3-D эффект остроконечная линия

HTML и PDF

"single"

Одна строка

Word

"solid"

Одна строка

HTML и PDF

"thick"

Толстая линия

Word

"thickthinlargegap"

Пунктирная линия с чередованием толстых и тонких тире с большим разрывом

Word

"thickthinmediumgap"

Пунктирная линия с чередованием толстых и тонких тире со средним разрывом

Word

"thickthinsmallgap"

Пунктирная линия с чередованием толстых и тонких тире с маленьким разрывом

Word

"thinthicklargegap"

Пунктирная линия с переменными тонкими и толстыми тире с большим разрывом

Word

"thinthickmediumgap"

Пунктирная линия с переменными тонкими и толстыми тире со средним разрывом

Word

"thinthicksmallgap"

Пунктирная линия с переменными тонкими и толстыми тире с маленьким разрывом

Word

"thinthickthinlargegap"

Пунктирная линия с переменными тонкими и толстыми тире с большим разрывом

Word

"thinthickthinmediumgap"

Пунктирная линия с переменными тонкими и толстыми тире со средним разрывом

Word

"thinthickthinsmallgap"

Пунктирная линия с переменными тонкими и толстыми тире с маленьким разрывом

Word

"threedemboss"

Рельефная линия эффекта

Word

"threedengrave"

Выгравированная линия эффекта

Word

"triple"

Тройная линия

Word

"wave"

Волнистая линия

Word

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Свернуть ли границы соседних элементов в одну границу в виде "на" или "прочь". Значение "on" границы коллапсов соседних элементов в одну границу. Значение "off" сохраняет границы соседних элементов. Это свойство применяется только к документам HTML.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Цвет границы таблицы в виде вектора символов или строкового скаляра, который состоит из названия цвета CSS или шестнадцатеричного значения RGB.

  • Для списка названий цвета CSS см. https://www.w3.org/wiki/CSS/Properties/color/keywords.

  • Чтобы задать шестнадцатеричный формат RGB, используйте # как первый символ и 2D цифра шестнадцатеричные числа для красных, зеленых, и синих значений. Например, "#0000ff" задает синий.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Ширина границы таблицы в виде строкового скаляра или вектора символов, который состоит из номера, сопровождаемого сокращением единицы измерения. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Дочерние элементы этого объекта DOM API в виде массива объектов ДОМА АПИ.

Атрибуты:

GetAccess
public
SetAccess
private
NonCopyable
true

Стиль линии, которая разделяет столбцы таблицы в виде вектора символов или строкового скаляра.

См. описание атрибута Border для описания возможных значений.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Цвет линии, которая разделяет столбцы в виде вектора символов или строкового скаляра, который состоит из названия цвета CSS или шестнадцатеричного значения RGB.

  • Для списка названий цвета CSS см. https://www.w3.org/wiki/CSS/Properties/color/keywords.

  • Чтобы задать шестнадцатеричный формат RGB, используйте # как первый символ и 2D цифра шестнадцатеричные числа для красных, зеленых, и синих значений. Например, "#0000ff" задает синий.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Ширина столбцов таблицы разделения линии в виде строкового скаляра или вектора символов, который состоит из номера, сопровождаемого сокращением единицы измерения. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Ширина, выравнивание и другие свойства группы столбцов в виде массива mlreportgen.dom.TableColSpecGroup объекты. Первый объект применяется к первой группе столбцов, второму объекту второй группе, и так далее. Задайте количество столбцов, которые принадлежат каждой группе при помощи Span свойство TableColSpecGroup объект. Например, если первый объект имеет промежуток 2, он применяется к первым двум столбцам. Если у второй группы есть промежуток 3, она применяется к следующим трем столбцам и так далее.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Пользовательские атрибуты для таблицы в виде массива mlreportgen.dom.CustomAttribute объекты. Пользовательские атрибуты должны поддерживаться выходным типом документа, к которому добавлен этот элемент документа.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Направление для текста, чтобы течь в виде одного из этих значений:

  • "ltr" — Текст течет слева направо

  • "rtl" — Текст течет справа налево

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Нижний колонтитул для этой таблицы в виде mlreportgen.dom.TableFooter объект. Табличный конструктор создает табличный объект нижнего колонтитула и присваивает его этому свойству, когда формальная таблица создается. Вы не можете впоследствии установить это свойство. Однако можно добавить содержимое к табличному телу и установить его свойства при помощи этого свойства.

Атрибуты:

GetAccess
public
SetAccess
private
NonCopyable
true

Выравнивание по горизонтали таблицы в виде одного из этих значений:

  • "center"

  • "left"

  • "right"

Примечание

Чтобы предотвратить переполнение больших таблиц в PDF выход, установите Width свойство.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Табличный заголовок в виде mlreportgen.dom.TableHeader объект. Табличный конструктор создает табличный объект заголовка и присваивает его этому свойству, когда формальная таблица создается. Вы не можете впоследствии установить это свойство. Однако можно добавить содержимое к табличному телу и установить его свойства при помощи этого свойства.

Атрибуты:

GetAccess
public
SetAccess
private
NonCopyable
true

Горизонтальное правило для заголовка в виде mlreportgen.dom.HorizontalRule объект.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

ID для этого объекта DOM API в виде вектора символов или строкового скаляра. DOM генерирует уникальный идентификатор сеанса, когда он создает элемент документа. Можно задать собственный ID.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Количество столбцов в виде целого числа.

Атрибуты:

GetAccess
public
SetAccess
private
NonCopyable
true

Левое поле таблицы в виде строкового скаляра или вектора символов, который состоит из номера, сопровождаемого сокращением единицы измерения. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Родительский элемент этого объекта DOM API в виде объекта DOM API.

Атрибуты:

GetAccess
public
SetAccess
private
NonCopyable
true

Разрешить ли первый столбец, который содержит имена строки в виде логического. Объект таблицы MATLAB должен задать имена строки.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Стиль линий, которые разделяют строки таблицы в виде вектора символов или строкового скаляра.

См. описание Border свойство для описания возможных значений.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Цвет линий, которые разделяют строки таблицы в виде вектора символов или строкового скаляра, который состоит из названия цвета CSS или шестнадцатеричного значения RGB.

  • Для списка названий цвета CSS см. https://www.w3.org/wiki/CSS/Properties/color/keywords.

  • Чтобы задать шестнадцатеричный формат RGB, используйте # как первый символ и 2D цифра шестнадцатеричные числа для красных, зеленых, и синих значений. Например, "#0000ff" задает синий.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Ширина линий, которые разделяют строки таблицы в виде строкового скаляра или вектора символов, который состоит из номера, сопровождаемого сокращением единицы измерения. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Форматы, которые задают стиль этой таблицы в виде массива ячеек объектов формата DOM. Форматы заменяют соответствующие форматы, заданные стилем таблицы стилей, заданным StyleName свойство.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Имя стиля задало в таблице стилей части документа или документа, к которой эта таблица добавлена в виде вектора символов или строкового скаляра.

Стиль задан StyleName свойство должно быть задано в таблице стилей части документа или документа, к которой добавлена эта таблица. Заданный стиль задает внешний вид таблицы в выходном документе, за исключением форматов, которые заданы Style свойство этого MATLABTable объект. Объекты формата заданы Style форматы переопределения свойства заданы таблицей стилей.

Можно установить StyleName свойство любого формального табличного раздела. Установка StyleName заменяет стиль, заданный самой формальной таблицей. Однако, если вы делаете это для документа Word, необходимо явным образом задать ширину каждого столбца в разделе, чтобы гарантировать, что все разделы имеют ту же ширину. Word, в отличие от HTML и PDF, не имеет никакой встроенной поддержки формальных таблиц. Чтобы обработать это, интерфейс DOM представляет формальную таблицу как три таблицы, один для каждого раздела, встроенного в таблицу 3 на 1.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Разработайте, чтобы использовать для записей таблицы в виде массива ячеек объектов формата.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Внутреннее поле для записей таблицы в виде строкового скаляра или вектора символов, который состоит из номера, сопровождаемого сокращением единицы измерения. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Пометьте для этого объекта DOM API в виде вектора символов или строкового скаляра.

DOM генерирует уникальный для сеанса тег как часть создания этого объекта. Сгенерированный тег имеет форму CLASS:ID, где КЛАСС является классом объекта, и ID является значением Id свойство объекта. Определение вашего собственного значения тега может помочь вам идентифицировать, где проблема произошла во время генерации документов.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Процент страницы width, такой как "100%", или номера, сопровождаемого сокращением единицы измерения в виде строкового скаляра или вектора символов. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

Для отчета Word ширина вычисляется как процент страницы width минус поля.

Атрибуты:

GetAccess
public
SetAccess
public
NonCopyable
true

Методы

развернуть все

Примеры

свернуть все

Этот пример составляет таблицу DOM из таблицы MATLAB, которая имеет имена строки. Пример генерирует два отчета, которые включают таблицу 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
               Age    Weight    Height
               ___    ______    ______

    Sanchez    38      176        71  
    Johnson    43      163        69  
    Lee        38      131        64  
    Diaz       40      133        67  
    Brown      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);

Вот таблица в сгенерированном отчете:

Введенный в R2017b