mlreportgen.dom.Image class

Пакет: mlreportgen.dom

Отобразите, чтобы включать в отчет

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

Описание

Используйте объект mlreportgen.dom.Image класс, чтобы включать изображение в отчет.

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

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

ConstructOnLoad
true
HandleCompatible
true

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

Создание

Описание

пример

imageObj = mlreportgen.dom.Image(imagePath) создает mlreportgen.dom.Image объект с набором свойств Пути к пути изображения.

Примечание

Содержимое заданного файла изображения копируется в выходной документ, когда документ закрывается. Не удаляйте или перезаписывайте файл изображения прежде, чем закрыть документ. Если вы создаете файл изображения и соответствующий mlreportgen.dom.Image объект в цикле, для каждой итерации цикла, использует уникальное имя файла для файла изображения.

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

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

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

'imageFormat' Расширение файлаПоддерживаемый тип документа
HTMLWordPDF
Windows® битовый массив.bmp
Метафайл Windows.emf  
Формат обмена графическими данными .gif
Изображение JPEG.jpg
PDF.pdf  
Переносимая сетевая графика .png
Масштабируемая векторная графика.svg
Изображение TIFF.tif 

Свойства

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

Путь файла изображения в виде вектора символов. Это свойство доступно только для чтения.

Высота изображения в виде вектора символов или строкового скаляра, который состоит из номера, сопровождаемого сокращением от единицы измерения. Например, "2in" задает два дюйма. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

  • % — процент

Когда Image объект создается, Height свойство установлено в значение на основе файла изображения, заданного Path свойство.

Ширина изображения в виде вектора символов или строкового скаляра, который состоит из номера, сопровождаемого сокращением от единицы измерения. Например, "2in" задает два дюйма. Допустимые сокращения:

  • px — пиксели (значение по умолчанию)

  • cm 'centimeters'

  • in 'inches'

  • mm — миллиметры

  • pc — цицеро

  • pt 'points'

  • % — процент

Когда Image объект создается, Width свойство установлено в значение на основе файла изображения, заданного Path свойство.

Карта областей гиперссылки в этом изображении в виде mlreportgen.dom.ImageMap объект. Map свойство применяется только к HTML и отчетам PDF.

Смотрите создают карты изображения.

Имя изображения разрабатывает в виде вектора символов или строкового скаляра. StyleName значение должно быть стилем в таблице стилей части документа или документа, к которой добавлено это изображение. Объекты формата в Style свойство этого Image возразите заменяют стиль в таблице стилей.

Примечание

StyleName свойство проигнорировано для Word выход.

Форматы, которые задают стиль этого изображения в виде массива ячеек объектов формата DOM. Форматы заменяют соответствующие форматы, заданные стилем, заданным StyleName свойство. Смотрите Создают и Изображения Формата.

Пользовательские атрибуты этого элемента документа в виде массива mlreportgen.dom.CustomAttribute объекты. Пользовательские атрибуты должны поддерживаться выходным форматом.

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

Это свойство проигнорировано.

Пометьте для этого элемента документа в виде вектора символов или строкового скаляра.

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

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

Методы

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

Примеры

свернуть все

Скрипт Open Live Script

Используйте mlreportgen.dom.Image объект задать изображение, которое вы хотите включать в отчет. Включайте изображение в отчет путем добавления Image возразите против отчета.

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

import mlreportgen.dom.*

Создайте отчет и добавьте заголовок для изображения с помощью mlreportgen.dom.Paragraph объект.

d = Document("myImageReport","docx");

p = Paragraph("Plot 1");
p.Bold = true;
append(d,p);

Сохраните график как файл изображения.

x = 0:pi/100:2*pi;
y = sin(x);
plot(x,y);

saveas(gcf,"myPlot_img.png");

Создайте mlreportgen.dom.Image объект, который задает путь файла изображения. Укажите, что ширина и высота составляют 4 дюйма. Добавьте Image возразите против отчета.

plot1 = Image("myPlot_img.png");
plot1.Width = "4in";
plot1.Height = "4in";
append(d,plot1);

Закройте и просмотрите отчет.

close(d);
rptview(d);

Вот изображение в сгенерированном отчете:

Вопросы совместимости

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

Поведение изменяется в R2019b

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

| | | |

Темы

Введенный в R2014b

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

Поддержка

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