mlreportgen.report.Equation クラス

名前空間: 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(PropertyName=Value) は、名前と値の引数を使用してプロパティを設定します。複数の名前と値の引数を任意の順番で指定できます。

プロパティ

すべて展開する

数式の LaTeX マークアップ。文字ベクトルまたは string スカラーとして指定します。MATLAB® text オブジェクトの Interpreter プロパティでサポートされている任意の LaTeX マークアップを使用できます。Text のプロパティ を参照してください。

属性:

GetAccess
public
SetAccess
public

データ型: char | string

書式設定される数式のフォント サイズ。空として指定するか、正の整数として指定します。FontSize プロパティが空の場合、フォント サイズは既定の 10 になります。

属性:

GetAccess
public
SetAccess
public

データ型: int32

フォント カラー。CSS の色名、16 進数の RGB 値、または 10 進数の RGB 値を含む文字ベクトルまたは string スカラーとして指定します。

形式値
CSS の色名CSS の色名を指定します。CSS の色名のリストについては、https://www.w3.org/wiki/CSS/Properties/color/keywords を参照してください。
16 進数の RGB 値"#RRGGBB" の形式を使用します。最初の文字として # を使用し、赤、緑、および青の値に 2 桁の 16 進数を使用します。大文字と小文字のいずれも使用できます。
10 進数の RGB カラー値"rgb(r,g,b)" 形式を使用します。r、g、b は、それぞれ赤、緑、青の値を指定する正の整数で、コンマで区切ります。各値の範囲は 0 と 255 の範囲内でなければなりません。

色の指定は、UseDirectRenderer プロパティの値によって異なります。プロパティ値が true の場合は、有効な CSS の色名、RGB 3 成分、または 16 進数値を指定します。https://www.w3.org/TR/2018/REC-css-color-3-20180619/を参照してください。プロパティ値が false の場合は、Text のプロパティ の Color プロパティで説明されているように、名前、省略名、RGB 3 成分、または 16 進数値を使用して色を指定します。次の表は、UseDirectRenderer プロパティのさまざまな値で赤色を指定する方法を示しています。

UseDirectRenderer 値名前RGB 3 成分16 進数コード
true"red""rgb(255,0,0)""#FF0000"
false"red" または "r""[1,0,0]""#FF0000"

属性:

GetAccess
public
SetAccess
public

データ型: char | string

書式設定される数式の背景色の名前。文字ベクトルまたは string スカラーとして指定します。Color が空の場合、背景色は既定の白になります。色の完全名または省略名を使用できます。有効な色名のリストについては、Text のプロパティ の Color プロパティを参照してください。

UseDirectRenderer プロパティが true の場合、BackgroundColor プロパティは無視されます。

属性:

GetAccess
public
SetAccess
public

データ型: char | string

数式をテキストとインラインで表示する。logical の 1 (true) または 0 (false) として指定します。指定内容は以下のとおりです。

  • 1 (true) — 数式イメージは段落内で折り返されません。数式をレポートに追加するには、getImpl メソッドを使用して数式イメージを取得し、そのイメージを段落に追加します。生成されたレポートでは、数式は段落のテキストとインラインで表示されます。数式を段落のテキストとインラインで表示を参照してください。このオプションを使用して、テンプレートのインライン ホールを埋めます。

    メモ

    既定では、インライン イメージの下部が周囲のテキストのベース ラインと揃えられます。インライン数式イメージの高さが周囲のテキストよりも高い場合、mlreportgen.dom.VerticalAlign 書式を使用し、テキストのベース ラインを基準にイメージを整列することで、数式のベース ラインとテキストのベース ラインを一致させることができます。垂直方向の必要な調整量を決定するには、実験しなければなりません。

  • 0 (false) — レポーターは数式のイメージを取得し、そのイメージを段落で囲み、その段落をレポートに追加します。レポートでは、数式は単独の行になります。章への数式の追加を参照してください。このオプションを使用して、テンプレートのブロック ホールを埋めます。

属性:

GetAccess
public
SetAccess
public

データ型: logical

