Exponenta Banner
exponenta event banner

класс mlreportgen.dom.DocumentPart

Пакет: 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'- Вывод слова

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

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

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

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

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

Объект детали документа или документа, шаблон которого содержит шаблон для этой детали документа, указанный как mlreportgen.dom.Document объект для документа или mlreportgen.dom.DocumentPart для детали документа.

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

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

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

Свойства

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

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

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

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

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

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

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

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

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

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

Тег для этого элемента документа, заданный как вектор символов или скаляр строки.

DOM создает уникальный для сеанса тег как часть создания этого объекта. Созданный тег имеет вид CLASS: ID, где CLASS - класс объекта, а ID - значение Id свойства объекта. Указание собственного значения тега может помочь определить, где возникла проблема во время создания документа.

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

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

Тип вывода, указанный как одно из этих значений.

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

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

  • 'PDF' - PDF-файл

  • '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

Поддержка