Exponenta Banner
exponenta event banner

класс mlreportgen.dom.Template

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

Создать объект шаблона отчета

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

Описание

Создание объекта шаблона отчета.

Использовать mlreportgen.dom.Template объекты для создания шаблонов. Например, можно добавить содержимое DOM, например Text, Paragraph, или Image объекты, и TemplateHole объекты в Template создание шаблона, содержащего фиксированное содержимое с отверстиями для создаваемого содержимого.

Примечание

Word for Mac не поддерживает создание отверстий для шаблонов DOM API. Если требуется создать шаблон Word для создания документов Word на компьютере Mac, можно создать шаблон с помощью DOM API. Создать Template объект и использование mlreportgen.dom.TemplateHole для добавления отверстий. Кроме того, используйте Word в Windows ® для создания шаблона и копирования шаблона на Mac.

Строительство

templateObj = Template() создает объект шаблона на основе шаблона HTML по умолчанию. Результирующий шаблон находится в текущей папке и использует имя Untitled.htmtx.

Добавить содержимое и использовать соответствующее close для создания файла шаблона.

templateObj = Template(templatePath) создает объект шаблона, который выводит файл шаблона в указанном месте. Тип шаблона по умолчанию, если расширение не указано, - HTML.

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

Совет

Использовать переменную для type аргумент для упрощения кода. Пример см. в разделах Создание шаблона и Добавление содержимого.

templateObj = Template(templatePath,type,sourceTemplatePath) создает шаблон на основе шаблона sourceTemplatePath.

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

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

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

  • .htmtx для HTML (по умолчанию)

  • .docx для слова

  • .htmt для однофайлового HTML

  • .pdf для PDF

Тип шаблона, указанный как одно из следующих значений:

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

  • 'docx'- Шаблон слова

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

  • .pdf - шаблон PDF

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

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

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

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

Шаблон для создания, возвращенный как mlreportgen.dom.Template объект.

Свойства

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

Дочерние элементы этого элемента документа, указанные как массив объектов 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, указанное как символьный вектор.

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

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

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

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

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

Упаковка для созданных выходных файлов, указанных как одно из следующих значений:

  • 'zipped' - Применяется только для вывода в формате Word, PDF и многофайловом формате HTML.

  • 'unzipped' - Применяется только для вывода в формате Word, PDF и многофайловом формате HTML.

  • 'both' - Применяется только для вывода в формате Word, PDF и многофайловом формате HTML.

  • 'single-file' - создает отчет как единый файл. Это значение появляется, если задать документ Type свойство для 'html-file'. Вы не можете самостоятельно установить или изменить это значение.

Для ZIP-упаковки выходные данные документа представляют собой ZIP-файл, расположенный в расположении, указанном в OutputPath собственность. Zip-файл имеет расширение, соответствующее типу документа: docx для вывода слова, pdftx для вывода PDF, или htmtx для вывода в формате HTML. Например, если вид документа - docx и OutputPath является s:\docs\MyDoc, выходные данные упакованы в zip-файл с именем s:\docs\MyDoc.docx.

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

Если установить PackageType кому bothсоздание отчета приводит к созданию zipped и unzipped выходных данных.

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

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

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

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

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

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

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

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

Тип вывода, указанный как одно из следующих значений:

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

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

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

  • 'pdf' - вывод в формате PDF

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

Методы

Используйте Template методы так же, как вы используете соответствующий Document методы.

Метод

Цель

append

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

close

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

mlreportgen.dom.Document.createTemplate

Создать шаблон по умолчанию.

fill

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

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

Задать свойства ядра элемента документа.

Примеры

свернуть все

В этом примере создается шаблон с отверстием для заголовка и отверстием для автора. Можно изменить значение type для создания шаблона одного из других типов.

import mlreportgen.dom.*;

type = 'docx';

% Create a template object
t = Template('mytemplate',type);

% Add a title hole to the template and apply the Title style
hole = append(t,TemplateHole('TITLE'));
hole.Description = ('Title Description');
hole.DefaultHoleStyleName = 'Title';

% Add a paragraph with boilerplate text and apply the Subtitle format
% Position the paragraph and preserve white space in the text 
p = Paragraph('Author: ');
p.StyleName = 'Subtitle';
p.Style = {OuterMargin('0','0','1in','1in')};
p.WhiteSpace = 'preserve';

% Append an inline hole to paragraph  
hole = append(p,TemplateHole('AUTHOR'));
append(t,p);

close(t);

В этом примере для заполнения отверстий используется шаблон. 

% Create a document TitleAuthor that uses the template mytemplate.
rpt = Document('TitleAuthor',type,'mytemplate');
open(rpt);

% Create a loop to cycle through the holes. 
% Append content to each hole.
while(~strcmp(rpt.CurrentHoleId,'#end#'))
    switch(rpt.CurrentHoleId)
        case 'TITLE'
            append(rpt,Paragraph('This Is My Title'));
        case 'AUTHOR'
            append(rpt,'My Name');
    end
    
    moveToNextHole(rpt);
end

% Generate and view the report.
close(rpt);
rptview(rpt.OutputPath)

См. также

| |

Темы

Документация по генератору отчетов MATLAB

Поддержка