mlreportgen.report.Reporter クラス

名前空間: mlreportgen.report

MATLAB レポーターに対するスーパークラス

このページをすべて展開する

説明

mlreportgen.report.Reporter は、レポートに追加するコンテンツを生成するレポーターオブジェクトのスーパークラスです。レポーターの書式設定はテンプレートに基づきます。

mlreportgen.report.Reporter クラスは handle クラスです。

クラス属性

HandleCompatible true

クラス属性の詳細については、クラスの属性を参照してください。

作成

説明

reporter = mlreportgen.report.Reporter は、空のレポーターを作成します。

report = mlreportgen.report.Reporter(Name=Value) は、名前と値の引数を使用してプロパティを設定します。複数の名前と値の引数を任意の順番で指定できます。

プロパティ

すべて展開する

`TemplateSrc` — このレポーターのテンプレートのソース
文字ベクトル | string スカラー | レポーターまたはレポート | DOM ドキュメントまたはドキュメントパーツ

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

このレポーターのテンプレートを含むファイルのパスを指定する文字ベクトルまたは string スカラー
このレポーターが使用するテンプレートを含む、またはこのレポーターのテンプレートをテンプレートライブラリに含む、レポーターまたはレポート
このレポーターが使用するテンプレートを含む、またはこのレポーターのテンプレートをテンプレートライブラリに含む、ドキュメントオブジェクトモデル (DOM) ドキュメントまたはドキュメントパーツ

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`TemplateName` — このレポーターのテンプレートの名前
文字ベクトル | string スカラー

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`LinkTarget` — このレポーターのハイパーリンクターゲット
`[]` (既定値) | 文字ベクトル | string スカラー | `mlreportgen.dom.LinkTarget` オブジェクト

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