バージョン
注意事項(必読):
1)一般帳票およびダッシュボード(新)では、以下の API は 「FR.xxx」形式で使用します。FineVisテンプレートでは 「duchamp.xxx」形式を使用します。
2)一部のインターフェースでは、FineVisテンプレートでのパラメータは json 形式、一般帳票とダッシュボードでは文字列形式です。詳細は以下の各インターフェース説明をご参照ください。
servletURL
属性 | servletURL | servletURL を取得 |
パラメータ | - | - |
戻り値 | string | servletURLを取得し、戻り値は文字列で、形式は: |
使用例 | 一般帳票、ダッシュボードの例示: FineVisテンプレートの例示: duchamp.servletURL; | |
応用例 | - | |
モバイル端末 | モバイル端末をサポートしており、モバイル端末の戻り形式はPC 端末とは異なります。例:/webroot/decision | |
serverURL
属性 | serverURL | serverURL を取得 |
パラメータ | - | - |
戻り値 | string | serverURLを取得し、戻り値は文字列で、形式は: http://localhost:8075 |
使用例 | 一般帳票、ダッシュボードの例示: FineVisテンプレートの例示: | |
応用例 | - | |
モバイル端末 | 一般帳票やダッシュボードはサポートされていませんが、 FineVisテンプレートはモバイル端末に対応しています | |
server
属性 | server | server を取得 |
パラメータ | - | - |
戻り値 | string | serverURLを取得し、戻り値は文字列で、形式は: http://localhost:8075/webroot |
使用例 | 一般帳票、ダッシュボードの例示: FineVisテンプレートの例示: duchamp.server; | |
応用例 | - | |
モバイル端末 | 一般帳票やダッシュボードはサポートされていませんが、 FineVisテンプレートはモバイル端末に対応しています | |
fineServletURL
属性 | fineServletURL | fineServletURL を取得 |
パラメータ | - | - |
戻り値 | string | fineServletURLを取得し、戻り値は文字列で、形式は: |
使用例 | 一般帳票、ダッシュボードの例示: FineVisテンプレートの例示: | |
応用例 | - | |
モバイル端末 | 一般帳票やダッシュボードはサポートされていませんが、 FineVisテンプレートはモバイル端末に対応しています | |
SessionMgr.getSessionID
メソッド | SessionMgr.getSessionID() | sessionId を取得 |
パラメータ | - | - |
戻り値 | string | sessionIdを取得し、戻り値は文字列で、例: |
使用例 | 一般帳票、ダッシュボードの例示: FineVisテンプレートの例示: | |
応用例 | ボタンをクリックして、帳票のsessionIdを印刷します: クリックするとテンプレートをダウンロードできます:
FineVisテンプレート:
| |
モバイル端末 | モバイル端末をサポート | |
showDialog
一般帳票とダッシュボード
メソッド | showDialog(title, width, height, innerContent) | ダイアログを開く |
パラメータ | title:string width:number height:number innerContent:iframe 注意:バージョン11.0.10 以降のパラメータはJSON 形式をサポートしています。以下の通りです: { title:string, width:number, height:number, innerContent:iframe } | title:ダイアログのタイトル、文字列形式 width:ダイアログの幅 height:ダイアログの高さ innerContent:ダイアログの内容はiframeタグです。プロジェクト内の帳票を開くには、まず帳票をiframeタグとして定義する必要があります |
戻り値 | string | |
使用例 | 例1:「ポップアップ」というタイトル、幅600・高さ400、「Hello World」を表示するダイアログを開きます 一般帳票、ダッシュボードの例示: 例2:「販売量」というタイトル、幅700・高さ500、テンプレート「入門デモ.cpt」を内容とするダイアログを開きます 注意:デザイナで以下の長いコードを追加する場合、改行によるコードの形式の問題に気を付けてください。形式を修正すれば問題ありません。 一般帳票、ダッシュボードの例示: | |
応用例 | ボタンをクリックすると、「販売量ポップアップ」というタイトルのウィンドウが開き、幅 700 、高さ500のサイズで、内容は内蔵テンプレート「 入門デモ.cpt 」のダイアログが表示されます。
| |
モバイル端末 | モバイル端末には非対応 | |
FineVisテンプレート
メソッド | showDialog( { title:string, width:number, height:number, innerContent:iframe, padding: style, titleStyle:style, backgroundStyle: style, dialogType:string, line: style, coordinate: array } ) | 中央に表示されるポップアップウィンドウ、またはガイドライン付きのポップアップウィンドウを開きます |
パラメータ | title:string width:number height:number innerContent:iframe padding: style titleStyle:style backgroundStyle: style dialogType:string line: style coordinate: array | title:ポップアップのタイトル、文字列 width:ポップアップの幅
height:ポップアップの高さ
innerContent:ポップアップの内容はiframeタグです。プロジェクト内の帳票を開くには、まず帳票をiframeタグとして定義する必要があります 内側の余白を設定するためのプロパティで、例えば padding: "10px" のように指定します。 titleStyle:タイトルスタイル設定 backgroundStyle:枠背景スタイル設定 注意:titleStyle と backgroundStyle は柔軟性があり、 CSSで実現可能な書き方はすべてサポートされています dialogType:ポップアップの形式で、デフォルトでは中央に表示されます
line:ガイドライン設定
例えば line: { type: "color", value:{ color: "red" }}, coordinate:ガイドラインの開始位置の座標で、プレビュー モードの座標系に基づいています。座標は画面に対する相対的な位置を示します。例えば coordinate: [200, 300] 注意:coordinate は getCoordinate インターフェースと組み合わせて使用することで、コンポーネントの座標を取得でき、ガイドラインは常にコンポーネントの位置で表示されます |
戻り値 | string | |
例 | 例1:タイトル「販売量ポップアップ」を持ち、幅 700 、高さ500 、内側の余白が15px 、フォントは太字でサイズ24px 、背景色は緑色、内容は「 Hello World 」のポップアップウィンドウを表示します 例2:タイトルが「売上ポップアップ」で、幅 700 、高さ500 、ポップアップの内容は取込みテンプレート「入門デモ.cpt」で、中央に表示されるポップアップウィンドウを開きます 例3:タイトルが「売上ポップアップ」で、幅 500 、高さ500 、ポップアップの内容は取込みテンプレート「入門デモ.cpt」で、動的に表示されるポップアップウィンドウを開きます | |
応用例 | 上記の例 2と例 3を参考にしてテンプレートを作成し、以下の図のような効果を実現します: | |
モバイル端末 | FineVis プラグインのバージョン V2.7.0 以降は、モバイルデバイスに対応しています | |
getCoordinate
メソッド | getCoordinate() | FineVis テンプレートがプレビュー中の際に、コンポーネントやモデルの座標を取得します 通常、動的ポップアップウィンドウを表示する際には、 showDialog インターフェースを使用します |
パラメータ | name:string | パラメータ name は、 3Dコンポーネントモデルのmeshオブジェクト名を取得するためにのみ使用され、オブジェクトの座標を返します。例えば: パラメータを渡さない場合、コンポーネントの中心座標を取得します。例えば: |
戻り値 | Array | コンポーネント/モデルの座標 |
例 | 例 1:タイトルをクリックすると、タイトルコンポーネントの座標を取得し、その位置にガイドライン付きのポップアップウィンドウを開きます 例 2:3Dコンポーネント「駐車場モデル」内の「車両 002 」モデルオブジェクトの座標を取得し、その位置にポップアップウィンドウを開きます。注意:この方法で開いたポップアップウィンドウは、モデルのスケールや視点の変化に影響されず、位置が変わりません 例 3:3Dコンポーネント「駐車場モデル」内の「車両 002 」モデルオブジェクトの座標を取得し、その位置にポップアップウィンドウを開きます。注意:この方法で開いたポップアップウィンドウは、モデルのスケールや視点の変化に影響されず、位置が変わります | |
応用例 | 上記の例 2と例 3を参考にしてテンプレートを作成し、以下の図のような効果を実現します:
| |
モバイル端末 | モバイル端末には非対応 | |
closeDialog
メソッド | closeDialog | ダイアログを閉じる |
パラメータ | - | - |
戻り値 | void | |
例 | 一般帳票、ダッシュボードの例示: FineVisテンプレートの例示1: FineVis テンプレートの例示2:ポップアップウィンドウを開いた後、ウィンドウ内のテンプレートが親ページのポップアップウィンドウを閉じます | |
応用例 | ポップアップウィンドウでデータを選択すると、開いているダイアログが自動的に閉じます: | |
モバイル端末 | 一般帳票とダッシュボードはモバイル端末には対応していませんが、 FineVis プラグイン V2.7.0 以降のバージョンはモバイル端末に対応しています | |
doHyperlinkByGet
一般帳票とダッシュボード
メソッド | doHyperlinkByGet(url,para,target,feature) | Get メソッドでウェブページを開き、パラメータを渡せ、ページ属性も設定可能 |
パラメータ | URL :object para :object target :object feature :object 注意:バージョン11.0.10 以降のパラメータはJSON 形式をサポートしています。以下の通りです: { URL :object para :object target :object feature :object } | URL:URL または Json ハイパーリンクの定義、必須項目です サポートされている絶対パスは以下の通りです: http://192.168.100.1:8080/webroot/decision/view/report?viewlet=入門デモ.cpt 相対パスは以下の通りです:/webroot/decision/view/report?viewlet=入門デモ.cpt para:渡されるパラメータで、記入は任意です target:ハイパーリンクの子ページを開く位置で、記入は任意です
feature:ハイパーリンクの開く位置に関する属性で、記入は任意です 注意:モバイルデバイスでは target と feature パラメータの効果はサポートされていません |
戻り値 | void | |
使用例 | 組み込みテンプレート 入門デモ.cpt を開き、「販売帳票」を選択し、パラメータ「関東」とパラメータパネルを表示するかどうかを渡し、開く方法はダイアログで、ダイアログの幅は 700 、高さは 500 にします: | |
応用例 | ボタンをクリックすると、タイトルが「販売帳票」で、内容が関東地域の販売状況、幅 700、高さ500のダイアログが表示されます:
| |
モバイル端末 | モバイル端末をサポート | |
FineVisテンプレート
メソッド | doHyperlinkByGet( { url:object, para:object, target:object, feature:object } ) | Get メソッドでウェブページを開き、パラメータを渡せ、ページ属性も設定可能 |
パラメータ | url:object, para:object, target:object, feature:object | URL:URL または Json ハイパーリンクの定義、必須項目です サポートされている絶対パスは以下の通りです: http://192.168.100.1:8080/webroot/decision/view/report?viewlet=入門デモ.cpt 相対パスは以下の通りです:/webroot/decision/view/report?viewlet=入門デモ.cpt para:渡すパラメータ、任意で入力できます target:リンク先ページの開く位置で、任意で入力できます。デフォルトは _dialog です
feature:ハイパーリンクの開く位置に関する属性で、記入は任意です |
戻り値 | void | |
使用例 | 組み込みテンプレート 入門デモ.cpt を開き、「販売帳票」を選択し、パラメータ「関東」とパラメータパネルを表示するかどうかを渡し、開く方法はダイアログで、ダイアログの幅は 700 、高さは 500 にします: | |
応用例 | ボタンをクリックすると、タイトルが「販売帳票」で、内容が関東地域の販売状況、幅 700、高さ500のダイアログが表示されます: テンプレートをダウンロードするには、こちらをクリックしてください: | |
モバイル端末 | モバイル端末をサポート | |
doHyperlinkByPost
一般帳票とダッシュボード
メソッド | doHyperlinkByPost(url,para,target,feature) | Post メソッドでウェブページを開き、パラメータを渡せ、ページ属性も設定可能 |
パラメータ | URL :object para :object target :object feature :object | URL:URL または Json ハイパーリンクの定義、必須項目です サポートされている絶対パスは以下の通りです: http://192.168.100.1:8080/webroot/decision/view/report?viewlet=入門デモ.cpt 相対パスは次のようになります: /webroot/decision/view/report?viewlet=GettingStarted.cpt para:渡されるパラメータで、記入は任意です target:ハイパーリンクの子ページを開く位置で、記入は任意です
feature:ハイパーリンクの開く位置に関する属性で、記入は任意です 注意:モバイル端末では target および feature パラメータの効果がサポートされていません。 |
戻り値 | void | |
使用例 | 組み込みテンプレート 入門デモ.cpt を開き、「販売帳票」を選択し、パラメータ「関東」とパラメータパネルを表示するかどうかを渡し、開く方法はダイアログで、ダイアログの幅は 700 、高さは 500 にします: | |
応用例 | ボタンをクリックすると、タイトルが「販売帳票」で、内容が関東地域の販売状況、幅 700、高さ500のダイアログが表示されます: | |
モバイル端末 | モバイル端末をサポート | |
FineVisテンプレート
メソッド | doHyperlinkByPost( { url:object, para:object, target:object, feature:object } ) | Post メソッドでウェブページを開き、パラメータを渡せ、ページ属性も設定可能 |
パラメータ | URL :object para :object target :object feature :object | URL:URL または Json ハイパーリンクの定義、必須項目です サポートされている絶対パスは以下の通りです: http://192.168.100.1:8080/webroot/decision/view/report?viewlet=入門デモ.cpt 相対パスは次のようになります: /webroot/decision/view/report?viewlet=GettingStarted.cpt para:渡すパラメータ、任意で入力できます target:リンク先ページの開く位置で、任意で入力できます。デフォルトは _dialog です
feature:ハイパーリンクの開く位置に関する属性で、記入は任意です |
戻り値 | void | |
使用例 | 組み込みテンプレート 入門デモ.cpt を開き、「販売帳票」を選択し、パラメータ「関東」とパラメータパネルを表示するかどうかを渡し、開く方法はダイアログで、ダイアログの幅は 700 、高さは 500 にします: | |
応用例 | ボタンをクリックすると、タイトルが「販売帳票」で、内容が関東地域の販売状況、幅 700、高さ500のダイアログが表示されます | |
モバイル端末 | モバイル端末をサポート | |
doURLPrint
注意:FineVis テンプレートは doURLPrint をサポートしていません。
メソッド | doURLPrint(config) | 印刷ツールを開いて、帳票を印刷します |
パラメータ | config:object | config : 印刷に関するパラメータで、パラメータの形式は doURLPrintに関するドキュメントを参照してください |
戻り値 | Void | |
使用例 | ||
応用例 | カスタムの印刷ボタンを設定し、「ノークライアント」方式で帳票を印刷します: | |
モバイル端末 | モバイル端末には非対応 | |
Msg
メソッド | Msg | FineReport に搭載されている統一スタイルのメッセージボックスは、 Windows の alert 、confirm 、prompt 、toast の代わりに利用できます |
パラメータ | - | |
戻り値 | Void | |
使用例 | - | |
応用例 | - | |
モバイル端末 | モバイル端末をサポート | |
remoteEvaluate
メソッド | remoteEvaluate("formula") | FineReport に搭載されている数式を実行し、その計算結果を返します。 注意1:remoteEvaluate(String) は tablename.select 関数に対応していません。 注意2:ウェブページでは remoteEvaluate(String) を呼び出すことはできません。 |
パラメータ | formula:String | 数式 |
戻り値 | object | |
使用例 | 一般帳票やダッシュボードでは、 FineReportの sum 関数を使って A1 と A2 の合計を計算します: FR.remoteEvaluate("sum(A1,A2)"); 一般帳票やダッシュボードでは、 FineReport の文字列結合関数 CONCATENATE を使って文字列を結合します FR.remoteEvaluate('CONCATENATE("001","1201110")'); FineVis テンプレートのサンプル(V1.15.0 以降のバージョンに対応します): duchamp.remoteEvaluate("sum(A1,A2)"); 注意1:データセットにデータセットパラメータが含まれている場合、インターフェース FR.remoteEvaluate(value("ds1",1,1)) を使用してデータセットの値を取得します。 FRM/CPT ではパラメータの変化に応じて最新の値を取得し、 FineVis V2.0.1 以前のバージョンと V2.10.0 以降のバージョンは最新の値を取得することをサポートしています。 V2.0.1 から V2.9.0 のバージョンは最初のデフォルト値のみを取得することがサポートされています。 注意2:FineVis の日付コントロールを使用する場合、戻り値を文字列として設定する必要があります。 | |
応用例 | - | |
モバイル端末 | モバイル端末には非対応 | |
注意事項
remoteEvaluate インターフェースを使用することには安全リスクがあり、攻撃者がデータベースに対して追加、削除、変更、照会などの操作を行う可能性があります。そのリスクレベルはリモート実行に相当します。
そのため、「ポータル」に「スクリプト数式利用制限」機能が追加され、デフォルトでオンになっています。ユーザが remoteEvaluate インターフェースを使用し、スクリプト数式利用制限スイッチがオンの場合、効果のプレビュー時にポップアップメッセージが表示されます:この呼び出しには安全リスクがあります。使用する場合は、安全管理でスクリプト呼び出し数式制限を変更してください。
以下の図のように:

