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 в виде zipped или unzipped папки, содержащей текст HTML-документа, изображение, таблицу стилей и JavaScript® файлы.

  • 'docx'- Вывод слова.

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

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

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

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

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

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

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

Документ определения отчета, представленный mlreportgen.dom.Document объект.

Свойства

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

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

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

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

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

  • Блочное отверстие может содержать Paragraph, Table, OrderedList, UnorderedList, DocumentPart, или Group.

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

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

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

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

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

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

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

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

Примечание

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

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

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

'zipped'

'docx'или 'html'

Генерирует отчет как zip- файла в местоположении, заданном OutputPath свойство. zip- файла имеет расширение, соответствующее виду документа (docx для выхода или htmtx Word для выхода 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'

Формирует zipped и unzipped выходы.

'single-file'

'pdf' или 'html-file'

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

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

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

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

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

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

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

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

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

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

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

Тип выхода, заданный как 'html', 'docx', 'pdf', или 'html-file'.

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

  • 'docx' - Вывод слова.

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

Поддержка

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