mlreportgen.dom.DocumentPart class

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

Создайте объект части документа

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

Описание

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

Конструкция

documentPartObj = DocumentPart() создает часть документа HTML с помощью шаблона HTML по умолчанию.

documentPart = DocumentPart(type) создает часть документа заданного типа (например, Microsoft® Word) на основе шаблона по умолчанию для той части.

documentPartObj = DocumentPart(type,templatePath) создает часть документа на основе заданного шаблона.

documentPartObj = DocumentPart(type,templatePath,docPartTemplateName) создает часть документа на основе заданного шаблона части документа в заданном шаблоне.

documentPartObj = DocumentPart(templateSrc,docPartTemplateName) создает часть документа на основе заданного шаблона части документа, сохраненного в шаблоне, используемом заданным источником. Источник может быть документом или частью документа.

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

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

Тип выхода в виде одного из этих значений:

  • 'html'— Вывод HTML

  • 'pdf'— PDF на основе шаблона PDF

  • 'docx'— Word выход

  • 'html-file'— Вывод HTML, с помощью одного файла, который содержит CSS, JavaScript®, и отображает для отчета

Если вы задаете шаблон с помощью templatePath аргумент, значение для type должен совпадать с типом шаблона.

Полный путь файла шаблона этой части или папки в виде вектора символов. Если вы не используете расширение файла, тип шаблона основан на типе документа, например, .docx для Word.

Типы данных: char

Часть документа обрабатывает имя по шаблону в виде вектора символов. Задайте, где часть хранится с помощью templatePath или templateSrc аргумент.

Документ или часть документа возражают, чей шаблон содержит шаблон для этой части документа в виде mlreportgen.dom.Document объект для документа или mlreportgen.dom.DocumentPart объект для части документа.

Выходные аргументы

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

Часть документа, возвращенная как mlreportgen.dom.DocumentPart объект.

Свойства

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

Дочерние элементы этого элемента документа в виде массива Объектов DOM. Это свойство доступно только для чтения.

Это свойство только для чтения является ID отверстия текущего отверстия в этом документе.

Тип текущего отверстия шаблона в виде 'Inline' или 'Block'.

  • Встроенное отверстие для элементов документа, которые может содержать элемент абзаца: Textизображение, LinkTarget, ExternalLink, InternalLink, CharEntity, AutoNumber.

  • Отверстие блока может содержать ParagraphТаблица, OrderedList, UnorderedList, DocumentPart, или Group.

Это свойство применяется к Word и документам в формате PDF. Для документов Word значением является DOCXPageLayout объект, который задает текущий макет страницы. Для документов в формате PDF значением является PDFPageLayout возразите, задает ли документ в настоящее время макет страницы. Для документов HTML значение всегда [].

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

Это списки свойств только для чтения открытое состояние этого элемента документа.

Родительский элемент этого элемента документа в виде Объекта DOM. Это свойство доступно только для чтения.

Пометьте для этого элемента документа в виде вектора символов или строкового скаляра.

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

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

Путь шаблона этой части или шаблона, библиотека шаблонов которого содержит шаблон этой части в виде вектора символов.

Выведите тип в виде одного из этих значений.

  • 'HTML' – Отчет HTML, упакованный как заархивированный файл, содержащий файл HTML, изображения, таблицу стилей и файлы JavaScript отчета.

  • 'HTML-FILE' – Отчет HTML как один файл HTML, содержащий текст, таблицу стилей, JavaScript и base64-закодированные изображения отчета

  • 'PDF' pdfFile

  • 'DOCX' – Документ Microsoft Word

Если вы задаете шаблон с помощью TemplatePath свойство, значение для Type должен совпадать с типом шаблона.

Методы

Используйте DocumentPart методы как вы используют соответствующий Document методы.

Метод

Цель

addHTML

Используйте DocumentPart.addHTML похожим способом к тому, как вы используете Document.addHTML.

Добавьте текст HTML к документу

addHTMLFile

Используйте DocumentPart.addHTMLFile похожим способом к тому, как вы используете Document.addHTMLFile.

Добавьте содержимое файла HTML к документу

append

Добавьте элемент документа к части документа.

close

Закройте эту часть документа. Вы не можете закрыть часть документа, если она не была открыта или была ранее закрыта.

mlreportgen.dom.Document.createTemplate

Создайте шаблон части документа.

fill

Заполните отверстие документа.

mlreportgen.dom.Document.getCoreProperties

Получите базовые свойства части документа.

mlreportgen.dom.Document.getOPCMainPart

Получите полный путь основной части выходного документа.

moveToNextHole

Переместитесь, чтобы затем обработать отверстие по шаблону.

open

Откройте эту часть документа. Вы не можете открыть часть документа, если она была ранее открыта или закрыта. Вы также не можете открыть часть документа, если ее источник библиотеки закрывается.

mlreportgen.dom.Document.setCoreProperties

Установите базовые свойства части документа.

Примеры

свернуть все

Этот пример создает функциональный createMagicParts это задает часть документа на основе пустого шаблона части документа. Новая часть документа имеет заголовок, текст которого зависит от входа. Каждая сгенерированная часть документа содержит таблицу магического квадрата, внешний вид которой также основан на входе. Пример создает содержание функционального magicparts это добавляет часть документа к отчету итеративно на основе входа.

Создайте функцию.

function magic_square_report(square_sizes, report_type)
%MAGIC_SQUARE_REPORT Report on magic squares
%    magic_square_report(square_sizes, report_type) 
%    creates a report of the specified output type 
%    (docx, pdf, or html) on the specified magic
%    squares. For example, to create a PDF report on 
%    squares of size 5, 10, and 15, enter the following 
%    line at the MATLAB command line:
%
%      magic_square_report([5,10,15],'pdf');

import mlreportgen.dom.*;
rpt = Document('MagicSquareReport',report_type);
open(rpt);
for i = 1:length(square_sizes)
    sz = square_sizes(i);
    section = createSquareSection(rpt,sz);
    append(rpt,section);
end
close(rpt);
rptview(rpt.OutputPath);
 
function section = createSquareSection(rpt,square_size)
import mlreportgen.dom.*;
% Create document part to hold section
section = DocumentPart(rpt.Type);
% Create magic square heading
h1 = Heading1(sprintf('magic(%i)',square_size));
% Put each square on a separate page.
h1.Style = {PageBreakBefore(true)};
append(section,h1);
% Create table to hold square
table = append(section, Table(magic(square_size)));
% Format table
table.Border = 'solid';
table.ColSep = 'solid';
table.RowSep = 'solid';

Вызовите функцию, чтобы сгенерировать отчет. Измените входные параметры, чтобы изменить содержимое или выходной формат. Этот пример создает документ Word, который содержит три квадрата.

 magic_square_report([5,8,12],'docx');

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

Темы

Документация MATLAB Report Generator

Поддержка

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