Exponenta Banner
exponenta event banner

mlreportgen.dom.Класс образа

Пакет: mlreportgen.dom

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

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

Описание

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

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 - пикас

  • pt - точки

  • % - в процентах

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

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

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

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

  • in - дюймы

  • mm - миллиметров

  • pc - пикас

  • pt - точки

  • % - в процентах

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

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

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

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

Примечание

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Открыть сценарий в реальном времени

Использовать 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

Поддержка