Exponenta Banner

mlreportgen.report.Equation class

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

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

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

Описание

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

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

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

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

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

HandleCompatible
true

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

Создание

Описание

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

пример

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

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

Свойства

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

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

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

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

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

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

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

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

Примечание

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

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

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

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

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

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

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

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

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

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

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

Цель гиперссылки для этого генератора отчетов, заданного как строка или символьный массив, который задает ID цели ссылки или 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 ПБ.

% 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 = 'b';
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
Поддержка