mlreportgen.report.Axes class

Пакет: mlreportgen.report

Генератор отчетов осей

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

Описание

Используйте объекты mlreportgen.report.Axes класс, чтобы сообщить относительно осей, найденных в MATLAB® фигура.

mlreportgen.report.Axes классом является handle класс.

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

HandleCompatible
true

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

Создание

Описание

axes = mlreportgen.report.Axes() создает Объект осей со значениями свойств по умолчанию. Необходимо задать указатель осей, чтобы сообщить путем установки свойства Source. Используйте другие свойства задать опции отчета.

Примечание

Фигура, содержащая оси, должна остаться открытой, пока вы не добавляете генератор отчетов осей в отчет.

пример

axes = mlreportgen.report.Axes(source) создает генератор отчетов, который добавляет оси, заданные source и устанавливает свойство Source на source.

axes = mlreportgen.report.Axes(Name=Value) свойства наборов при помощи аргументов name-value. Задайте несколько аргументов name-value в любом порядке. Заключите каждое имя свойства в одинарные или двойные кавычки.

Свойства

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

Свойства для осей отображают в виде mlreportgen.report.FormalImage объект. Используйте свойства FormalImage объект задать размер снимка состояния, если вы не можете использовать Масштабирование, свойства Height и Width, не обрезая изображение.

Примечание

Генератор отчетов осей инициализирует Snapshot свойство. Не сбрасывайте это свойство.

Источник изображения осей в виде указателя осей.

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

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

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

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

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

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

  • 'tif' — Пометьте формат Файла изображения. Этот формат не поддерживается в отчетах HTML.

  • 'pdf' — Изображение PDF. Этот формат поддерживается только в отчетах PDF.

См. Вопросы совместимости.

Масштабирование опций для осей отображает в виде 'auto', 'custom', или 'none'.

  • 'auto' — Для PDF или отчетов Word, эта установка масштабирует изображение осей, чтобы соответствовать текущему макету страницы при поддержании его соотношения сторон. Во-первых, оси отображают шкалы к странице width. Если высота изображения превышает высоту страницы, изображение уменьшается снова. Это дополнительное масштабирование гарантирует, что изображение соответствует текущей странице дополнительным однодюймовым интервалом. Эта установка не применяется к отчетам HTML.

  • 'custom' — Эта установка масштабирует изображение осей на основе значений Height и Width свойства.

  • 'none' — Изображение не масштабируется.

Примечание

'auto' и 'custom' опции используют MATLAB print команда, чтобы изменить размер фигуры. Если фигура является слишком крупной, чтобы соответствовать четко на заданном пробеле, print обрезки команды изображение снимка состояния. Чтобы постараться не обрезать, можно установить Scaling к 'none' и используйте генератор отчетов, заданный Snapshot свойство измерить изображение осей. Поскольку этот генератор отчетов уменьшает размер текста с остальной частью изображения, пользователь может должен быть масштабировать изображение, чтобы различить мелкие детали. Смотрите Изменяют размер Изображения Снимка состояния фигуры.

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

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

  • cm 'centimeters'

  • in 'inches'

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

  • pc — цицеро

  • pt 'points'

Пример: '2in'

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

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

  • cm 'centimeters'

  • in 'inches'

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

  • pc — цицеро

  • pt 'points'

Пример: '3in'

Сохраните цвет фона осей в снимке состояния в виде true или false. Если PreserveBackgroundColor true, цвет фона снимка состояния совпадает с цветом фона осей. Если PreserveBackgroundColor false, цвет фона изображения осей является белым.

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Скрипт Open Live Script

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

import mlreportgen.report.*

Создайте отчет PDF и главу.

rpt = Report("Add Axis Figure", "pdf");
chapter = Chapter("Axes");

Создайте данные и набор осей для графика.

ax = axes(Position=[0.1 0.1 0.7 0.7]);
x1 = linspace(0,10,100);
y1 = sin(x1);
plot(ax,x1,y1);

Figure contains an axes object. The axes object contains an object of type line.

Создайте генератор отчетов осей при помощи mlreportgen.report.Axes.

axesRpt = Axes(ax);

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

axesRpt.Scaling = "custom";
axesRpt.Height = "4in";
axesRpt.Width = "4in";

Добавьте генератор отчетов осей в главу и главу к отчету.

append(chapter,axesRpt);
add(rpt,chapter);

Figure contains an axes object. The axes object contains an object of type line.

Закройте отчет и просмотрите его.

close(rpt);
rptview(rpt);

Смотрите также

| |

Введенный в R2021b

Документация MATLAB Report Generator

Поддержка

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