mlreportgen.report.FormalImage class

Пакет: mlreportgen.report
Суперклассы:

Озаглавленный генератор отчетов изображений

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

Описание

Создайте генератор отчетов для изображения с заголовком.

Конструкция

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

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

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

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

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

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

Свойства

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

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

Поддерживаемые форматы изображения:

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

  • .gif — Формат обмена графическими данными

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

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

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

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

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

  • .pdf - Изображение PDF

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

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

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

  • Объект DOM

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

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

  • Генератор отчетов отверстия возвращен getCaptionReporter метод

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

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

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

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

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

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

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

МодулиМодульное сокращение
'pixels'px
'centimeters'cm
'inches'in
миллиметрыmm
цицероpc
'points'pt
процент%

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

Пример: 5in

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

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

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

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

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

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

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

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

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

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

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

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

Методы

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

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

customizeReporterСоздайте класс, выведенный из класса Генератора отчетов
getImpl Получите реализацию генератора отчетов

Копировать семантику

Указатель. Чтобы изучить, как классы Handle влияют на операции копии, смотрите Копирование Объектов (MATLAB).

Примеры

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

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

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 Report Generator
Поддержка
Для просмотра документации необходимо авторизоваться на сайте