5.4.6. スクリプトを設定する¶
5.4.6.1. 目的¶
- データベースのデータを直接ワークブック上に表示する。
- 外部のサービスと連携し、外部サービスのデータをワークブック上に表示する。
- IM-LogicDesignerと連携させ、任意のAPIと連携する。
- セルに入力した情報をデータベースに反映させる。
- セルに独自の入力チェックを追加する。
5.4.6.2. 前提条件¶
スクリプトの設定を行うには、管理権限が必要です。
ワークブックの管理権限が無い場合、スクリプトの設定を行うことはできません。設定したスクリプトは、権限に関わらず実行されます。コラム
外部公開URLからアクセスした場合、権限に関わらずスクリプトの編集を行うことはできません。設定したスクリプトは、権限に関わらず実行されます。設定したスクリプトを反映するには、ワークブックを保存してください。
スクリプトが設定されたワークブックをエクスポートする場合、ファイル種別に「json」または「sjs」を指定してください。
ファイル種別に「excel」を指定してエクスポートを行った場合、スクリプトの設定情報は出力されるファイルに含まれません。
スクリプトが設定されたワークブックをインポートする場合、管理権限の有るユーザで実行してください。
権限の無いユーザで実行した場合、スクリプトの設定情報はインポートされません。
履歴からワークブックを表示した場合、履歴情報を作成した時点で設定されていたスクリプトが実行されます。
5.4.6.3. スクリプトの設定が可能なワークブックを作成する¶
管理権限のあるグループを選択し、ワークブックを作成します。
「ファイル」 - 「保存」をクリックし、保存ダイアログを表示します。
ワークブックの情報が表示されます。
管理権限の有るグループを選択し、内容を入力して「新規保存」ボタンをクリックします。
5.4.6.4. ユーザスクリプトを設定する¶
「ファイル」 - 「スクリプト設定」をクリックし、スクリプト設定ダイアログを表示します。
「ユーザスクリプト」タブを選択します。
イベント イベント 引数 説明 onInit spread ワークブックを開いた時に実行されるイベントです。ワークブックの読み込みが完了した後に実行されます。onSave spread ワークブックを保存する時に実行されるイベントです。保存処理の前に実行されます。onImport spread ワークブックをインポートする時に実行されるイベントです。インポート処理の後に実行されます。onExport spread, context ワークブックをエクスポートする時に実行されるイベントです。エクスポート処理の前に実行されます。onPrint spread, context ワークブックを印刷する時に実行されるイベントです。印刷処理の前に実行されます。
コラム
コラム
オプション | 設定値 | default | 説明 |
---|---|---|---|
cancel | true/false | true | true: 設定したスクリプトの実行時にエラーが発生した場合、処理を中断します。
false: 設定したスクリプトの実行時にエラーが発生した場合、エラーを無視して処理を実行します。
|
コラム
5.4.6.5. カスタム関数を設定する¶
「ファイル」 - 「スクリプト設定」をクリックし、スクリプト設定ダイアログを表示します。
「カスタム関数」タブを選択します。
コラム
- 同期
function evaluate(arg1) { return 'this is sample'; }
引数 説明 arg1 関数で指定した値が渡されます。複数の引数を利用する場合は、カンマ区切りで引数を増やしてください。
- 非同期
function evaluate(context, arg1) { context.setAsyncResult('this is sample'); }
引数 説明 context contextにはAsyncEvaluateContextオブジェクトが渡されます。AsyncEvaluateContextの詳細は以下を参照してください。SpreadJS AsyncEvaluateContextタイプarg1 関数で指定した値が渡されます。複数の引数を利用する場合は、カンマ区切りで引数を増やしてください。
コラム
5.4.6.6. イベントハンドラを設定する¶
「ファイル」 - 「スクリプト設定」をクリックし、スクリプト設定ダイアログを表示します。
「イベントハンドラ」タブを選択します。
コラム
コラム