mlreportgen.report. Изобразите класс

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

Изобразите генератор отчетов

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

Описание

Создайте генератор отчетов фигуры с заголовком, фигурой и заголовком.

Конструкция

fig = Figure() создает генератор отчетов, который заставляет снимок состояния фигуры в настоящее время открыться в MATLAB® и добавляет его в отчет. Используйте свойства фигуры добавить заголовок или изменить размер фигуры. Изображение снимка состояния хранится во временной папке отчета. Когда отчет закрывается, изображение снимка состояния копируется в отчет и затем, изображение удалено из временной папки. Чтобы препятствовать тому, чтобы файлы изображений снимка состояния были удалены, используйте свойство Debug отчета. Смотрите mlreportgen.report.Report.

fig = Figure(source) создает генератор отчетов, который добавляет фигуру, заданную source.

fig = Figure(Name,Value) свойства наборов с помощью пар "имя-значение". Можно задать несколько аргументов пары "имя-значение" в любом порядке. Заключите каждое имя свойства в одинарные или двойные кавычки.

Входные параметры

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

Свойство See Source.

Свойства

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

Изобразите изображение, заданное как класс генератора отчетов mlreportgen.report.FormalImage. Генератор отчетов использует gcf, чтобы получить текущую фигуру MATLAB. Это использует формальный генератор отчетов изображений, чтобы ввести фигуру в отчет. Генератор отчетов фигуры инициализирует свойство Snapshot. Не сбрасывайте это свойство. Используйте свойства объекта FormalImage задать размер снимка состояния или его заголовка.

Изобразите источник, заданный как строка или символьный массив, указывающий на путь к допустимому файлу фигуры или допустимому графическому указателю.

Создайте снимки формат изображения, заданный как строка или символьный массив. Поддерживаемые форматы:

  • 'auto' Использование формат .svg для HTML или PDF вывод. Использование формат .emf для Word вывод на Windows. Использование .png для Word вывод на Unix или Mac.

  • BMP Растровое изображение

  • GIF - формат обмена графическими данными

  • .jpg — Изображение JPEG

  • .png — Изображение PNG

  • .emf — Расширенный метафайл, поддержанный только в DOCX вывод на платформах Windows®

  • .svg — Масштабируемая векторная графика

  • .tif — Пометьте формат Файла изображения, не поддержанный в выводе HTML

  • .pdf — Изображение PDF

Масштабирование опций для фигуры создает снимки изображение, заданное как строка, auto или custom. Scaling управляет размером изображения снимка состояния фигуры в файле изображения.

  • 'auto' Для PDF или Word (docx) вывод, масштабирует изображение снимка состояния фигуры, чтобы поместиться в текущий макет страницы при поддержании его соотношения сторон. Во-первых, изображение снимка состояния фигуры масштабируется к странице width. Если высота изображения превышает высоту страницы, то изображение снова уменьшено масштаб. Это дополнительное масштабирование гарантирует, что изображение помещается в текущую страницу с дополнительным 1-дюймовым интервалом. Дополнительный интервал допускает дополнительный текст, такой как заголовок. Масштабирование не применяется к выводу HTML.

  • custom — Масштабирует изображение снимка состояния фигуры на основе значений свойств Height и Width.

Примечание

java.lang.OutOfMemoryError может произойти, когда вы устанавливаете Scaling на custom и имеете большие значения для свойств Height и Width. Чтобы избежать этой ошибки, используйте меньший Height и значения Width, который гарантирует, что фигура соответствует на странице.

Высота снимка состояния отображает для пользовательского масштабирования, заданного как строка. Это свойство применяется, только если Scaling установлен в custom.

Форматом Height является valueUnits, где Units является сокращением от единиц высоты, и value является количеством модулей. Таблица показывает допустимые сокращения Units.

МодулиМодульное сокращение
'pixels'px
'centimeters'cm
'inches'in
миллиметрыmm
цицероpc
'points'pt

Ширина снимка состояния отображает для пользовательского масштабирования, заданного как строка. Это свойство применяется, только если Scaling установлен в custom.

Форматом Width является valueUnits, где Units является сокращением от единиц ширины, и value является количеством модулей. Смотрите свойство Height для таблицы допустимых сокращений Units.

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

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

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

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

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

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

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

Методы

createTemplate Создайте шаблон фигуры
customizeReporter Создайте пользовательский класс генератора отчетов фигуры
getClassFolder Изобразите расположение файла определения класса
getSnapshotImageПолучите канал передачи изображения снимка состояния

Унаследованные методы

customizeReporterСоздайте класс, выведенный из класса Генератора отчетов
getImpl Получите реализацию генератора отчетов

Копировать семантику

Указатель. Чтобы изучить, как классы Handle влияют на операции копии, смотрите Копирование Объектов (MATLAB).

Примеры

Добавьте фигуру объемной поверхностной диаграммы в отчет

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

import mlreportgen.report.*
surf(peaks);
rpt = Report('peaks');
chapter = Chapter();
chapter.Title = 'Figure Example';
add(rpt,chapter);

fig = Figure();
fig.Snapshot.Caption = '3-D shaded surface plot';
fig.Snapshot.Height = '5in';

add(rpt,fig);
delete(gcf);
rptview(rpt);

Добавьте две фигуры в страницу отчета

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

import mlreportgen.report.*
import mlreportgen.dom.*
rpt = Report('peaks');

surf(peaks(20));
figure = Figure();
peaks20 = Image(getSnapshotImage(figure,report));
peaks20.Width = '3in';
peaks20.Height = [];

surf(peaks(40));
figure = Figure();
peaks40 = Image(getSnapshotImage(figure,report));
peaks40.Width = '3in';
peaks40.Height = [];
delete(gcf);

t = Table({peaks20,peaks40;'peaks(20)','peaks(40)'});
add(rpt,t);
close(rpt);
rptview(rpt);

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

| | | |

Темы

Введенный в R2017b

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