Exponenta Banner
exponenta event banner

mlreportgen.report.Класс уравнений

Пакет: 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 для уравнения, заданная как строковый скалярный или символьный вектор. Можно использовать любую разметку LaTeX, которая поддерживается Interpreter свойства текстового объекта MATLAB ®. См. раздел Свойства текста .

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

Цвет шрифта, определяемый как вектор символов или скаляр строки, содержащий имя цвета или эквивалентную шестнадцатеричную спецификацию или спецификацию триплета 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 свойства в свойствах текста.

Если 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 ® Editor. Если значение равно false, репортер использует окно фигуры для визуализации уравнения.

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

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

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

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

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

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

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

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

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

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

Указанный шаблон должен быть того же типа, что и отчет, к которому добавлен этот репортер. Например, для отчета Microsoft ® Word :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

Поддержка