メインコンテンツ

レポート コンテナーの作成

コンテンツを保持するレポート API オブジェクトの作成

すべてのレポート API プログラムでは、レポートのコンテンツを保持するための mlreportgen.report.Report オブジェクトを作成しなければなりません。Report オブジェクトを作成するには、mlreportgen.report.Report コンストラクターを使用します。

引数なしでコンストラクターを使用する場合、コンストラクターは untitled.pdf という名前の PDF ドキュメントを現在のフォルダーに作成します。名前と場所を指定するには、レポートのパス名をコンストラクターの最初の引数として使用します。

type 引数を使用して、生成するレポートのタイプを指定できます。次のタイプを指定できます。

  • "docx"Microsoft® Word ドキュメント。

  • "html" — レポートの HTML ファイル、イメージ、スタイル シート、および JavaScript® ファイルを含む圧縮したファイルとしてパッケージ化した HTML レポート。未圧縮のファイルを含むフォルダーとして HTML レポートを生成するには、PackageType プロパティを "unzipped" または "both" に設定します。

  • "html-file" — レポートのテキスト、スタイル シート、JavaScript、および base64 で符号化されたイメージを含む単一の HTML ファイルで構成される HTML レポート。

  • "pdf" — PDF ファイル。

  • "pdfa" — PDF/A ファイル。 (R2025a 以降)

この Report コンストラクターは、myReport という名前の Word 出力用のドキュメント オブジェクトを作成します。

d = Report("myReport","docx");

templatePath 引数を使用すると、レポートの書式設定のベースとして使用するカスタム テンプレートのパス名を指定できます。レポートの外観と構造を定義するカスタム テンプレートをレポートのベースとして使用する場合は、テンプレートのパスを指定します。テンプレート タイプはドキュメント タイプと一致しなければなりません。たとえば、次のレポート コンストラクターは、テンプレート myWordTemplate.dotx を使用して Word 出力用のレポート オブジェクトを作成します。

d = Report("myReport","docx","myWordTemplate");

コンテンツを保持する DOM ドキュメント オブジェクトの作成

DOM API を単独で使用して (すなわち、レポート API オブジェクトを使用せず) レポートを生成する場合は、レポート コンテンツを保持するための mlreportgen.dom.Document オブジェクトを作成しなければなりません。Document オブジェクトを作成するには、mlreportgen.dom.Document コンストラクターを使用します。

引数なしでコンストラクターを使用する場合、DOM API は Untitled.htmx という名前の HTML ドキュメントを現在のフォルダーに作成します。名前と場所を指定するには、レポートのパス名をコンストラクターの最初の引数として使用します。

type 引数を使用して、生成するレポートのタイプを指定できます。次のタイプを指定できます。

  • "docx" (Microsoft Word の場合)

  • "html" (HTML 出力の場合)

  • "html-file" (単一ファイルの HTML 出力の場合)

  • "html-multipage" (マルチページ HTML 出力の場合) (R2024a 以降)

  • "pdf" (PDF 出力の場合)

  • "pdfa" (PDF/A 出力の場合) (R2025a 以降)

この Document コンストラクターは、myReport という名前の Word 出力用のドキュメント オブジェクトを作成します。

d = Document("myReport","docx");

templatePath 引数を使用すると、レポートの書式設定のベースとして使用するテンプレートのパス名を指定できます。レポートの外観と構造を定義するカスタム テンプレートをレポートのベースとして使用する場合は、テンプレートのパスを指定します。テンプレート タイプはドキュメント タイプと一致しなければなりません。たとえば、次の Document コンストラクターは、テンプレート myWordTemplate.dotx を使用して Word 出力用のドキュメント オブジェクトを作成します。

d = Document("myReport","docx","myWordTemplate");

参考

クラス

関数

トピック