Calendar Plus JavaScript API リファレンスラジカルブリッジ Ver

Size: px

Start display at page:

Download "Calendar Plus JavaScript API リファレンスラジカルブリッジ Ver"

みりあみやくぼ
5 years ago
Views:

1 Calendar Plus JavaScript API リファレンスラジカルブリッジ Ver

2 目次イベント処理の記述方法... 2 イベント処理の概要... 2 イベントハンドラーを登録する... 3 特定のイベントタイプ内の特定のイベントハンドラーを削除する... 5 特定のイベントタイプ内のすべてのイベントハンドラーを削除する... 6 すべてのイベントハンドラーを削除する... 7 カレンダー表示イベント... 8 カレンダー画面の描画後イベント... 8 イベントレコード描画時イベントタイトル入力ダイアログからのイベントレコード新規保存前イベントマウスドラッグによるイベントレコード更新前イベントコンテキストメニューからのイベントレコード複製前イベントコンテキストメニューからのイベントレコード削除前イベントイベントレコードクリックによる詳細画面遷移前イベントイベントレコードのマウスオーバーイベントイベントレコードのマウスアウトイベント event オブジェクトで実行できる操作フィールドの値を書き換えるカレンダー Plus はラジカルブリッジの登録商標です記載された商品名各製品名は各社の登録商標または商標です 1

3 イベント処理の記述方法イベント処理の概要カレンダー Plus で発生する様々なイベントについてハンドラーを紐付けして実行することができます 2

4 イベントハンドラーを登録する関数 calendarplus.events.on(eventtype, handler(event)); プロパティパラメータ名指定する値必須説明 eventtype 文字列または文字必須イベントハンドラーをバインドする対象のイベントタイプまたはイベントタイプの配列を指定します列の配列 handler(event) Function(Object) 必須イベント発生時に実行されるハンドラーです event オブジェクトは共通で type プロパティにイベントタイプを持ちます下記のイベントのハンドラー内で kintone.promise オブジェクトを return すると非同期処理の実行を待ってイベントの処理を開始しますまた false を return すると後続の処理をキャンセルできますタイトル入力ダイアログからのイベントレコード新規保存前イベントマウスドラッグによるイベントレコード更新前イベントコンテキストメニューからのイベントレコード複製前イベントコンテキストメニューからのイベントレコード削除前イベントイベントレコードクリックによる詳細画面遷移前イベント kintone.promise オブジェクトは then メソッドを持っているオブジェクトです参考 ( 外部サイト ) 戻り値ありません 3

5 サンプルプログラム // イベントハンドラーの登録を実行する var handler = function(event) { console.log(event); }; kintone.events.on('app.record.index.show', function(e) { calendarplus.events.on('cp.calendar.show', handler); }); 4

6 特定のイベントタイプ内の特定のイベントハンドラーを削除する関数 calendarplus.events.off(eventtype, handler(event)); プロパティパラメータ名指定する値必須説明 eventtype 文字列または文字必須削除対象のイベントハンドラーを登録したイベントタイプまたはイベントタイプの配列を指定します列の配列 handler(event) Function(Object) 必須削除対象のイベントハンドラーですイベント登録時と同一のオブジェクトを指定します戻り値 true: 一つでも削除に成功した場合 false: 削除対象のイベントハンドラーが 1 つも見つからなかった場合サンプルプログラム // イベントハンドラーの削除を実行する var handler = function(event) { console.log(event); }; calendarplus.events.off('cp.calendar.show', handler); 5

7 特定のイベントタイプ内のすべてのイベントハンドラーを削除する関数 calendarplus.events.off(eventtype); プロパティパラメータ名指定する値必須説明 eventtype 文字列または文字必須削除対象のイベントハンドラーを登録したイベントタイプまたはイベントタイプの配列を指定します列の配列戻り値 true: 一つでも削除に成功した場合 false: 削除対象のイベントハンドラーが 1 つも見つからなかった場合サンプルプログラム // イベントハンドラーの削除を実行する calendarplus.events.off('cp.calendar.show'); 6

