slreportgen.report.Report クラス

パッケージ: slreportgen.report

レポート コンテナー

説明

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

メモ

Simulink レポートを作成するには、mlreportgen.report.Report の代わりにこのタイプのオブジェクトを使用します。このレポートは、Simulink レポーターを使用してコンテンツを生成します。また、MATLAB^® レポーターと DOM オブジェクトを使用して Simulink レポートのコンテンツを生成することもできます。

slreportgen.report.Report クラスは handle クラスです。

作成

説明

report = slreportgen.report.Report() は、既定のレポート タイプ (PDF) と既定のファイル名 (untitled.pdf) をもつレポート オブジェクト report を返します。

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

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

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

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

入力引数

path — レポートの出力パス

untitled.pdf (既定値) | 文字列 | 文字配列

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

type — レポートの出力タイプ

'pdf' (既定値) | 'html' | 'html-file' | 'docx'

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

template — レポートのテンプレート

文字列 | 文字配列

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

プロパティ

OutputPath — レポート ドキュメントの出力パス

文字列 | 文字配列

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

メモ

MATLAB Drive™ などのクラウド ドライブで PDF レポートを生成すると、レポート生成ソフトウェアとクラウド ドライブ同期ソフトウェアの間でファイルが競合し、エラーの原因となる場合があります。このエラーを回避するには、クラウドと同期しないローカル ドライブでレポートを生成します。ローカル ドライブにレポートを生成し、そのレポートをクラウド ドライブにコピーするスクリプトを作成することを検討してください。

Type — 出力タイプ

文字列 | 文字ベクトル | 'docx' | 'pdf'

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

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

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

• 'PDF' — PDF ファイル

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

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

Layout — ページ レイアウトのオプション

mlreportgen.report.ReportLayout オブジェクト

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

Locale — ロケールまたは言語

[] (既定値) | 文字列 | 文字配列

ロケールまたは言語。このレポートが生成されるロケールの 2 文字の ISO_639-1 言語コードとして指定します。既定の [] は、システム ロケールの言語、たとえば英語システムでは英語を指定します。レポート API は言語コードを使用して、章タイトルの接頭辞を指定ロケールの言語に変換します。af、ca、cs、da、de、el、en、es、et、eu、fi、fr、hu、id、it、ja、ko、nl、nn、no、pl、pt、ro、ru、sk、sl、sr、sv、tr、uk、xh、および zh の各ロケールに対する変換が提供されています。サポートされていないロケールを指定した場合は、英語バージョンが使用されます。ISO 639-1 コードを参照してください。

TemplatePath — テンプレートの場所

文字列 | 文字配列

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

Document — 基となる DOM ドキュメント オブジェクト

DOM ドキュメント オブジェクト

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

Context — キーと値のコンテナー

マップ オブジェクト

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

Debug — デバッグ モード

false (既定値) | true

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

CompileModelBeforeReporting — Simulink モデルのコンパイル

true (既定値) | false

レポートする前に Simulink モデルをコンパイルするかどうか。logical として指定します。このプロパティが true で、モデルがまだコンパイルされていない場合、このモデルについてレポートするレポーターをこのレポートに追加すると、モデルがコンパイルされます。モデルをコンパイルできない場合、レポート生成は終了します。このプロパティが false の場合、モデルをコンパイルせずにレポート生成が続行します。

PackageType — 生成されたファイルのパッケージ化

'zipped' | 'unzipped' | 'both' | 'single-file'

生成されたファイルに使用されるパッケージ。次の表のいずれかの値として指定します。