ユーザがこのメッセージポップアップをキャンセルしたい場合は、ポータル内でこのスイッチをオフにする必要があります。操作方法については「安全防護」をご覧ください
jsonEncode
メソッド | jsonEncode(code) | 文字列を jsonEncode エンコード |
パラメータ | code:String | 必須項目:エンコードが必要な文字列です |
戻り値 | String | |
使用例 | 帳票のパスを jsonEncode でエンコードしてください 一般帳票、ダッシュボードの例示: FineVisテンプレートの例示: | |
応用例 | - | |
モバイル端末 | モバイル端末をサポート | |
jsonDecode
メソッド | jsonDecode(jsonEncode) | jsonEncode でエンコードされた文字列をデコードします |
パラメータ | jsonEncode:String | 必須項目:デコードが必要な文字列です |
戻り値 | String | |
使用例 | jsonEncode でエンコードされたレポートのパスをデコードします 一般帳票、ダッシュボードの例示: FineVisテンプレートの例示: | |
応用例 | - | |
モバイル端末 | モバイル端末をサポート | |
ajax
メソッド | ajax(options) | jQuery.ajax()関数をカプセル化したものは、 dataパラメータに対して中国語・韓国語・日本語のエンコード処理を実施しています。FR.ajax(options)を使用することで、 JavaScriptが動作する任意の場所から呼び出すことができます |
パラメータ | options | |
戻り値 | void | |
使用例 | - | |
応用例 | - | |
モバイル端末 | モバイル端末をサポート | |
isEmpty
メソッド | isEmpty(object) | オブジェクトが空かどうかを判定 |
パラメータ | object:Object | オブジェクト |
戻り値 | Boolean | 空であるかどうか、ブール型
|
使用例 | 1)「テキストボックスウィジェット」 text0 があるかどうかをチェックします 一般帳票とダッシュボード(パラメータパネル内のウィジェット)の例: FineVisテンプレートの例示: 2)「テキストボックスウィジェット」 text0の値があるかどうかをチェックします 一般帳票とダッシュボード(パラメータパネル内のウィジェット)の例: FineVisテンプレートの例示: | |
応用例 | - | |
モバイル端末 | 一般帳票とダッシュボードはモバイル端末をサポートしていませんが、 FineVisテンプレートはモバイル端末をサポートしています | |
isArray
メソッド | isArray(object) | オブジェクトが配列かどうかを判定 |
パラメータ | object:Object | オブジェクト |
戻り値 | Boolean | 空であるかどうか、ブール型
|
使用例 | 配列を定義し、それが配列であるかどうかをチェックします 一般帳票、ダッシュボードの例示: FineVisテンプレートの例示: | |
応用例 | - | |
モバイル端末 | 一般帳票とダッシュボードはモバイル端末をサポートしていませんが、 FineVisテンプレートはモバイル端末をサポートしています | |
cellStr2ColumnRow
メソッド | cellStr2ColumnRow(cell) | セル番号で行列インデックスを取得 |
パラメータ | cell | セル番号 |
戻り値 | {col:colindex, row:rowindex} | 行列インデックス、 JSON 形式
|
使用例 | 例1:一般帳票またはダッシュボードの中で、 A1 セルの行列情報を返します 例2:一般帳票またはダッシュボードの中で、 A1 セルの行列情報を返します 例3:FineVis テンプレートでは、セルの行番号を印刷します | |
応用例 | 一般帳票の例:ボタンをクリックして、 A1 セルの行番号を印刷します FineVis テンプレートの例:ボタンをクリックして、 A3 セルの行番号を印刷します
テンプレートをダウンロードするにはクリックしてください: | |
モバイル端末 | モバイル端末をサポート | |
columnRow2CellStr
メソッド | columnRow2CellStr({col:colindex, row:rowindex}) | 行列番号でセル番号を取得 |
パラメータ | {col:colindex, row:rowindex} | 行列インデックス、 JSON 形式
|
戻り値 | cell | セル番号 |
使用例 | 例1:一般帳票またはダッシュボードの中で、行インデックスが 3 、列インデックスが 1 のセル番号を返します 例2:一般帳票またはダッシュボードの中で、行インデックスが 3 、列インデックスが 1 のセル番号を印刷します 例3:FineVisテンプレートの中で、行インデックスが 3 、列インデックスが 1 のセル番号を印刷します | |
応用例 | 一般帳票の例:行インデックスが 3 、列インデックスが 1 のセル番号を印刷します FineVisテンプレートの例:行インデックスが 3 、列インデックスが 1 のセル番号を印刷します
テンプレートをダウンロードするにはクリックしてください: | |
モバイル端末 | 一般帳票およびダッシュボードはモバイル端末をサポートしていません;FineVis テンプレートはモバイル端末をサポートしています | |
