mlreportgen.report.FormalImage class

Пакет: mlreportgen.report

Подписанный репортер изображений

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

Описание

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

Конструкция

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

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 - Тег Image File формат, не поддерживается в HTML выходных данных

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

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

Caption этого формального изображения, заданного в качестве одного из следующих значений:

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

  • Объект DOM

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

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

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

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

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

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

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

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

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

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

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

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

Пример: 5in

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

The Height формат valueUnits, где Units - сокращение для модулей измерения высоты, а value - количество модулей. Список допустимых сокращений по Units см. в свойстве 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Создайте пользовательский класс original image reporter
getCaptionReporterПолучить изображение caption Репортер
getClassFolder Расположение файла определения формального класса изображений
getImageReporter Получите формального репортера изображений

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

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

Примеры

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

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

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);

Change Image caption Цвет

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

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);

Измените изображение и Caption Formatting

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

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 Report Generator

Поддержка

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