レポートの印刷とエクスポート

PageDocumentクラス

「レポートの実行」で説明したように、PageReportインスタンスのrunメソッドを呼び出すと、PageDocumentクラスのインスタンスで実行されるPromiseオブジェクトが返されます。PageDocumentクラスを使用して、レポートの印刷やエクスポートできます。

レポートの印刷

レポートを印刷するには、レポートをHTML形式にエクスポートし、結果をブラウザの組み込みの印刷ダイアログで開きます。このプロセスは、PageDocumentクラスのprintメソッドによって行われます。printメソッドは、次の3つのオプション引数を提供します。

• renderOptions ：描画オプションを指定します。印刷の場合はundefinedを設定します。

• onProgress ：レポートの各ページがHTMLに描画された後に呼び出されるコールバック関数です。この関数は描画されたページ数に対する進行状況を数値型の引数で受け取ります。

• checkCancel ：レポートの各ページが描画された後に呼び出されるコールバック関数です。レポートの印刷をキャンセルするかどうかを示すBool値を返します。

onProgressとcheckCancelの引数を使用して、印刷ジョブの進行状況を表示し、ユーザーが［キャンセル］ボタンをクリックしたときにレポートの印刷をキャンセルできるようすることができます。次のコードは、レポートを出力し、進行状況に関する情報をコンソールに送信する方法のサンプルコードです。

import {Core} from "@mescius/activereportsjs";

const report = new Core.PageReport();
await report.load(`assets/Products.rdlx-json`);
const document = await report.run();
document.print(undefined, x=>console.log(`${x} pages ready`), ()=>{
    return false;
});

レポートのエクスポート

ActiveReportsJS APIを使用すると、PdfExport、HtmlExport、TabularDataExportオブジェクトによってレポート出力をPDF、HTML、CSVにエクスポートすることができます。

  import {
    PdfExport,
    HtmlExport,
    TabularDataExport,
  } from "@mescius/activereportsjs";

各エクスポートオブジェクトは、次の4つの引数を持つexportDocumentメソッドを提供します。

• source ：PageDocumentクラスのインスタンスです。

• settings ：エクスポートされたドキュメントの設定です。この引数は、エクスポートタイプ毎に異なります。

  • PDFExport.exportDocumentはPdfSettingsオブジェクトを受け取ります。

  • HtmlExport.exportDocumentはHtmlSettingsオブジェクトを受け取ります。

  • TabularDataExport.exportDocumentはTabularDataSettingsオブジェクトを受け取ります。

• onProgress ：レポートの各ページがエクスポートされた後に呼び出されるコールバック関数です。この関数はエクスポートされたページ数に対す進行状況を数値型の引数で受け取ります。

• checkCancel ：レポートの各ページが描画された後に呼び出されるコールバック関数です。エクスポートをキャンセルするかどうかを示すBool値を返します。

exportDocumentメソッドは各エクスポートタイプ毎に、固有のPromiseオブジェクトを返却します。

• PDFExport.exportDocumentではPdfExportResultオブジェクトでエクスポート結果を返却します。PdfExportResultオブジェクトを使用すると、downloadメソッドを使用してエクスポートの結果をダウンロードしたり、Blob型のdataプロパティを使用して結果を保存したりできます.

• HtmlExport.exportDocumentではHtmlExportResultオブジェクトでエクスポート結果を返却します。HtmlExportResultオブジェクトを使用すると、downloadメソッドを使用してエクスポートの結果をダウンロードしたり、HtmlSettingsのmultiPageプロパティの値に応じて、文字列またはBlob型のdataプロパティを使用して結果を保存することができます。

• TabularDataExport.exportDocumentではTabularDataExportResultオブジェクトでエクスポート結果を返却します。TabularDataExportResultオブジェクトを使用すると、downloadメソッドを使用してエクスポートの結果をダウンロードしたり、TabularDataSettings.csvSettingsのoutputTypeプロパティの値に応じて、文字列またはBlob型のdataプロパティを使用して結果を保存することができます。

以下、各エクスポートタイプのサンプルコードです。

import {
    PdfExport,
    HtmlExport,
    TabularDataExport,
} from "@mescius/activereportsjs";

async function exportPdf(document: PageDocument){
  const pdfSettings: PdfExport.PdfSettings = {
      info: {
          title: "製品リスト"
      }
  }
  const result = await PdfExport.exportDocument(document, pdfSettings);
  result.download("products.pdf");
}

async function exportHtml(document: PageDocument){
   const htmlSettings: HtmlExport.HtmlSettings = {
       title: "製品リスト",
       multiPage: false        
   }
   const result = await HtmlExport.exportDocument(document, htmlSettings);
   result.download("products.html");
}

async function exportCSV(document: PageDocument){
   const csvSettings: TabularDataExport.TabularDataSettings = {
       csvSettings: {
           colSeparator: ","
       }
   }
   const result = await TabularDataExport.exportDocument(document, csvSettings);
   result.download("products.csv");
}

async function onExport(){
    const report = new Core.PageReport();
    await report.load(reportUrl);
    var document = await report.run();
    exportHtml(document);
    exportCSV(document);
    exportPdf(document);
}