mlreportgen.report.Equation class

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

Репортер уравнений

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

Описание

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

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

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

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

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

HandleCompatible
true

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

Создание

Описание

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

пример

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

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

Свойства

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

Разметка LaTeX для уравнения, заданная как строковый скаляр или вектор символов. Вы можете использовать любую разметку LaTeX, которая поддерживается Interpreter свойство MATLAB® текстовый объект. См. раздел Text Свойств.

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

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

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

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

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

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

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

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

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

Примечание

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

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

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

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

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

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

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

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

Прямая визуализация не поддерживает:

  • Форматы изображений, отличные от PNG.

  • Фоновые цвета для уравнений.

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

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

% 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-pt шрифтом.

% 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

Поддержка

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