JavaScript API一覧

本章では、JS API のすべてのインターフェイスをまとめており、各APIの機能やモバイル端末で使用できるかどうかを確認できます。

注意：JS APIの名称の大文字と小文字は区別されます。必ずこのドキュメントと同じようにしてください。

一般帳票、ダッシュボード両方ともに使用可能。作用するエレメントによって、グローバルAPI、パラメータAPI、ウィジェットAPI、データベースAPI、ツールバーAPI、帳票改ページAPI、帳票出力APIに分けられています。

1.グローバルAPI

グローバルAPIが基本的に帳票の主体に作用します。_g()（帳票オブジェクトを獲得）を除き、FRオブジェクト及びFRオブジェクトのメソッドを含みます。

g() を通して帳票オブジェクトを獲得する方法は以下のようになります。

FR オブジェクトのメソッドは以下のようになります。

下表はモバイル端末にだけサポートされるFRオブジェクトのメソッドです。

下表はFSオブジェクトのメソッドです。

2.パラメータパネルAPI

下表のパラメータパネルのAPIを通して、パラメータパネルの一部の属性を調整できます。

3.ウィジェットAPI

ウィジェットAPIは主にパラメータパネルの中のウィジェットの変更、セルの中のウィジェットの書込み、ダッシュボードbodyの中のウィジェットの属性の書込みに使用されます。ウィジェットのAPIは通用と専用の2種類に分けられ、通用APIは特殊ウィジェットを除いて全てのウィジェットで利用することができますが、専用ウィジェットは指定のウィジェットしか使用できません。

獲得したウィジェットAPIはウィジェットの「イベント」にしか使用できません。具体的には下記の表の通りです。

通用APIは下記の表の通りです。

下表は「日付ウィジェット」の専用APIです。

下表は「プルダウンボックス」ウィジェットの専用APIです。

下表は「プルダウンボックス」ウィジェットの専用APIです。

4.テーブルAPI

テーブルAPIは主に、帳票の中のテーブルの内容の変更に使用されます。応用シーンによって、テキストスクロールAPI、スクロールバー非表示API、セル背景変更API、セルフォルト変更API、行列サイズ変更APIス、セル値の獲得と設定API、及びセル通知設定、セルスタイル設定APIに分けられます。

下表はテキストスクロールAPIです。

下表はスクロールバー非表示APIです。

下表はセル背景変更APIです。

下表はセルフォント変更APIです。

下表はセル通知設定APIです。

下表はセルフォント変更APIです。

下表はセルスタイル設定APIです。

下表はセルスタイル設定APIです。

5.ツールバーAPI

ツールバーAPIは主にツールバー及びその中のボタンの属性の変更に使用されます。ツールバーAPI、ツールバーボタンの通用API、ツールバーボタンの専用APIに分けられます。

下表はツールバーAPIです。

下表のツールバーボタンの通用APIは、特殊タイプ以外のすべてのツールバーボタンに通用します。

下表のメールボタンの専用APIはメールボタンだけ使用できます。

6.帳票改ページAPI

下表の帳票改ページAPIは主に帳票の改ページに使用されます。

7.帳票エクスポートAPI

下表のエクスポートAPIは主に帳票のエクスポートに使用されます。

一般帳票APIは一般帳票cptだけが使用できるもので、パブリック部分とプライベート部分に分けられます。パブリック部分は全てのプレビューモードで使用できる一方、プライベート部分は特定のプレビューモードでしか使用できません。

1.汎用API

下表は汎用APIです。

2.改ページプレビューAPI

下表は改ページプレビューの専用APIです。

3.書き込みプレビューAPI

下表は書き込みプレビューの専用APIです。

4.データ分析プレビューAPI

下表はデータ分析の専用APIです

ダッシュボードAPIはダッシュボードfrmだけ使用できるもので、コンポーネント獲得API、コンポーネント通用API、コンポーネントTabAPIの三つに分けられます。

1.コンポーネント獲得API

下表はコンポーネント獲得APIです。

2.コンポーネント汎用API

下表のコンポーネント通用APIはダッシュボードの全てのコンポーネントが使用できるものです。

3.帳票ブロックAPI

下表の帳票ブロックAPIは帳票ブロックのコンポーネントの属性変更に使用されます。

4.TabコンポーネントAPI

下表のコンポーネントTabAPIはコンポーネントTabの属性変更に使用されます。