値	サポートされるレポート タイプ	説明
'zipped'	'docx' または 'html'	OutputPath プロパティで指定された場所にレポートを zip ファイルとして生成します。zip ファイルには、ドキュメントのタイプに一致する拡張子 (Word 出力の場合は docx、HTML 出力の場合は htmtx) が付けられます。たとえば、ドキュメント タイプが docx で OutputPath が s:\docs\MyDoc の場合、出力は s:\docs\MyDoc.docx という名前の zip ファイルにパッケージ化されます。
'unzipped'	'docx' または 'html'	OutputPath プロパティのファイル名をもつフォルダーに、レポートを個別の複数ファイルとして生成します。たとえば、OutputPath が s:\docs\MyDoc の場合、出力フォルダーは s:\docs\MyDoc になります。
'both'	'docx' または 'html'	圧縮された出力および圧縮しない出力を生成します。
'single-file'	'pdf' または 'html-file'	レポートを単一ファイルとして生成します。

Type プロパティが 'html' の場合、解凍せずに開くことができる HTML レポートを生成するには、PackageType を 'unzipped' または 'both' に設定します。生成されたファイルを含むフォルダーで、root.html ファイルを開きます。

メソッド

パブリック メソッド

このクラスは MATLAB バージョンの mlreportgen.report.Report と同じメソッドを使用します。クラス名で mlreportgen を使用する代わりに、slreportgen を使用します。

open	レポートを開く
append	レポートへのコンテンツの追加
add	(非推奨) レポートへのコンテンツの追加
close	レポートを閉じて生成する
rptview	生成されたレポート ファイルをビューアーで開く
mlreportgen.report.Report.createTemplate	レポート テンプレートの作成
mlreportgen.report.Report.customizeReport	Create class derived from Report class
mlreportgen.report.Report.getClassFolder	レポート クラス定義ファイルの場所
getTempPath	レポートの一時ディレクトリのパス
generateFileName	Generate temporary report file name
getReportLayout	Current page layout of report
fill	レポート テンプレートのホールを埋める
getContext	Get report context value
setContext	Set report context value
ispdf	PDF レポートかどうかのチェック
isdocx	Check if Word report
ishtml	Check if multifile HTML report
ishtmlfile	Check if single-file HTML report

バージョン履歴

R2017b で導入

R2020b: add メソッドは非推奨

R2020b 以降では、以下のレポート API クラスのオブジェクトにコンテンツを追加する場合、add メソッドの代わりに append メソッドを使用してください。

• slreportgen.report.Report

• mlreportgen.report.Chapter

• mlreportgen.report.Section

mlreportgen.dom.Paragraph オブジェクトなどの DOM API オブジェクトにコンテンツを追加するには、引き続き DOM オブジェクトの append メソッドを使用します。append を使用してレポート API オブジェクトにコンテンツを追加する利点は、DOM API オブジェクトへのコンテンツ追加に使用するものと同じメソッド名が使用されることです。

Report、Chapter、または Section クラスの add メソッドが削除される予定はありません。add メソッドを使用するレポート API プログラムは引き続き動作します。

既存のコードを更新するには、表の例に示すように、メソッド名 add を append に置き換えます。

非推奨	推奨
import mlreportgen.report.* import mlreportgen.dom.* rpt = slreportgen.report.Report("myrpt","pdf"); ch = Chapter("My Chapter"); sect = Section("My Section"); para = Paragraph("My Content "); append(para,"more Content"); add(sect,para); add(ch,sect); add(rpt,ch); close(rpt); rptview(rpt);	import mlreportgen.report.* import mlreportgen.dom.* rpt = slreportgen.report.Report("myrpt","pdf"); ch = Chapter("My Chapter"); sect = Section("My Section"); para = Paragraph("My Content "); append(para,"more Content"); append(sect,para); append(ch,sect); append(rpt,ch); close(rpt); rptview(rpt);

参考

slreportgen.finder.DiagramFinder | slreportgen.finder.DiagramElementFinder | slreportgen.finder.SystemDiagramFinder | slreportgen.finder.ChartDiagramFinder | slreportgen.finder.StateflowDiagramElementFinder | slreportgen.finder.StateFinder | slreportgen.report.StateflowObjectProperties | slreportgen.report.SimulinkObjectProperties | slreportgen.report.Diagram | slreportgen.finder.BlockFinder | slreportgen.finder.AnnotationFinder

トピック

• Simulink および Stateflow の要素用の Report Generator の作成
• レポーターとは