Exponenta Banner

mlreportgen.dom.Image class

Пакет: mlreportgen.dom

Изображение для включения в отчет

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

Описание

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

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

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

ConstructOnLoad
true
HandleCompatible
true

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

Создание

Описание

пример

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

Примечание

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

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

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

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

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

Свойства

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

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

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

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

  • cm - сантиметров

  • in - дюймы

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

  • pc - picas

  • pt - точки

  • % - процент

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

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

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

  • cm - сантиметров

  • in - дюймы

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

  • pc - picas

  • pt - точки

  • % - процент

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

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

См. «Создание карт изображений».

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

Примечание

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

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

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

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

Это свойство игнорируется.

Тег для этого элемента документа, заданный как вектор символов или строковый скаляр.

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

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

Методы

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

Примеры

свернуть все

Открыть 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

См. также

| | | |

Темы

Введенный в R2013b

MATLAB Report Generator

Поддержка