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

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

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

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

type 引数を使用して、生成するレポートのタイプを指定できます。タイプは、'html'、'docx' (Microsoft^® Word 用)、'pdf' (PDF 出力用) または 'html-file' (単一のファイルの HTML 出力用) として指定できます。

この 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 引数を使用して、生成するレポートのタイプを指定できます。タイプは、'html'、'docx' (Microsoft Word 用)、'pdf' (PDF 出力用) または 'html-file' (単一のファイルの HTML 出力用) として指定できます。

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

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

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

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