Exponenta Banner
exponenta event banner

mlreportgen.report. Класс FormalImage

Пакет: mlreportgen.report

Репортер с подписями

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

Описание

Создайте репортер для изображения с подписью.

Строительство

image = FormalImage() создает пустой репортер изображений. Используйте свойства репортера для установки источника изображения, подписи, высоты, ширины и т. д. Репортер использует шаблон для форматирования и нумерации подписи и размещения ее относительно изображения. Чтобы настроить формат, можно указать пользовательский шаблон или переопределить его программно, используя свойства этого репортера.

image = FormalImage(source) создает репортер изображений, который добавляет изображение, указанное source в отчет. См. раздел Image собственность.

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

Входные аргументы

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

Источник изображения для добавления в отчет, указанный как строка или символьный массив или как объект DOM Image. См. раздел Image собственность.

Свойства

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

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

Поддерживаются следующие форматы изображений:

  • .bmp - Растровое изображение

  • .gif - Формат обмена графикой

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

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

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

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

  • .tif - Формат файла изображения тега, не поддерживается в выходных данных HTML

  • .pdf - изображение PDF (поддерживается только в выходных данных PDF)

Этот репортер вставляет указанное изображение в абзац, стиль которого определяется шаблоном репортера. Стиль абзаца определяет выравнивание и интервал изображения относительно его подписи. Чтобы настроить выравнивание и интервал, настройте FormalImage шаблон в библиотеке шаблонов для репортера.

Подпись к формальному изображению, указанному как одно из следующих значений:

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

  • Объект DOM

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

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

  • Репортер дыры, возвращенный getCaptionReporter метод

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

Встроенное содержимое - это содержимое, которое может содержать абзац. Если значение подписи является встроенным содержимым, репортер использует шаблон, хранящийся в его библиотеке шаблонов, для форматирования подписи. Шаблон автоматически нумерует подпись с использованием формата, который зависит от того, находится ли изображение в нумерованной или ненумерованной главе.

  • Изображение в пронумерованной главе имеет префикс текста подписи формы 'Рисунок N.M.', где N - номер главы, а M - номер фигуры в главе. Например, префикс для третьего изображения во второй главе отчета представлен на рис. 2.3.

  • Изображение в ненумерованной главе имеет префикс заголовка формы «Рисунок N», где N равно 1 для первого изображения в отчете, 2 для второго изображения и так далее.

Во многих языках, отличных от английского, префикс подписи переводится на язык и формат языка. См. свойство Locale для mlreportgen.report.Report список переведенных языковых стандартов.

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

Width format -, где Units - аббревиатура для единиц ширины, а value - количество единиц. В таблице приведены допустимые сокращения единиц измерения.

ЕдиницыСокращение единиц измерения
пикселиpx
сантиметрыcm
дюймыin
миллиметрыmm
цицероpc
пунктыpt
процент%

Если задана ширина изображения, но не высота, высота масштабируется, чтобы сохранить пропорции изображения.

Пример: 5in

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

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

Если задать высоту изображения, но не ширину, ширина масштабируется, чтобы сохранить пропорции изображения.

Масштабировать ли этот формальный образ, указанный как логическое значение. Это свойство определяет, следует ли масштабировать изображение между полями страницы Microsoft ® Word или PDF или табличной записи .

Карта областей гиперссылок в этом формальном изображении, указанная как mlreportgen.dom.ImageMap объект. Это свойство применяется только к отчетам HTML и PDF. Использовать mlreportgen.dom.ImageArea чтобы определить области изображения и затем добавить их на карту. Области изображения - это области изображения, содержащие гиперссылки для открытия содержимого в браузере или перехода в другое расположение на той же странице.

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

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

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

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

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

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

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

Методы

createTemplate Создать шаблон формального изображения
customizeReporterСоздать класс отчетов настраиваемых формальных изображений
getCaptionReporterПолучить image caption Репортер
getClassFolder Расположение файла определения класса формальных изображений
getImageReporter Получить формальный репортер по изображениям

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

копия Создание копии объекта reporter и создание глубоких копий определенных значений свойств
getImpl Получить реализацию репортера

Примеры

Добавление изображения в отчет

Добавьте пустой репортер изображений в отчет, а затем задайте его источник, подпись и высоту. 

import mlreportgen.report.*
rpt = mlreportgen.report.Report('output','pdf');
chapter = mlreportgen.report.Chapter();
chapter.Title = 'Formal Image Reporter Example';

image = mlreportgen.report.FormalImage();
image.Image = which('ngc6543a.jpg');
image.Caption = 'Cat''s Eye Nebula or NGC 6543';
image.Height = '5in';

add(chapter,image);
add(rpt,chapter);
rptview(rpt);

Изменить цвет подписи изображения

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

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = Report('output','pdf');
chapter = Chapter();
chapter.Title = 'Formal Image Reporter Example';

image = FormalImage();
image.Image = which('ngc6543a.jpg');
text = Text('Cat''s Eye Nebula or NGC 6543');
text.Color = 'red';
image.Caption = text;

add(chapter,image);
add(rpt,chapter);
rptview(rpt);

Изменение форматирования изображения и подписи

Добавление изображения в отчет и переопределение его выравнивания, шрифта подписи и полей

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = Report('output','pdf');
chapter = Chapter();
chapter.Title = 'Formal Image Reporter Example';

image = FormalImage();
image.Image = which('ngc6543a.jpg');
image.Height = '5in';

para = Paragraph('System Design Description');
para.Style = {HAlign('left'),FontFamily('Arial'),...
     FontSize('12pt'),Color('white'),...
     BackgroundColor('blue'), ...
     OuterMargin('0in', '0in','.5in','1in')};
image.Caption = para;

add(chapter,image);
add(rpt,chapter);
rptview(rpt);

Создание карты изображений

Создайте карту изображений с определенной областью изображения в верхнем левом углу и добавьте это изображение в отчет. При щелчке в области изображения отображается веб-страница, связанная с этой областью.

import mlreportgen.report.*;
rpt = Report('test','pdf');

image = FormalImage(which('ngc6543a.jpg'));
area = mlreportgen.dom.ImageArea('https://www.google.com',...
     'Google',0,0,100, 100);
map = mlreportgen.dom.ImageMap;
append(map,area);
image.Map = map;

add(rpt,image);
close(rpt);
rptview(rpt);

См. также

| | | | |

Темы

Представлен в R2017b

Документация по генератору отчетов MATLAB

Поддержка