APIを使用したレポート作成

概要

ActiveReportsJSのAPIは、コードで製品機能にアクセスできる強力なツールです。このプログラミングインタフェースを使用すると、次のような様々なタスクを実行できます。

JSONファイルやJSONオブジェクトからレポートテンプレートを読み込むことができます。
既存のレポートテンプレートを変更するか、新しいレポートテンプレートを作成して、レポートのデザインとレイアウトを実行中に制御することができます。
レポートを実行してパラメータ値を指定することで、リアルタイムデータを含む動的レポートを生成できます。
レポートをPDF、HTML、CSV形式など一般的なファイル形式にエクスポートして、容易にレポートの共有と配布が可能です。

ActiveReportsJSではAPIを使用して簡単にレポートを作成できるようにTypeScriptの型宣言を備えたコアライブラリが提供されます。これにより、Visual Studio CodeなどのIDEでコードのオートコンプリート機能と型チェックを利用でき、開発工数の削減が可能です。コアライブラリはJavaScriptコードでも使用できますが、TypeScriptを使用することをお勧めします。

コアライブラリをアプリケーションに追加する方法については、インストールを参照してください。

良く使用するデータ型

ActiveReportsJSのAPIのコアライブラリには様々な型が含まれていますが、APIを使用するときにいくつかの型が重要になります。これらの主な型はAPIを使用する際や、レポートテンプレートの読込や変更、レポートの実行、様々な形式へのエクスポートなど一般的なタスクを実行する際に使用します。

Report型は、レポートテンプレートを表します。Report型には、レポートのレポートアイテム定義やレイアウト構造、データ連結定義が含まれています。レポートアイテムにはレポートを構成するTable、Chart、TextBoxなど各レポートコントロールが含まれます。データ連結は、レポートをデータソースと連結し、動的データを表示できるようにします。
Report型を使用して、変数、関数パラメータ、および戻り値の型に注釈を付けて型情報を組込み新しいレポートテンプレートを作成したり、既存のレポートテンプレートを読み込みTypeScriptを使用してコードの型チェックを有効にすることができます。Report型のような型宣言は、型チェックと型ヒントにのみ使用され、実行時には適用されないため、注意が必要です。
PageReportクラスはレポートを表し、レポートの操作に必要なメソッドとプロパティを提供します。このクラスを使用するとファイルまたはReportオブジェクトからレポートテンプレートをロードし、パラメータなどの指定されたオプションを使用してレポートを実行可能です。
PageDocumentクラスは、描画されるレポートを表します。このクラスを使用すると、レポートを印刷したり、PDF、HTML、CSVなどの様々なファイル形式にエクスポートすることができます。
PdfExport、HtmlExport、TabularDataExportクラスは、それぞれPDF、HTML、CSV形式にレポートをエクスポートを行います。