最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

mlreportgen.report.Report クラス

パッケージ: mlreportgen.report
スーパークラス:

レポート作成のスーパークラス

説明

mlreportgen.report.Report は、レポーターと MATLAB® と DOM オブジェクトを基にしたレポート用のコンテナーです。このオブジェクトを使用して、テンプレート ライブラリのテンプレートに基づいた HTML、PDF、または Word レポートを生成します。

構築

report = Report() は、既定のレポート タイプ (PDF) と既定の名前 (untitled.pdf) を使用したレポート オブジェクト レポートを返します。

report = Report(path) は、レポートに指定した出力 path を使用します。

report = Report(path,type) は、指定した type のレポートを作成します。

report = Report(path,type,template) は指定したテンプレートを使用します。

report = Report(Name,Value) は、名前と値のペアを使用してプロパティを設定します。複数の名前と値のペアの引数を任意の順番で指定できます。各プロパティ名は一重引用符で囲みます。

入力引数

すべて展開する

OutputPath プロパティを参照してください。

Type プロパティを参照してください。

TemplatePath プロパティを参照してください。

プロパティ

すべて展開する

レポートのドキュメント出力パス。string または文字配列として指定します。パスは、レポートの出力ドキュメントを保存するファイル システムの場所です。パスは、絶対パスまたは現在の MATLAB フォルダーからの相対パスです。たとえば、'C:/myreports/reportA.docx' または 'reportA' です。ファイル名に Type プロパティに関連するファイル拡張子がない場合、適切なファイル拡張子が追加されます。

出力タイプ。次のいずれかの値として指定します。

  • 'HTML' – HTML ファイル、イメージ、スタイル シート、およびレポートの JavaScript® ファイルを含む圧縮したファイルとしてパッケージ化した HTML レポート。

  • 'HTML-FILE' – テキスト、スタイル シート、JavaScript、および base64 で符号化されたレポートのイメージを含む単一の HTML ファイルとしての HTML レポート

  • 'PDF' – PDF ファイル

  • 'DOCX'Microsoft® Word ドキュメント

TemplatePath プロパティを使用してテンプレートを指定する場合、Type の値はテンプレート タイプと一致しなければなりません。

このレポートのページ レイアウト オプション。レポートのレイアウト オブジェクトとして指定します。mlreportgen.report.ReportLayout を参照してください。

ロケールまたは言語。このレポートが生成されるロケールの 2 文字の ISO_639-1 言語コードとして指定します。既定の [] は、システム ロケールの言語を指定します。たとえば、英語のシステムでは英語です。レポート API は、言語コードを使用して、章タイトルの接頭辞を指定したロケールの言語に変換します。変換は次のロケールに対して実施されています。afcacsdadeeleneseteufifrhuiditjakonlnnnoplptroruskslsrsvtrukxh、および zh。サポートされていないロケールを指定すると、英語バージョンが使用されます。https://en.wikipedia.org/wiki/List_of_ISO_639-1_codesを参照してください。

レポートの書式設定に使用するテンプレートの場所。string または文字配列として指定します。このプロパティを使用して、このレポートのカスタム テン プレートを指定します。

この読み取り専用プロパティは、レポートのコンテンツの生成に使用する mlreportgen.dom.Document です。

読み取り専用プロパティは、現在のレポート セクションの階層レベルなど、レポートを生成するための情報を含む containers.Map オブジェクトです。

デバッグ モード。logical として指定します。Debugtrue に設定する場合、レポートの一時ファイルはレポート フォルダーのサブフォルダーに保存されます。デバッグ モードでは、これらのファイルは、レポートを閉じたときに削除されません。

メソッド

addレポートにコンテンツを追加する
close Close and generate report
createTemplateCreate report template
customizeReportCreate class derived from Report class
fillFill report template holes
generateFileName Generate temporary report file name
getClassFolder Report class definition file location
getContext Get report context value
getReportLayoutCurrent page layout of report
getTempPath Path of report temporary directory
isdocx Check if Word report
ishtml Check if multifile HTML report
ishtmlfile Check if single-file HTML report
ispdf Check if PDF report
open Opens the report
rptview Open generated report file in viewer
setContext Set report context value

コピーのセマンティクス

ハンドル。ハンドル クラスがコピー操作にどのように影響するかについては、オブジェクトのコピー (MATLAB)を参照してください。

R2017b で導入