mlreportgen.dom.Document class

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

Контейнер документа

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

Описание

Создайте mlreportgen.dom.Document объект, который задает:

  • Тип выхода: HTML, Microsoft® Word или PDF.

  • Где и как сохранить выход.

  • Шаблон, чтобы использовать, чтобы отформатировать документ.

Конструкция

documentObj = Document() создает документ HTML под названием Untitled.htmx в текущем каталоге, с помощью шаблона HTML по умолчанию.

Добавьте содержимое и используйте соответствующий close команда, чтобы сгенерировать документ.

documentObj = Document(outputPath) создает документ HTML в заданном местоположении.

documentObj = Document(outputPath,type) создает документ заданного типа (например, Word), с помощью шаблона по умолчанию для того типа.

documentObj = Document(outputPath,type,templatePath) создает документ, с помощью заданного типа документа и Word, PDF или шаблона HTML, соответствующего type установка.

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

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

Полный путь выходного файла или папки для этого документа. Если вы не задаете расширение файла, расширение основано на типе документа (например, .docx для Microsoft Word). Можно установить это свойство только прежде, чем открыть документ.

Как вы указываете, что путь зависит от значения PackageType свойство.

  • 'zipped' — Имя zip-файла.

  • 'unzipped' — Папка для выходных файлов.

  • 'both' — Имя zip-файла.

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

Тип выхода в виде 'html', 'docx', 'pdf', или 'html-file'.

  • 'html'— Вывод HTML как заархивированная или разархивированная папка, содержащая текст документа HTML, изображение, таблицу стилей и файлы JavaScript®.

  • 'docx'— Word выход.

  • 'pdf'— Документ в формате PDF на основе шаблона PDF.

  • 'html-file'— Вывод HTML, состоящий из одного файла, который содержит текст, таблицы стилей, JavaScript, и отображает для отчета

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

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

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

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

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

Сообщите о документе определения, представленном mlreportgen.dom.Document объект.

Свойства

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

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

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

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

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

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

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

Установите это свойство на true перезаписывать существующий выходной файл того же имени для отчета из этого документа. Если этим свойством является false и перезаписываемый файл того же имени существует, пытаясь закрыться (i.e., запишите), этот документ вызывает ошибку. Если существующий файл только для чтения, закрытие этого документа вызывает ошибку независимо от установки этого свойства.

Типы данных: логический

Пользовательское содержимое для заголовка HTML в виде вектора символов. Значение этого свойства добавлено к <head> элемент этого документа после содержимого указан главным разделом шаблона документа. Установите это свойство только прежде, чем открыть документ.

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

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

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

Для разархивированной выходной упаковки путь задает папку для выходных файлов. Значением по умолчанию является текущая папка.

Примечание

Генерирование отчета PDF относительно диска облака, такого как MATLAB® Drive™, может привести к ошибке, которая вызывается конкуренцией файла между программным обеспечением генерации отчета и программным обеспечением синхронизации диска облака. Чтобы избежать этой ошибки, сгенерируйте отчеты относительно локального диска, который не синхронизируется с облаком. Рассмотрите запись скрипта, который генерирует отчет относительно локального диска и затем копирует отчет в диск облака.

Упаковка используемого для сгенерированных файлов в виде одного из значений в таблице.

ЗначениеПоддерживаемые типы отчетаОписание

'zipped'

'docx'или 'html'

Генерирует отчет как zip-файл в местоположении, заданном OutputPath свойство. Zip-файл имеет расширение, которое совпадает с типом документа (docx для Word выход или htmtx для вывода HTML.), Например, если типом документа является docx и OutputPath s:\docs\MyDoc, выход упакован в zip-файле под названием s:\docs\MyDoc.docx.

'unzipped'

'docx' или 'html'

Генерирует отчет как отдельные файлы в папке, которая имеет имя файла OutputPath свойство. Например, если OutputPath s:\docs\MyDoc, выходной папкой является s:\docs\MyDoc.

'both'

'docx' или 'html'

Генерирует заархивированные и разархивированные выходные параметры.

'single-file'

'pdf' или 'html-file'

Генерирует отчет как один файл.

Когда Type свойством является 'html', чтобы сгенерировать отчет HTML, который можно открыть без разархивации, установите PackageType к 'unzipped' или 'both'. В папке, которая содержит сгенерированные файлы, откройте root.html файл.

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

По умолчанию элементы документа хранятся в памяти, пока документ не закрывается. Установите это свойство на true чтобы записать элементы документа в диск как, элементы добавлены к документу.

Типы данных: логический

Пометьте для этого документа в форме CLASS:ID, где CLASS класс документов и ID значение Id свойство объекта. Можно задать пользовательский тег как вектор символов.

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

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

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

Для документов HTML это свойство задает текст, который появляется в строке заголовка браузера, используемого, чтобы отобразить этот документ. Word и документы в формате PDF игнорируют это свойство.

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

Тип выхода в виде 'html', 'docx', 'pdf', или 'html-file'.

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

  • 'docx' — Word выход.

  • 'pdf' — PDF выход.

  • 'html-file' — Вывод HTML, состоящий из одного файла, который содержит текст, таблицы стилей, JavaScript, и отображает для отчета.

Если вы задаете шаблон с помощью TemplatePath свойство, шаблон должен быть сопоставим с Type аргумент. Необходимо задать шаблон Word (.dotx) для docx выведите, пакет шаблона HTML (.htmtx) для вывода HTML, пакет шаблона PDF (.pdftx) для PDF выход и однофайловый шаблон HTML (.htmt) для html-file вывод .

Методы

Метод

Цель

addHTML

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

addHTMLFile

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

append

Добавьте элемент документа к документу

close

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

createAutoNumberStream

Автоматически создайте сгенерированный поток нумерации

mlreportgen.dom.Document.createTemplate

Создайте шаблон документов

fill

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

getAutoNumberStream

Получите автоматизированный поток нумерации

mlreportgen.dom.Document.getCoreProperties

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

mlreportgen.dom.Document.getImageDirectory

Получите папку изображений документа

mlreportgen.dom.Document.getImagePrefix

Получите сгенерированный префикс названия картинки

getMainPartPath

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

mlreportgen.dom.Document.getOPCMainPart

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

moveToNextHole

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

open

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

package

Добавьте файл к пакету OPC документа

mlreportgen.dom.Document.setCoreProperties

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

Примеры

свернуть все

Открыть скрипт

Создайте документ Word, добавьте содержимое и просмотрите отчет в Word.

import mlreportgen.dom.*;
d = Document('mydoc','docx');

append(d,'Hello World');

close(d);
rptview(d.OutputPath);

Создайте документ HTML как один файл HTML, который включает изображения документа. Пример принимает, что существует MyImage.jpg отобразите и myHTMLTemplate.htmt Файл шаблона HTML.

Создайте документ, выход которого является одним файлом HTML и использует шаблон myHTMLTemplate. Добавьте текст и изображение к отчету. Закройте документ и просмотрите его.

import mlreportgen.dom.*;
d = Document('mydoc','html-file','myHTMLTemplate'); 
open(d); 

append(d,'Hello world'); 
append(d,Image('C:/images/LocalSystem/MyImage.jpg'));

close(d); 
rptview(d.OutputPath);

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

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

Поддержка

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