スナップショットのイメージ形式。文字ベクトルまたは string スカラーとして指定します。以下はサポートされる形式です。

  • "png" — PNG イメージ。

  • "emf" — 拡張メタファイル。この形式は、Windows® プラットフォームの DOCX 出力でのみサポートされます。

  • "svg" — Scalable Vector Graphics (SVG)。

    メモ

    UseDirectRenderer プロパティが true の場合、PNG イメージ形式のみがサポートされます。アプリケーションで別の形式が必要な場合は、UseDirectRenderer プロパティを false に設定します。

属性:

GetAccess
public
SetAccess
public

データ型: char | string

数式のダイレクト レンダリングを使用するかどうか。logical の 1 (true) または 0 (false) として指定します。指定内容は以下のとおりです。

  • 1 (true) — レポーターは、ライブ エディターおよび Simulink® エディターで使用されるレンダリングを使用して、数式を直接レンダリングします。

  • 0 (false) — レポーターは Figure ウィンドウを使用して数式をレンダリングします。

ダイレクト レンダリングでは、Figure ウィンドウによって提供されるサポートよりも、数式マークアップのサポートが強化されています。ダイレクト レンダリングでレンダリングされた数式は、ライブ エディターおよび Simulink 注釈内の数式と同じ外観になります。

MATLAB Online では、数式のダイレクト レンダリングは利用できません。

ダイレクト レンダリングは次をサポートしていません。

  • PNG 以外のイメージ形式。

  • 数式の背景色。

  • 色の省略名 ("r" など)。"red" などの有効な CSS の色名を使用するか、等価の RGB 3 成分または 16 進数カラー コードを使用しなければなりません。https://www.w3.org/wiki/CSS/Properties/color/keywordsを参照してください。

アプリケーションで PNG 以外の形式または異なる背景色が必要な場合は、UseDirectRenderer プロパティを false に設定します。

属性:

GetAccess
public
SetAccess
public

データ型: logical

このレポーターのテンプレートのソース。次のいずれかの方法で指定します。

  • このレポーターのテンプレートを含むファイルのパスを指定する文字ベクトルまたは string スカラー

  • このレポーターが使用するテンプレートを含む、またはこのレポーターのテンプレートをテンプレート ライブラリに含む、レポーターまたはレポート

  • このレポーターが使用するテンプレートを含む、またはこのレポーターのテンプレートをテンプレート ライブラリに含む、ドキュメント オブジェクト モデル (DOM) ドキュメントまたはドキュメント パーツ

指定するテンプレートは、このレポーターを追加するレポートと同じタイプでなければなりません。たとえば、Microsoft® Word レポートでは、TemplateSrc は Word レポーター テンプレートでなければなりません。TemplateSrc プロパティが空の場合、このレポーターはレポートの出力タイプに既定のレポーター テンプレートを使用します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true
Dependent
true

このレポーターのテンプレートの名前。文字ベクトルまたは string スカラーとして指定します。このレポーターのテンプレートは、このレポーターの TemplateSrc プロパティで指定されたテンプレートのテンプレート ライブラリになければなりません。

属性:

GetAccess
public
SetAccess
public

データ型: char | string

このレポーターのハイパーリンク ターゲット。リンク ターゲット ID を指定する文字ベクトルもしくは string スカラー、または mlreportgen.dom.LinkTarget オブジェクトとして指定します。文字ベクトルまたは string スカラー値は LinkTarget オブジェクトに変換されます。リンク ターゲットは、出力レポートでこのレポーターのコンテンツの直前にあります。

属性:

GetAccess
public
SetAccess
public

メソッド

すべて展開する

例

すべて折りたたむ

章に数式が含まれるレポートを作成します。既定では、レポーターはレポートの別の行に数式のイメージを追加します。

% Import the API namespaces
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 namespaces
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 namespaces
import mlreportgen.report.*
import mlreportgen.dom.*

% Create report
% Add equation inline 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);

制限

  • MATLAB Online では、数式のダイレクト レンダリングは利用できません。

バージョン履歴

R2017b で導入

すべて展開する

参考

| |

トピック