mlreportgen.report.BaseTable class

Пакет: mlreportgen.report

Создать таблицу репортера

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

Описание

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

Конструкция

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

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

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

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

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

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

Свойства

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

Заголовок таблицы, заданный в качестве одного из следующих значений:

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

  • Объект DOM

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

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

  • Репортер отверстие, возвращенный getTitleReporter метод

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

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

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

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

Содержимое таблицы, заданное в качестве одного из следующих значений:

  • DOM- Table объект

  • DOM- FormalTable объект

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

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

  • Репортер отверстие вернулся по getContentReporter метод

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

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

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

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

Модули измеренияМодули
пкспиксели
cmсантиметры
вдюймы
mmмиллиметры
PCцицеро
ptточки
%процент

Пример: 5in

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

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

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

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

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

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

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

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

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

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

Методы

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

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

копия Создайте копию объекта reporter и сделайте глубокие копии определенных значений свойств
getImpl Получите реализацию reporter

Примеры

Добавление таблиц к отчету

Добавьте две таблицы к отчету. Первая таблица является магическим квадратом 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

Поддержка

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