このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。
mlreportgen.report.Report クラス
名前空間: mlreportgen.report
レポート コンテナー
説明
mlreportgen.report.Report
クラスのオブジェクトは、レポーターと MATLAB® と DOM オブジェクトを基にしたレポート用のコンテナーです。mlreportgen.report.Report
オブジェクトを使用して、テンプレート ライブラリのテンプレートに基づいた HTML、PDF、または Word レポートを生成します。
mlreportgen.report.Report
クラスは handle
クラスです。
作成
説明
は、既定のプロパティ値でレポート コンテナー オブジェクトを返します。report
= mlreportgen.report.Report
は、OutputPath プロパティを report
= mlreportgen.report.Report(path
)path
に設定します。
は、さらに TemplatePath プロパティを report
= mlreportgen.report.Report(path
,type
,template
)template
に設定します。
は、名前と値のペアを使用してプロパティを設定します。複数の名前と値のペアの引数を任意の順番で指定できます。report
= mlreportgen.report.Report(Name=Value
)
プロパティ
OutputPath
— 生成されたレポート ファイルのパス
文字ベクトル | string スカラー
生成されたレポート ファイルのパス。文字ベクトルまたは string スカラーとして指定します。パスは、レポートの出力ドキュメントを保存するファイル システムの場所です。パスは、'C:/myreports/reportA.docx'
のように、絶対パスで指定できます。また、'reportA'
のように、現在の MATLAB フォルダーからの相対パスで指定することもできます。ファイル名に Type
プロパティと一致するファイル拡張子がない場合、適切なファイル拡張子が追加されます。
メモ
MATLAB Drive™ などのクラウド ドライブで PDF レポートを生成すると、レポート生成ソフトウェアとクラウド ドライブ同期ソフトウェアとの間でファイルの競合が発生し、エラーとなる可能性があります。このエラーを回避するには、クラウドと同期しないローカル ドライブでレポートを生成します。ローカル ドライブにレポートを生成し、そのレポートをクラウド ドライブにコピーするスクリプトを作成することを検討してください。
PackageType
— 生成されるファイルのパッケージ化
"zipped"
(既定値) | "unzipped"
| "both"
| "single-file"
生成されたファイルに使用するパッケージ化。表中のいずれか 1 つを値として指定します。
値 | サポートされているレポート タイプ | 説明 |
---|---|---|
|
|
|
"unzipped" |
|
|
"both" |
| 圧縮した出力と未圧縮の出力を生成します。 |
"single-file" |
| レポートを単一のファイルとして生成します。 |
ヒント
Type
プロパティが "html"
または "html-multipage"
の場合、解凍せずに開くことができる HTML レポートを生成するには、PackageType
を "unzipped"
または "both"
に設定します。生成されたファイルがあるフォルダーで root.html
ファイルを開きます。
属性:
NonCopyable | true |
データ型: char
| string
Type
— 出力タイプ
'pdf'
(既定値) | 'html'
| 'html-file'
| 'docx'
出力タイプ。以下のいずれか 1 つを値として指定します。
'pdf'
– PDF ファイル。'html'
– レポートの HTML ファイル、イメージ、スタイル シート、および JavaScript® ファイルを含む圧縮したファイルとしてパッケージ化した HTML レポート。未圧縮のファイルを含むフォルダーとして HTML レポートを生成するには、PackageType
プロパティを'unzipped'
または'both'
に設定します。'html-file'
– レポートのテキスト、スタイル シート、JavaScript、および base64 で符号化されたイメージを含む単一の HTML ファイルで構成される HTML レポート。'docx'
– Microsoft® Word ドキュメント。
TemplatePath
プロパティを使用してテンプレートを指定する場合、Type
の値はテンプレート タイプと一致しなければなりません。
Layout
— ページ レイアウトのオプション
mlreportgen.report.ReportLayout
オブジェクト
このレポートのページ レイアウトのオプション。mlreportgen.report.ReportLayout
オブジェクトとして指定します。Layout
プロパティの初期値は、既定の値をもつ mlreportgen.report.ReportLayout
オブジェクトです。プロパティ値を変更してページ レイアウトをカスタマイズします。例については、横向きのレポートの作成を参照してください。
mlreportgen.report.TitlePage
クラス、mlreportgen.report.TableOfContents
クラス、mlreportgen.report.Chapter
クラスのオブジェクトの Layout
プロパティで指定するレイアウト オプションは、mlreportgen.report.Report
オブジェクトの Layout
プロパティで指定されたページ レイアウト プロパティをオーバーライドできます。
メモ
Layout
プロパティは、PDF レポートおよび Word レポートにのみ適用されます。
Locale
— ロケールまたは言語
[]
(既定値) | 文字ベクトル | string スカラー
ロケールまたは言語。このレポートが生成されるロケールの 2 文字の ISO_639-1 言語コードで構成される文字ベクトルまたは string スカラーとして指定します。既定値の []
は、システム ロケールの言語を指定します。たとえば、英語のシステムでは英語です。レポート 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'
。サポートされていないロケールを指定すると、英語バージョンが使用されます。https://en.wikipedia.org/wiki/List_of_ISO_639-1_codesを参照してください。
例については、章タイトルの接頭辞の変換を参照してください。
TemplatePath
— テンプレートの位置
文字ベクトル | string スカラー
このレポートを書式設定するのに使用するテンプレートの場所。文字ベクトルまたは string スカラーとして指定します。このプロパティを使用して、レポートのカスタム テンプレートを指定します。
Document
— 元となる DOM ドキュメント オブジェクト
mlreportgen.dom.Document
レポートのコンテンツを生成するのに使用する、基となる DOM ドキュメント オブジェクト。mlreportgen.dom.Document
オブジェクトとして指定します。このプロパティは読み取り専用です。
Context
— レポート コンテキスト
containers.Map
オブジェクト
レポート コンテキスト。現在のレポート セクションの階層レベルなど、レポート生成のための情報を含む、containers.Map
オブジェクトとして指定します。このプロパティは読み取り専用です。
Debug
— デバッグ モード
false
または 0
(既定値) | true
または 1
デバッグ モード。数値または logical の 1
(true
) または 0
(false
) として指定します。Debug
を true
または 1
に設定する場合、レポートの一時ファイルはレポート フォルダーのサブフォルダーに保存されます。レポートを閉じても削除されることはありません。
メソッド
パブリック メソッド
open | レポートを開く |
append | レポートへのコンテンツの追加 |
add | (非推奨) レポートへのコンテンツの追加 |
close | レポートを閉じて生成する |
rptview | 生成されたレポート ファイルをビューアーで開く |
mlreportgen.report.Report.createTemplate | レポート テンプレートの作成 |
mlreportgen.report.Report.customizeReport | レポート クラスから派生させたクラスの作成 |
mlreportgen.report.Report.getClassFolder | レポート クラス定義ファイルの場所 |
getTempPath | レポートの一時ディレクトリのパス |
generateFileName | 一時レポート ファイル名の生成 |
getReportLayout | Current page layout of report |
fill | レポート テンプレートのホールを埋める |
getContext | レポート コンテキストの値の取得 |
setContext | Set report context value |
ispdf | PDF レポートかどうかのチェック |
isdocx | Word レポートかどうかのチェック |
ishtml | Check if multifile HTML report |
ishtmlfile | Check if single-file HTML report |
例
レポートの作成
レポート API を使用してレポートを作成します。
完全修飾クラス名を使用せずに済むよう、DOM およびレポートの API 名前空間をインポートします。
import mlreportgen.report.* import mlreportgen.dom.*
レポート コンテナーを作成します。
rpt = Report('My Report','pdf');
レポートにタイトル ページ、目次、および章を追加します。この章には 2 つの節があり、それぞれの節はイメージを含みます。
append(rpt,TitlePage(Title='My Report')); append(rpt,TableOfContents); ch = Chapter('Images'); append(ch,Section(Title='Boeing 747',... Content=Image(which('b747.jpg')))); append(ch,Section(Title='Peppers',... Content=Image(which('peppers.png')))); append(rpt,ch); close(rpt); rptview(rpt);
横向きのレポートの作成
レポート API を使用して、横向きのレポートを作成します。
長い完全修飾クラス名を使用せずに済むよう、レポート API 名前空間をインポートします。
import mlreportgen.report.*
レポート コンテナーを作成する。Layout
プロパティに割り当てられている mlreportgen.report.ReportLayout
オブジェクトの Landscape
プロパティを true
に設定します。
rpt = Report('myreport','pdf'); rpt.Layout.Landscape = true;
レポートにコンテンツを追加します。レポートを生成して表示します。
append(rpt,TitlePage(Title='My Landscape Report')); append(rpt,TableOfContents); append(rpt,Chapter(Title='Tests')); append(rpt,Chapter(Title='Unit Tests')); close(rpt); rptview(rpt);
章タイトルの接頭辞の変換
英語のシステムで Locale
プロパティを設定して、章タイトルの接頭辞を日本語に変換します。
import mlreportgen.report.* rpt = Report('Japanese Report'); rpt.Locale = 'ja'; house = char(23478); % Kanji character for house append(rpt, Chapter(house)); close(rpt); rptview(rpt);
バージョン履歴
R2017b で導入R2020b: add
メソッドは非推奨
R2020b 以降では、以下のレポート API クラスのオブジェクトにコンテンツを追加する場合、add
メソッドの代わりに append
メソッドを使用してください。
mlreportgen.report.Report
mlreportgen.report.Chapter
mlreportgen.report.Section
mlreportgen.dom.Paragraph
オブジェクトなどの DOM API オブジェクトにコンテンツを追加するには、引き続き DOM オブジェクトの append
メソッドを使用してください。レポート API オブジェクトへのコンテンツの追加に append
を使用することの利点は、DOM API オブジェクトへのコンテンツの追加に使用するのと同じメソッド名を使用できることです。
Report
、Chapter
、または Section
クラスの add
メソッドが削除される予定はありません。add
メソッドを使用するレポート API プログラムは引き続き動作します。
既存のコードを更新するには、表の例に示すように、メソッド名を add
から append
に置き換えます。
非推奨 | 推奨 |
---|---|
import mlreportgen.report.* import mlreportgen.dom.* rpt = Report("My Report","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 = Report("My Report","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); |
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)