mlreportgen.report.Equation class

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

Генератор отчетов уравнения

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

Описание

Создайте генератор отчетов уравнения, который добавляет уравнение в отчет.

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

Изображение снимка состояния уравнения хранится во временной папке отчета. Когда отчет закрывается, изображение уравнения копируется в отчет и, затем, изображение удалено из временной папки. Чтобы препятствовать тому, чтобы файлы изображений уравнения были удалены, используйте Debug свойство отчета. Смотрите mlreportgen.report.Report.

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

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

HandleCompatible
true

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

Создание

Описание

equation = mlreportgen.report.Equation() создает пустой объект генератора отчетов уравнения. Используйте свойства объектов, чтобы задать уравнение и его форматирование.

пример

equation = mlreportgen.report.Equation(markup) форматирует уравнение, которое задано разметкой LATEX для уравнения. Смотрите свойство Content.

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

Свойства

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

ПРОПИТАЙТЕ ЛАТЕКСОМ разметку для уравнения в виде строкового скаляра или вектора символов. Можно использовать любую разметку LATEX, которая поддерживается Interpreter свойство MATLAB® текстовый объект. Смотрите текстовые Свойства.

Атрибуты:

GetAccess
public
SetAccess
public

Размер шрифта для отформатированного уравнения в виде пустого, или как положительное целое число. Если FontSize свойство пусто, значения по умолчанию размера шрифта к 10.

Атрибуты:

GetAccess
public
SetAccess
public

Цвет шрифта в виде вектора символов или строкового скаляра, который содержит название цвета или эквивалентную спецификацию шестнадцатеричного или триплета RGB.

Спецификация цветов зависит от значения UseDirectRenderer свойство. Если значением свойства является true, задайте допустимое название цвета CSS, триплет RGB или шестнадцатеричное значение. См. https://www.w3.org/TR/2018/REC-css-color-3-20180619/. Если значением свойства является false, задайте цвет при помощи имени, краткого названия, триплета RGB или шестнадцатеричного значения как описано в Свойстве цвета Text Properties. Эта таблица показывает, как задать красный цвет для различных значений UseDirectRenderer свойство.

UseDirectRenderer ЗначениеИмяТриплет RGBШестнадцатеричный код
true"red""rgb(255,0,0)""#FF0000"
false"red" или "r""[1,0,0]""#FF0000"

Атрибуты:

GetAccess
public
SetAccess
public

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

Если UseDirectRenderer свойством является true, BackgroundColor свойство проигнорировано.

Атрибуты:

GetAccess
public
SetAccess
public

Отобразите уравнение в соответствии с текстом в виде true или false.

Если DisplayInline свойство установлено в false, генератор отчетов берет изображение уравнения, переносит изображение в абзац и добавляет абзац в отчет. В отчете уравнение находится на линии отдельно. Смотрите Добавляет уравнение к Главе. Используйте эту опцию, чтобы заполнить, затыкают дыры в шаблоне.

Если DisplayInline свойство установлено в true, изображение уравнения не перенесено в абзац. Чтобы добавить уравнение в отчет, получите изображение уравнения при помощи getImpl метод и затем добавляет изображение в абзац. В сгенерированном отчете уравнение соответствует тексту абзаца. Смотрите уравнение Отображения в соответствии с текстом Абзаца. Используйте эту опцию, чтобы заполнить встроенные отверстия в шаблоне.

Примечание

По умолчанию нижняя часть встроенного изображения выравнивается с базисной линией сопроводительного текста. Если встроенное изображение уравнения более высоко, чем сопроводительный текст, можно использовать mlreportgen.dom.VerticalAlign формат, чтобы выровнять изображение относительно текстовой базисной линии так, чтобы базисная линия уравнения совпадала с текстовой базисной линией. Необходимо экспериментировать, чтобы определить необходимое количество вертикальной корректировки.

Атрибуты:

GetAccess
public
SetAccess
public

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

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

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

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

    Если UseDirectRenderer свойством является true, только формат изображения PNG поддерживается. Если ваше приложение требует другого формата, установите UseDirectRenderer свойство к false.

Атрибуты:

GetAccess
public
SetAccess
public

Использовать ли прямой рендеринг уравнения в виде true или false. Если значением является true, генератор отчетов представляет уравнение непосредственно при помощи рендеринга, используемого Live Editor и Simulink® Редактор. Если значением является false, генератор отчетов использует окно рисунка, чтобы представить уравнение.

Прямой рендеринг оказывает лучшую поддержку для разметки уравнения, чем поддержка, оказанная окном рисунка. С прямым рендерингом, представленным уравнениями, имеют тот же внешний вид как уравнения в аннотациях Simulink и Live Editor.

Прямой рендеринг не поддерживает:

  • Форматы изображения кроме PNG.

  • Цвета фона для уравнений.

  • Краткое название для цвета, такого как "r". Необходимо использовать допустимое название цвета CSS, такое как "red", или эквивалентный триплет RGB или шестнадцатеричный цветовой код. См. https://www.w3.org/wiki/CSS/Properties/color/keywords.

Если ваше приложение требует форматов кроме PNG или различного цвета фона, установите UseDirectRenderer свойство к false.

Атрибуты:

GetAccess
public
SetAccess
public

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

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

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

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

Атрибуты:

GetAccess
public
SetAccess
public

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

Атрибуты:

GetAccess
public
SetAccess
public

Методы

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

Примеры

свернуть все

Создайте отчет, который включает уравнение в главу. По умолчанию генератор отчетов добавляет изображение уравнения на отдельной линии отчета.

% Import the API packages
import mlreportgen.report.*

% Create the report and chapter 
% Add an equation as a separate line in the chapter
rpt = Report('equation','docx');
ch = Chapter('Title','Equation');
add(ch,Equation('\int_{0}^{2} x^2\sin(x) dx'));
add(rpt,ch);

% Close and view the report.
close(rpt);
rptview(rpt);

Создайте отчет, который включает уравнение на желтом фоне в шрифте на 14 ПБ.

% Import the API packages
import mlreportgen.report.*

% Create the report and chapter 
% Create an Equation reporter and set the FontSize and Color properties
rpt = Report('equation','docx');
ch = Chapter('Title','Equation');
eq = Equation;
eq.Content = '\int_{0}^{2} x^2\sin(x) dx';
eq.FontSize = 14; 
eq.Color = 'blue';
eq.BackgroundColor = 'y';
add(ch,eq);
add(rpt,ch);

% Close and view the report
close(rpt);
rptview(rpt);

Создайте уравнение, которое соответствует тексту абзаца путем установки DisplayInline свойство к true. Затем вызовите getImpl метод, чтобы получить снимок изображения уравнения. Добавьте снимок состояния изображения к абзацу.

% Import the API packages
import mlreportgen.report.*
import mlreportgen.dom.*

% Create report
% Add equation in line with text in a paragraph of the report
rpt = Report("equation", "docx");
eq = Equation("\int_{0}^{2} x^2\sin(x) dx");
eq.DisplayInline = true;
img = getImpl(eq, rpt);
img.Style = {VerticalAlign("-5pt")};
p = Paragraph("Here is an inline equation: ");
p.WhiteSpace = 'preserve';
append(p,img);
append(p," More text ");

add(rpt,p);

% Close and view the report
close(rpt);
rptview(rpt);

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

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

Поведение изменяется в R2019b

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

| |

Темы

Введенный в R2017b

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

Поддержка

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