mlreportgen.dom.Document class

Пакет: mlreportgen.dom

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

Описание

Используйте объект mlreportgen.dom.Document класс, чтобы представлять документ Объектной модели документа (DOM). Используйте Document свойства объектов, чтобы задать:

Сгенерировать ли HTML, Microsoft^® Word или документ в формате PDF
Где и как хранить сгенерированный документ
Шаблон, чтобы использовать, чтобы отформатировать документ

mlreportgen.dom.Document классом является handle класс.

Атрибуты класса

`ConstructOnLoad`	`true`
`HandleCompatible`	`true`

Для получения информации об атрибутах класса см. Атрибуты класса.

Создание

Описание

documentObj = mlreportgen.dom.Document() создает Document объект со значениями свойств по умолчанию, которые задают выходной файл под названием Untitled.htmx в текущей папке, с помощью шаблона HTML по умолчанию.

documentObj = mlreportgen.dom.Document(outputPath) задает путь и имя выходного файла и устанавливает OutputPath свойство к outputPath.

пример

documentObj = mlreportgen.dom.Document(outputPath,type) также задает выходной тип и устанавливает Type свойство к type.

documentObj = mlreportgen.dom.Document(outputPath,type,templatePath) также задает путь и имя файла шаблона и устанавливает TemplatePath свойство к templatePath.

Свойства

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

`OutputPath` — Путь и имя выходного файла или папки для этого документа
строковый скаляр | вектор символов

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

Значением по умолчанию является путь файла или папки под названием untitled в текущей папке. Если OutputPath задает файл, и вы не задаете расширение файла, API DOM добавляет расширение на основе Type свойство.

Ли OutputPath задает путь файла, или папка зависит от значения PackageType свойство, как показано в таблице.

`PackageType`	`OutputPath` Значение
`"zipped"` или `"single-file"`	Путь и имя zip-файла или одного файла
`"unzipped"`	Папка для разархивированных файлов
`"both"`	Путь и имя zip-файла и папки для разархивированных файлов

Примечание

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`PackageType` — Упаковка для сгенерированных файлов
`"zipped"` | `"unzipped"` | `"both"` | `"single-file"`

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

Значение	Поддерживаемые типы отчета	Описание
`"zipped"`	`"docx"`или `"html"`	Генерирует отчет как zip-файл в местоположении, заданном `OutputPath` свойство. Zip-файл имеет расширение, которое совпадает с типом документа (`.docx` для Word выход или `.htmx` для вывода HTML.), Например, если документ `Type` `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"`	Генерирует отчет как один файл.

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`ForceOverwrite` — Перезаписать ли существующий выходной файл
`true` (значение по умолчанию) | `false`

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`StreamOutput` — Опция, чтобы передать выход потоком к диску
`false` (значение по умолчанию) | `true`

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`TitleBarText` — Текст для строки заголовка браузера HTML
строковый скаляр | вектор символов

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

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`HTMLHeadExt` — Пользовательское содержимое для заголовка HTML
строковый скаляр | вектор символов

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`TemplatePath` — Путь шаблона, чтобы использовать
строковый скаляр | вектор символов

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Type` — Тип выхода
`"html"` (значение по умолчанию) | `"docx"` | `"pdf"` | `"html-file"`

Тип выхода в виде одного из этих строковых скаляров или векторов символов:

"html" — Вывод HTML упаковал как заархивированная или разархивированная папка, которая содержит текст документа HTML, изображение, таблицу стилей и JavaScript^® файлы
"docx" — Word выход
"pdf" — PDF выход
"html-file" — Один файл HTML, который содержит текст, таблицы стилей, JavaScript, и отображает для отчета

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`CurrentHoleId` — ID текущего отверстия в документе
символьный вектор

ID текущего отверстия в документе в виде вектора символов.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

`CurrentHoleType` — Тип текущего отверстия
`'Inline'` | `'Block'`

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

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

`CurrentPageLayout` — Текущий макет страницы этого документа
`mlreportgen.dom.DOCXPageLayout` возразите | `mlreportgen.dom.PDFPageLayout` возразите | `[]`

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

`OpenStatus` — Открытое состояние документа
`'unopened'` (значение по умолчанию) | `'open'` | `'closed'`

Открытое состояние этого документа в виде 'unopened'открытый, или 'closed'.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

`Parent` — Родительский элемент этого объекта DOM API
Объект DOM API

Родительский элемент этого объекта DOM API в виде объекта DOM API.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

`Children` — Дочерние элементы этого объекта DOM API
массив объектов ДОМА АПИ

Дочерние элементы этого объекта DOM API в виде массива объектов ДОМА АПИ.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

`Tag` — Пометьте для этого объекта DOM API
вектор символов | строковый скаляр

Пометьте для этого объекта DOM API в виде вектора символов или строкового скаляра.

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Id` — ID для этого объекта DOM API
вектор символов | строковый скаляр

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

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