8 すべてのイベントハンドラーを削除する関数 calendarplus.events.off(); 戻り値 true: 一つでも削除に成功した場合 false: 削除対象のイベントハンドラーが 1 つも見つからなかった場合 7

9 カレンダー表示イベントカレンダー画面の描画後イベントカレンダー画面の描画終了後に発生するイベントです表示対象の日付範囲切り替え時や月別週別日別表示の切り替え時にもイベントが発生します 2019/3/6 現在ドラッグ & ドロップによるイベントレコード更新時には当イベントが 2 回発生しますイベントタイプ cp.calendar.show event オブジェクトのプロパティプロパティ名型説明 view オブジェクト表示中のカレンダービューに関する情報を保持した FullCalendar の View オブジェクトです詳細は参考サイトを参照してください参考 ( 外部サイト ) event オブジェクトで実行できる操作ありません 8

10 サンプルプログラム kintone.events.on('app.record.index.show', function(e) { calendarplus.events.on('cp.calendar.show', function(event) { alert(" カレンダーが表示されました "); }); }); 9

11 イベントレコード描画時イベント各イベントレコードの描画時に発生するイベントですイベントタイプ cp.event.show event オブジェクトのプロパティプロパティ名型説明 record オブジェクトレコードオブジェクト view オブジェクト表示中のカレンダービューに関する情報を保持した FullCalendar の View オブジェクトです詳細は参考サイトを参照してください参考 ( 外部サイト ) element オブジェクト描画されたイベントレコードの jquery 要素です event オブジェクトで実行できる操作ありません 10

12 タイトル入力ダイアログからのイベントレコード新規保存前イベントタイトル入力ダイアログからの新規イベントレコード保存前に発生するイベントです false を return すると保存処理をキャンセルできます kintone.promise オブジェクトを return すると非同期処理の実行を待ってイベントの処理を開始しますイベントタイプ cp.event.create.submit event オブジェクトのプロパティプロパティ名型説明 record オブジェクトレコードオブジェクト event オブジェクトで実行できる操作フィールドの値を書き換える 11

13 サンプルプログラム kintone.events.on('app.record.index.show', function(e) { calendarplus.events.on('cp.event.create.submit', function(event) { var title = event.record[' タイトル ']['value']; console.log(title); return event; }); }); 12

14 マウスドラッグによるイベントレコード更新前イベントマウスドラッグによるイベントレコードの日時やリソースの更新前に発生するイベントです false を return すると更新処理をキャンセルできます kintone.promise オブジェクトを return すると非同期処理の実行を待ってイベントの処理を開始しますイベントタイプ cp.event.edit.submit event オブジェクトのプロパティプロパティ名型説明 record オブジェクト 2019/4/8 変更変更対象フィールドのみが含まれる更新用レコードオブジェクト任意のフィールドに独自の値をセットして更新する場合は適宜フィールドを追加してください record-original オブジェクト 2019/4/8 追加変更前のレコードオブジェクト recordid 数値レコード ID event オブジェクトで実行できる操作フィールドの値を書き換える 13

15 コンテキストメニューからのイベントレコード複製前イベントイベントレコードのコンテキストメニューから複製を選択してレコードを複製する前に発生するイベントです false を return すると複製処理をキャンセルできます kintone.promise オブジェクトを return すると非同期処理の実行を待ってイベントの処理を開始しますイベントタイプ cp.event.duplicate.submit event オブジェクトのプロパティプロパティ名型説明 record オブジェクト 2019/4/8 変更登録用レコードオブジェクト複製元のレコードオブジェクトから以下のフィールドを除外しています kintone REST API で登録できないフィールドタイプレコード番号レコード ID リビジョン作成者作成日時更新者更新日時カテゴリーステータス作業者添付ファイルフィールドリソースとして設定されていないルックアップフィールド 4 添付ファイルフィールドやルックアップフィールドが含まれるサブテーブル record-original オブジェクト 2019/4/8 追加複製元のレコードオブジェクト recordid 数値レコード ID event オブジェクトで実行できる操作フィールドの値を書き換える 14

