Exponenta Banner
exponenta event banner

mlreportgen.dom.Класс документа

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

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

  • 'pdf'- документ 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 для вывода в формате 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 или распакованной папки, содержащей текст 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

Поддержка