Методы

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

Открытые методы

`addHTML`	Добавьте строку HTML к документу
`addHTMLFile`	Добавьте содержимое файла HTML к документу
`append`	Добавьте объект DOM или MATLAB зарегистрировать
`close`	Закройте документ
`createAutoNumberStream`	Создайте поток нумерации
`mlreportgen.dom.Document.createTemplate`	Создайте файл шаблона DOM
`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`	Установите базовые свойства OPC выходного документа или шаблона

Примеры

свернуть все

Создайте Word Document

Скрипт Open Live Script

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

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

append(d,"Hello World");

close(d);
rptview(d);

Создайте документ HTML как один файл

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

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

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

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

close(d); 
rptview(d);

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

mlreportgen.dom.Document class

Описание

Атрибуты класса

Создание

Описание

Свойства

OutputPath — Путь и имя выходного файла или папки для этого документа строковый скаляр | вектор символов

Атрибуты:

PackageType — Упаковка для сгенерированных файлов "zipped" | "unzipped" | "both" | "single-file"

Атрибуты:

ForceOverwrite — Перезаписать ли существующий выходной файл true (значение по умолчанию) | false

Атрибуты:

StreamOutput — Опция, чтобы передать выход потоком к диску false (значение по умолчанию) | true

Атрибуты:

TitleBarText — Текст для строки заголовка браузера HTML строковый скаляр | вектор символов

Атрибуты:

HTMLHeadExt — Пользовательское содержимое для заголовка HTML строковый скаляр | вектор символов

Атрибуты:

TemplatePath — Путь шаблона, чтобы использовать строковый скаляр | вектор символов

Атрибуты:

Type — Тип выхода "html" (значение по умолчанию) | "docx" | "pdf" | "html-file"

Атрибуты:

CurrentHoleId — ID текущего отверстия в документе символьный вектор

Атрибуты:

CurrentHoleType — Тип текущего отверстия 'Inline' | 'Block'

Атрибуты:

CurrentPageLayout — Текущий макет страницы этого документа mlreportgen.dom.DOCXPageLayout возразите | mlreportgen.dom.PDFPageLayout возразите | []

Атрибуты:

OpenStatus — Открытое состояние документа 'unopened' (значение по умолчанию) | 'open' | 'closed'

Атрибуты:

Parent — Родительский элемент этого объекта DOM API Объект DOM API

Атрибуты:

Children — Дочерние элементы этого объекта DOM API массив объектов ДОМА АПИ

Атрибуты:

Tag — Пометьте для этого объекта DOM API вектор символов | строковый скаляр

Атрибуты:

Id — ID для этого объекта DOM API вектор символов | строковый скаляр

Атрибуты:

Методы

Открытые методы

Примеры

Создайте Word Document

Создайте документ HTML как один файл

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

Темы

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

Поддержка

`OutputPath` — Путь и имя выходного файла или папки для этого документа
строковый скаляр | вектор символов

`PackageType` — Упаковка для сгенерированных файлов
`"zipped"` | `"unzipped"` | `"both"` | `"single-file"`

`ForceOverwrite` — Перезаписать ли существующий выходной файл
`true` (значение по умолчанию) | `false`

`StreamOutput` — Опция, чтобы передать выход потоком к диску
`false` (значение по умолчанию) | `true`

`TitleBarText` — Текст для строки заголовка браузера HTML
строковый скаляр | вектор символов

`HTMLHeadExt` — Пользовательское содержимое для заголовка HTML
строковый скаляр | вектор символов

`TemplatePath` — Путь шаблона, чтобы использовать
строковый скаляр | вектор символов

`Type` — Тип выхода
`"html"` (значение по умолчанию) | `"docx"` | `"pdf"` | `"html-file"`

`CurrentHoleId` — ID текущего отверстия в документе
символьный вектор

`CurrentHoleType` — Тип текущего отверстия
`'Inline'` | `'Block'`

`CurrentPageLayout` — Текущий макет страницы этого документа
`mlreportgen.dom.DOCXPageLayout` возразите | `mlreportgen.dom.PDFPageLayout` возразите | `[]`

`OpenStatus` — Открытое состояние документа
`'unopened'` (значение по умолчанию) | `'open'` | `'closed'`

`Parent` — Родительский элемент этого объекта DOM API
Объект DOM API

`Children` — Дочерние элементы этого объекта DOM API
массив объектов ДОМА АПИ

`Tag` — Пометьте для этого объекта DOM API
вектор символов | строковый скаляр

`Id` — ID для этого объекта DOM API
вектор символов | строковый скаляр