mlreportgen.report. Класс заголовка

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

Заполните генератор отчетов дыры заголовка

Описание

Генератор отчетов для других генераторов отчетов, таких как FormalImage и BaseTable. Эти другие генераторы отчетов используют экземпляры этого генератора отчетов Title, чтобы заполнить дыры заголовка в их шаблонах. Генераторы отчетов имеют методы, которые возвращают экземпляры этого объекта. Используя эти экземпляры объектов, можно настроить формат содержимого, используемого, чтобы заполнить дыры в их шаблонах. Например, для генератора отчетов BaseTable, его метод getTitleReporter возвращает экземпляр что использование генератора отчетов BaseTable, чтобы заполнить дыру Title в ее шаблоне. Чтобы настроить формат заголовка, задайте пользовательский шаблон для генератора отчетов SectionTitle, возвращенного методом getTitleReporter.

Примечание

Генераторы отчетов создают экземпляры этого объекта. Вы не должны создавать этот объект сами.

Свойства

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

ID дыры, чтобы быть заполненным этим генератором отчетов, заданным как строка.

Содержимое дыры, чтобы быть заполненным этим генератором отчетов, заданным как одно из этих значений:

  • Строка или символьный массив

  • Объект DOM

  • 1 N или N-by-1 массив строк или Объектов DOM

  • 1 N или N-by-1 массив ячеек строк, символьных массивов и/или Объектов DOM

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

Суффикс для содержимого заголовка, заданного как строка или символьный массив. Если никакой суффикс не задан, суффикс заголовка по умолчанию, переведенный на основе локали отчета, используется.

Карта перевода для префикса заголовка и суффикса, заданного как структура MATLAB®. Если заданная карта перевода не содержит перевод для локали отчета, свойство Translations использует en в качестве резервной локали. Смотрите свойство Locale mlreportgen.report.Report для получения информации о допустимых локалях.

Источник шаблона для этого генератора отчетов, заданного как одно из этих значений:

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

  • Генератор отчетов или отчет, шаблон которого используется в качестве шаблона для этого генератора отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

  • Документ DOM или часть документа, шаблон которой используется в качестве шаблона для этого генератора отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

Заданный шаблон должен иметь тот же тип как отчет, к которому добавлен этот генератор отчетов. Например, для отчета Word, TemplateSrc должен быть шаблоном генератора отчетов Word. Если свойство TemplateSrc пусто, этот генератор отчетов использует шаблон генератора отчетов по умолчанию для выходного типа отчета.

Имя шаблона для этого генератора отчетов, заданного как строка или символьный массив. Шаблон для этого генератора отчетов находится в библиотеке шаблонов источника шаблона (TemplateSrc) для этого генератора отчетов.

Цель гиперссылки для этого генератора отчетов, заданного как строка или символьный массив, который задает ID цели ссылки или объект mlreportgen.dom.LinkTarget. Значение строки или символьного массива преобразовано в объект LinkTarget. Объект цели ссылки сразу предшествует содержимому этого генератора отчетов в выходном отчете.

Введенный в R2018b

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