mlreportgen.report.BaseTable class

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

Создайте табличный генератор отчетов

расширьте все на странице

Описание

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

Конструкция

table = BaseTable() создает пустой табличный генератор отчетов. Используйте его свойства задать табличное содержимое, автоматически пронумерованный табличный заголовок, и стиль таблицы и ширину.

table = BaseTable(content) создает табличный генератор отчетов, это форматирует content как таблица и добавляет его в отчет.

table = BaseTable(Name,Value) свойства наборов с помощью пар "имя-значение". Можно задать несколько аргументов пары "имя-значение" в любом порядке. Заключите каждое имя свойства в одинарные кавычки.

Входные параметры

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

Смотрите mlreportgen.dom.Table, FormalTable, или MATLABTable свойства.

Свойства

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

Табличный заголовок, заданный как одно из этих значений:

  • Строка или символьный массив

  • Объект DOM

  • 1 N или N-by-1 массив строк или Объектов DOM

  • 1 N или N-by-1 массив ячеек строк, символьных массивов и/или Объектов DOM

  • Генератор отчетов отверстия возвращен getTitleReporter метод

Встроенное содержимое довольно, что абзац может содержать. Если значение заголовка является встроенным содержимым, табличный генератор отчетов использует шаблон, сохраненный в его библиотеке шаблонов, чтобы отформатировать заголовок. Шаблон автоматически нумерует табличный заголовок с помощью формата, который зависит от того, является ли таблица в пронумерованной или непронумерованной главе.

  • Таблица в пронумерованной главе имеет префикс текста заголовка формы 'Таблица N.M'. N является номером главы, и M является табличным номером в главе. Например, префиксом для третьей таблицы во второй главе отчета является Таблица 2.3.

  • Таблица в непронумерованной главе имеет префикс текста заголовка формы 'Таблица N'. N 1 для первой таблицы в отчете, 2 для второй таблицы, и так далее.

Во многих неанглийских локалях префикс заголовка переводится в язык и формат локали. Смотрите свойство Locale mlreportgen.report.Report для списка переведенных локалей.

Табличное содержимое, заданное как одно из этих значений:

  • DOM Table объект

  • DOM FormalTable объект

  • Объект таблицы DOM MATLAB®

  • Двумерный массив или массив ячеек DOM или встроенных объектов MATLAB

  • Генератор отчетов отверстия возвращен getContentReporter метод

Используйте Section конструктор или add метод, чтобы установить это свойство. Вы не можете установить его непосредственно.

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

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

Ширина этой таблицы, заданной как строка или символьный массив. TableWidth форматом является valueUnits, где Units является сокращением от единиц ширины, и value является количеством модулей. Таблица показывает допустимые сокращения Units.

Модульное сокращениеМодули
пкс'pixels'
cm'centimeters'
\in'inches'
мммиллиметры
PCцицеро
pt'points'
%процент

Пример: 5 дюймов

Максимальное количество столбцов, чтобы отобразиться на табличный срез, заданный как Inf или как положительное целое число. Если значением этого свойства является Inf, все исходные столбцы таблицы включены в одну таблицу. MaxCols значение, больше, чем или равный количеству столбцов таблицы также, производит одну таблицу со всеми столбцами. Большие табличные наборы данных могут заставить неразборчивые таблицы быть сгенерированными. Установите это свойство на количество столбцов из исходной таблицы, которые соответствуют четко на странице. Чтобы определить оптимальное значение, выполните итерации установки MaxCol значение и просматривание отчета.

Количество первоначальных столбцов, чтобы повториться на срез, заданный как 0 или положительное целое число. Ненулевой номер, n, повторяет первые n столбцы исходной таблицы в каждом срезе. MaxCols значение свойства включает RepeatCols значение свойства. Например, если MaxCols 6 и RepeatCols 2, каждый табличный срез имеет в общей сложности шесть столбцов с первыми двумя столбцами, повторенными из исходной таблицы.

Имя пользовательского стиля, чтобы примениться к заголовкам табличных срезов, которые генерирует этот генератор отчетов. Заданный стиль должен быть задан в отчете, к которому добавляется этот генератор отчетов. Если это свойство пусто ('', "", или []), заголовки среза используют стиль по умолчанию, заданный в шаблоне генератора отчетов.

Источник шаблона для этого генератора отчетов, заданного одним из этих способов:

  • Вектор символов или скаляр строки, который задает путь файла, который содержит шаблон для этого генератора отчетов

  • Генератор отчетов или отчет, шаблон которого используется в этом генераторе отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

  • Документ DOM или часть документа, шаблон которой используется в этом генераторе отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

Заданный шаблон должен быть тем же типом как отчет, к которому добавлен этот генератор отчетов. Например, для отчета Word Microsoft®, TemplateSrc должен быть шаблон генератора отчетов Word. Если TemplateSrc свойство пусто, этот генератор отчетов использует шаблон генератора отчетов по умолчанию в выходном типе отчета.

Имя шаблона для этого генератора отчетов, заданного как вектор символов или скаляр строки. Шаблон для этого генератора отчетов находится в библиотеке шаблонов источника шаблона (TemplateSrc) для этого генератора отчетов.

Цель гиперссылки для этого генератора отчетов, заданного как строка или символьный массив, который задает ID цели ссылки или mlreportgen.dom.LinkTarget объект. Значение строки или символьного массива преобразовано в LinkTarget объект. Объект цели ссылки сразу предшествует содержимому этого генератора отчетов в выходном отчете.

Методы

createTemplate Создайте табличный шаблон
customizeReporterСоздайте пользовательский класс генератора отчетов базовой таблицы
getClassFolder Расположение файла определения класса базовой таблицы
getContentReporter Получите генератор отчетов отверстия содержимого базовой таблицы
getTitleReporter Получите генератор отчетов заголовка базовой таблицы

Унаследованные методы

customizeReporterСоздайте класс, выведенный из класса Генератора отчетов
getImpl Получите реализацию генератора отчетов

Копировать семантику

Указатель. Чтобы изучить, как классы Handle влияют на операции копии, смотрите Копирование Объектов (MATLAB).

Примеры

Добавьте таблицы в отчет

Добавьте две таблицы в отчет. Первая таблица является рангом 5 магических квадратов. Вторая таблица включает два изображения.

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = Report('tables');
chapter = Chapter();
chapter.Title = 'Table example';
add(rpt,chapter);

table = BaseTable(magic(5));
table.Title = 'Rank 5 Magic Square';
add(rpt,table);

add(rpt,Paragraph());
imgSize = {Height('2in'),Width('2in')};
img1 = Image(which('b747.jpg'));
img1.Style = imgSize;
img2 = Image(which('peppers.png'));
img2.Style = imgSize;
table = BaseTable({'Boeing 747' 'Peppers'; img1, img2});
table.Title = 'Picture Gallery';
add(rpt,table);

delete(gcf);
rptview(rpt);

Смотрите также

| | | |

Темы

Введенный в R2017b

Документация MATLAB Report Generator
Поддержка
Для просмотра документации необходимо авторизоваться на сайте