16 コンテキストメニューからのイベントレコード削除前イベントイベントレコードのコンテキストメニューから削除を選択してレコードを削除する前に発生するイベントです false を return すると削除処理をキャンセルできます kintone.promise オブジェクトを return すると非同期処理の実行を待ってイベントの処理を開始しますイベントタイプ cp.event.delete.submit event オブジェクトのプロパティプロパティ名型説明 record オブジェクトレコードオブジェクト recordid 数値レコード ID event オブジェクトで実行できる操作ありません 15

17 イベントレコードクリックによる詳細画面遷移前イベントイベントレコードをクリックして詳細画面に遷移する前に発生するイベントです false を return すると画面遷移をキャンセルできますイベントタイプ cp.event.click event オブジェクトのプロパティプロパティ名型説明 record オブジェクトレコードオブジェクト jsevent オブジェクトクリック時のマウス座標などを保持した JavaScript のオブジェクトです view オブジェクト表示中のカレンダービューに関する情報を保持した FullCalendar の View オブジェクトです詳細は参考サイトを参照してください参考 ( 外部サイト ) event オブジェクトで実行できる操作ありません 16

18 イベントレコードのマウスオーバーイベントイベントレコードにマウスオーバーした時に発生するイベントですイベントタイプ cp.event.mouseover event オブジェクトのプロパティプロパティ名型説明 record オブジェクトレコードオブジェクト jsevent オブジェクトマウスオーバー時のマウス座標などを保持した JavaScript のオブジェクトです view オブジェクト表示中のカレンダービューに関する情報を保持した FullCalendar の View オブジェクトです詳細は参考サイトを参照してください参考 ( 外部サイト ) event オブジェクトで実行できる操作ありません 17

19 イベントレコードのマウスアウトイベントイベントレコードからマウスアウトした時に発生するイベントですイベントタイプ cp.event.mouseout event オブジェクトのプロパティプロパティ名型説明 record オブジェクトレコードオブジェクト jsevent オブジェクトマウスアウト時のマウス座標などを保持した JavaScript のオブジェクトです view オブジェクト表示中のカレンダービューに関する情報を保持した FullCalendar の View オブジェクトです詳細は参考サイトを参照してください参考 ( 外部サイト ) event オブジェクトで実行できる操作ありません 18

20 event オブジェクトで実行できる操作フィールドの値を書き換えるハンドラーが record オブジェクトのフィールドの値を書き換えて event オブジェクトを return した場合その値でフィールドの値を更新します最後のハンドラーが return しない場合フィールドの値を更新しません複数のハンドラーが登録されている場合最後のハンドラーが return した戻り値を基準に反映されますその他注意事項制限事項は kintone REST API の制限事項 ( 共通仕様の制限事項レコードの登録 (1 件 ) レコードの更新 (1 件 )) に準じます参考 ( 外部サイト ) サンプルプログラム kintone.events.on('app.record.index.show', function(e) { calendarplus.events.on('cp.event.create.submit', function(event) { event.record[' タイトル ']['value'] = ' 初期タイトル '; return event; }); }); 19

目次 1 章はじめに本書の利用について Web ブラウザーについて章 kintone でタイムスタンプに対応したアプリを作成する kintone にログインする kintone でアプリを作成する

目次 1 章はじめに本書の利用について Web ブラウザーについて章 kintone でタイムスタンプに対応したアプリを作成する kintone にログインする kintone でアプリを作成する for kintone 操作マニュアル Ver.1.6.1 目次 1 章はじめに... 1 1.1 本書の利用について... 1 1.2 Web ブラウザーについて... 1 2 章 kintone でタイムスタンプに対応したアプリを作成する... 2 2.1 kintone にログインする... 2 2.2 kintone でアプリを作成する... 2 2.2.1 作成するアプリに最低限必要なフィールド...

Calendar Plus JavaScript API リファレンス ラジカルブリッジ Ver

Calendar Plus JavaScript API リファレンスラジカルブリッジ Ver