--- sourceDocument: Xanadu API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference Release : - xanadu ft:locale : - ja-JP ft:publication_title : - Xanadu API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # AbstractTimelineSchedulePage - グローバル # AbstractTimelineSchedulePage - グローバル {#ariaid-title1} * リリースバージョン: Xanadu * * 更新日 2024年08月01日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：12分 AbstractTimelineSchedulePage スクリプトインクルードは、タイムラインに表示されるデータの操作を容易にするヘルパークラスです。 タイムライン内に表示されるデータの処理は、指定されたスクリプト インクルードの対応する関数を実行することによって開始されます。その他のスクリプト インクルードのように、言語構文は JavaScript であり、このタイプのリソースのデフォルトのセキュリティ制約に従います。ただし、さまざまな種類の表示オプションが複雑なため、ヘルパー クラスが作成されました。タイムラインを表示するには、 AbstractTimelineSchedulePage クラスを拡張し、それに対応するスケジュール ページとペアリングします。最低限、クラスの拡張により、getItems() メソッドが上書きされる必要があります。このメソッドは、クライアントに表示されるアイテムを返すための主要なイベント ハンドラーであるためです。 クライアントは、AbstractTimelineSchedulePage が 2 つのフェーズで戻すデータを処理します。最初のフェーズでは、タイムラインの実際の更新が行われます。構成されている場合、その直後に、第 2 フェーズに成功メッセージボックス、エラーメッセージボックス、またはダイアログメッセージプロンプトが表示されます。フェーズ 1 で、データを操作するために使用できるオプションは次のとおりです。 * どのアイテムも更新しない:これはデフォルトの動作です。フェーズ 1 で残りのステップを実行しないでください。 * 特定の項目で更新する: これは、 add() を使用して行われます。 * getItems() 関数を使用してタイムラインをレンダリングします。 これは、`setDoReRenderTimeline(true)` を使用して行われます。 注: 両方の TimelineItem が返され、setDoReRenderTimeline が true に設定されている場合、システムは setDoReRenderTimeline プロパティを無視し、add() 関数によって追加された TimelineItem のみを明示的に表示します。 フェーズ 2 で利用できるオプションは次のとおりです。 * メッセージ ボックスを表示しない: これは既定の動作です。 * 成功ダイアログボックスの表示: これは、setStatusSuccess()を使用して行われます。 * エラーダイアログボックスを表示します。 これは、 setStatusError()を使用して行われます。 * 確認ダイアログを表示する: これは、setStatusPrompt()を使用して行われます。 注: AbstractTimelineSchedulePage を拡張するスクリプトインクルードクラスは、プリフィックスが `sysparm_timeline_` で始まる元の URL からすべての URI パラメーターを自動的に受け取ります。これらの値にアクセスするには、拡張クラスの中で `this.getParameter("sysparm_timeline_VARIABLE");` を使用します。 これは、リストからのコンテキストメニューなど、動的要素からスケジュール ページを表示する必要がある場合に便利です。URL を介して動的データを渡すことにより、スケジュールページにはこれらのパラメーターが Ajax 呼び出し内に自動的に含まれるため、 AbstractTimelineSchedulePage スクリプトインクルード内でアクセスできるようになります。 ## AbstractTimelineSchedulePage - add(Object ObjTimeline) {#ariaid-title2} クライアントに返され、タイムラインに適切に表示される TimelineItem オブジェクトを追加します。 {#r_ATSP-add_O__table_efq_q14_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | ObjTimeline | オブジェクト | タイムラインに追加する TimelineItem オブジェクト | [表 : 1. パラメーター] {#r_ATSP-add_O__table_efq_q14_15} {#r_ATSP-add_O__table_ffq_q14_15__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 2. 返される内容] {#r_ATSP-add_O__table_ffq_q14_15} ## AbstractTimelineSchedulePage - addSeparator() {#ariaid-title3} タイムライン アイテムのリストに水平フレーム セパレーターを追加します。add() を介して今後追加されるすべてのアイテムは、後続のタイムライン フレームに追加されます。 add() メソッドを使用して今後追加されるすべてのアイテムは、後続のタイムラインフレームに追加されます。 {#r_ATSP-addSeparator__table_gfq_q14_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 3. パラメーター] {#r_ATSP-addSeparator__table_gfq_q14_15} {#r_ATSP-addSeparator__table_hfq_q14_15__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 4. 返される内容] {#r_ATSP-addSeparator__table_hfq_q14_15} 次のコード例は、このメソッドを呼び出す方法を示しています。 // Inside of a script include that extends AbstractTimelineSchedulePage this.addSeparator(); ## AbstractTimelineSchedulePage - elementMoveX(文字列 spanSysId, 文字列 newStartDateTimeMs) {#ariaid-title4} タイムライン スパンが水平方向に移動する場合のイベント ハンドラー {#r_ATSP-elementMoveX_S_S__table_x3f_tc4_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | spanSysId | 文字列 | 調整中の現在のスパンのSys ID | | newStartDateTimeMs | 文字列 | スパンの新しい開始時刻 (ミリ秒)。数値比較を実行する前に、必ず parseInt を使用して文字列を解析してください。 | [表 : 5. パラメーター] {#r_ATSP-elementMoveX_S_S__table_x3f_tc4_15} {#r_ATSP-elementMoveX_S_S__table_y3f_tc4_15__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 6. 返される内容] {#r_ATSP-elementMoveX_S_S__table_y3f_tc4_15} ## AbstractTimelineSchedulePage - elementMoveXY(文字列 spanSysId, 文字列 itemSysId, 文字列 itemSysId, 文字列 newItemSysId, 文字列 newStartDateTimeMs) {#ariaid-title5} タイムライン スパンが水平方向と垂直方向の両方に移動する場合のイベント ハンドラー {#r_ATSP-elementMoveXY_S_S_S_S_S__table_bjf_tc4_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | spanSysId | 文字列 | 調整中の現在のスパンのSys ID | | itemSysId | 文字列 | 現在のスパンに関連付けられたタイムライン アイテムのSys ID | | newItemSysId | 文字列 | 現在のスパンがドラッグされたタイムライン アイテム (行) のSys ID | | newStartDateTimeMs | 文字列 | スパンの新しい開始時刻 (ミリ秒)。数値比較を実行する前に、必ず parseInt() を使用して文字列を解析してください。 | [表 : 7. パラメーター] {#r_ATSP-elementMoveXY_S_S_S_S_S__table_bjf_tc4_15} {#r_ATSP-elementMoveXY_S_S_S_S_S__table_cjf_tc4_15__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 8. 返される内容] {#r_ATSP-elementMoveXY_S_S_S_S_S__table_cjf_tc4_15} ## AbstractTimelineSchedulePage - elementMoveY(文字列 spanSysId, 文字列 itemSysId, 文字列 newItemSysId) {#ariaid-title6} タイムライン スパンが垂直方向に移動する場合のイベント ハンドラー {#r_ATSP-elementMoveY_S_S_S__table_z3f_tc4_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | spanSysId | 文字列 | 調整中の現在のスパンのSys ID | | itemSysId | 文字列 | 現在のスパンに関連付けられたタイムライン アイテムのSys ID | | newItemSysId | 文字列 | 現在のスパンがドラッグされたタイムライン アイテム (行) のSys ID | [表 : 9. パラメーター] {#r_ATSP-elementMoveY_S_S_S__table_z3f_tc4_15} {#r_ATSP-elementMoveY_S_S_S__table_ajf_tc4_15__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 10. 返される内容] {#r_ATSP-elementMoveY_S_S_S__table_ajf_tc4_15} ## AbstractTimelineSchedulePage - elementSuccessor(文字列 spanSysId, 文字列 newSuccSpanId) {#ariaid-title7} 2 つのスパンの間にタイムライン関係が作成された場合のイベント ハンドラー {#r_ATSP-elementSuccessor_S_S__table_djf_tc4_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | spanSysId | 文字列 | 新しく作成された関係の先行となる現在のスパンのSys ID | | newSuccSpanId | 文字列 | 作成された関係からの後続スパンのSys ID | [表 : 11. パラメーター] {#r_ATSP-elementSuccessor_S_S__table_djf_tc4_15} {#r_ATSP-elementSuccessor_S_S__table_ejf_tc4_15__entry__2} | タイプ | 説明 | |-|-| | なし | ReturnValue | [表 : 12. 返される内容] {#r_ATSP-elementSuccessor_S_S__table_ejf_tc4_15} ## AbstractTimelineSchedulePage - elementMoveX(String spanSysId, String newStartDateTimeMs) {#ariaid-title8} タイムライン スパンの終了日が変更されたときのイベント ハンドラー {#r_ATSP-elementTimeAdjustEnd_S_S__table_qbb_3g4_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | spanSysId | 文字列 | 調整中の現在のスパンのSys ID | | newEndDateTimeMs | 文字列 | スパンの新しい終了時刻 (ミリ秒単位)。数値比較を実行する前に、必ず parseInt() を使用して文字列を解析してください。 | [表 : 13. パラメーター] {#r_ATSP-elementTimeAdjustEnd_S_S__table_qbb_3g4_15} {#r_ATSP-elementTimeAdjustEnd_S_S__table_rbb_3g4_15__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 14. 返される内容] {#r_ATSP-elementTimeAdjustEnd_S_S__table_rbb_3g4_15} ## AbstractTimelineSchedulePage - elementMoveX(String spanSysId, String newStartDateTimeMs) {#ariaid-title9} タイムライン スパンの開始日が変更されたときのイベント ハンドラー {#r_ATSP-elementTimeAdjustStart_S_S__table_obb_3g4_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | spanSysId | 文字列 | 調整中の現在のスパンのSys ID | | newStartDateTimeMs | 文字列 | スパンの新しい開始時刻 (ミリ秒)。数値比較を実行する前に、必ず parseInt() を使用して文字列を解析してください。 | [表 : 15. パラメーター] {#r_ATSP-elementTimeAdjustStart_S_S__table_obb_3g4_15} {#r_ATSP-elementTimeAdjustStart_S_S__table_pbb_3g4_15__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 16. 返される内容] {#r_ATSP-elementTimeAdjustStart_S_S__table_pbb_3g4_15} ## AbstractTimelineSchedulePage - getItems() {#ariaid-title10} タイムラインに表示するスケジュール項目を返すイベント ハンドラー {#r_ATSP-getItems__table_v3f_tc4_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | none | | | [表 : 17. パラメーター] {#r_ATSP-getItems__table_v3f_tc4_15} {#r_ATSP-getItems__table_w3f_tc4_15__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 18. 返される内容] {#r_ATSP-getItems__table_w3f_tc4_15} ## AbstractTimelineSchedulePage - inputBox(文字列 strInputText) {#ariaid-title11} 文字列が左ペインの入力ボックスに入力されたときのイベント ハンドラー {#r_ATSP-inputBox_S__table_sbb_3g4_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | strInputText | 文字列 | 左ペインの入力ボックスに入力されたテキスト | [表 : 19. パラメーター] {#r_ATSP-inputBox_S__table_sbb_3g4_15} {#r_ATSP-inputBox_S__table_tbb_3g4_15__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 20. 返される内容] {#r_ATSP-inputBox_S__table_tbb_3g4_15} ## AbstractTimelineSchedulePage - itemMove(文字列 itemSysId, 文字列 newItemSysId) {#ariaid-title12} タイムラインの行アイテムが移動され、別の行アイテムにドラッグされたときのイベント ハンドラー {#r_ATSP-itemMove_S_S__table_ubb_3g4_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | itemSysId | 文字列 | 現在のスパンに関連付けられたタイムライン アイテムのSys ID | | newItemSysId | 文字列 | 現在のスパンがドラッグされたタイムライン アイテム (行) のSys ID | [表 : 21. パラメーター] {#r_ATSP-itemMove_S_S__table_ubb_3g4_15} {#r_ATSP-itemMove_S_S__table_vbb_3g4_15__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 22. 返される内容] {#r_ATSP-itemMove_S_S__table_vbb_3g4_15} ## AbstractTimelineSchedulePage - setDoReRenderTimeline(ブール b) {#ariaid-title13} getItems() 関数を使用してすべてのタイムライン アイテムを再レンダリングするかどうかを指定します。 {#r_ATSP-setDoReRenderTimeline_B__table_kfq_q14_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | b | ブーリアン | true の場合、サーバーの getItems() ハンドラーへの新しいイベント コールを作成してタイムラインを再レンダリングします。 | [表 : 23. パラメーター] {#r_ATSP-setDoReRenderTimeline_B__table_kfq_q14_15} {#r_ATSP-setDoReRenderTimeline_B__table_lfq_q14_15__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 24. 返される内容] {#r_ATSP-setDoReRenderTimeline_B__table_lfq_q14_15} ## AbstractTimelineSchedulePage - setStatusSuccess(String strTitle) {#ariaid-title14} タイムラインのタイトルとして表示するテキストを指定します。 ページ タイトルは、任意のインタラクティブ イベントから設定 (および更新) できます。ただし、getItems() イベント中に設定することをお勧めします {#r_ATSP-setPageTitle_S__table_ifq_q14_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | strTitle | 文字列 | タイムライン タイトルに表示されるテキスト | [表 : 25. パラメーター] {#r_ATSP-setPageTitle_S__table_ifq_q14_15} {#r_ATSP-setPageTitle_S__table_jfq_q14_15__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 26. 返される内容] {#r_ATSP-setPageTitle_S__table_jfq_q14_15} ## AbstractTimelineSchedulePage - setStatusSuccess(String strTitle, String strMessage) {#ariaid-title15} 現在のイベント要求を、指定されたタイトルと GlideTimeline イベント処理のフェーズ 2 に表示するメッセージを指定したエラー ステータスに設定します。 {#r_ATSP-setStatusError_S_S__table_mfq_q14_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | strTitle | 文字列 | ダイアログ ボックスのタイトルに表示されるテキスト | | strMessage | 文字列 | ダイアログ ボックス内に表示されるテキスト。テキストに HTML 書式を含めることができます。 | [表 : 27. パラメーター] {#r_ATSP-setStatusError_S_S__table_mfq_q14_15} {#r_ATSP-setStatusError_S_S__table_nfq_q14_15__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 28. 返される内容] {#r_ATSP-setStatusError_S_S__table_nfq_q14_15} ## AbstractTimelineSchedulePage - setStatusPrompt(文字列 strTitle, 文字列 strOkFunction, 文字列 strCancelFunction, 文字列 strCloseFunction) {#ariaid-title16} 現在のイベント要求を、指定されたタイトルと GlideTimeline イベント処理のフェーズ 2 の間に確認ダイアログ ボックスに表示するメッセージを指定したプロンプト エラー ステータスに設定します。 確認ボックスには、 および ボタンが表示され、各ボタンによりパラメーター引数を指定した関数を呼び出す新しいイベントが生成されます。、、および のカスタム定義関数は、現在のイベントと同じパラメーター引数を受け取ります。 確認ボックスには、 および ボタンが表示され、各ボタンによりパラメーター引数を指定した関数を呼び出す新しいイベントが生成されます。 注: 、、および のカスタム定義関数は、現在のイベントと同じパラメーター引数を受け取ります。 {#r_ATSP-setStatusPrompt_S_S_S_S__table_t3f_tc4_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | strTitle | 文字列 | ダイアログ ボックスに表示するテキスト。テキストに HTML 書式を含めることができます。 | | strOkFunction | 文字列 | ユーザーが ボタンをクリックした場合に、現在のスクリプト インクルード クラスで呼び出す関数 | | strCancelFunction | 文字列 | ユーザーが ボタンをクリックした場合に、現在のスクリプト インクルード クラスで呼び出す関数 | | strCloseFunction | 文字列 | ユーザーが ボタンをクリックした場合に、現在のスクリプト インクルード クラスで呼び出す関数 | [表 : 29. パラメーター] {#r_ATSP-setStatusPrompt_S_S_S_S__table_t3f_tc4_15} {#r_ATSP-setStatusPrompt_S_S_S_S__table_u3f_tc4_15__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 30. 返される内容] {#r_ATSP-setStatusPrompt_S_S_S_S__table_u3f_tc4_15} var MyTimelineScriptIncludeClass = Class.create(); MyTimelineScriptIncludeClass.prototype = Object.extendsObject(AbstractTimelineSchedulePage, { getItems: function() { //... }, elementTimeAdjustEnd: function(spanSysId, newEndDateTimeMs) { // Display a status prompt dialog box this.setStatusPrompt('Confirm Action', 'Are you sure you want to do that?', 'this._myOkHandlerFunction', 'this._myCancelHandlerFunction', 'this._myCloseHandlerFunction'); }, _myOkHandlerFunction: function(spanSysId, newEndDateTimeMs) { // ... }, _myCancelHandlerFunction: function(spanSysId, newEndDateTimeMs) { // ... }, _myCloseHandlerFunction: function(spanSysId, newEndDateTimeMs) { // ... } }; ## AbstractTimelineSchedulePage - setStatusSuccess(文字列 strTitle, 文字列 strMessage) {#ariaid-title17} 現在のイベント要求を、指定されたタイトルと GlideTimelineイベント処理のフェーズ 2 に表示するメッセージを指定した成功ステータスに設定します。 {#r_ATSP-setStatusSuccess_S_S__table_ofq_q14_15__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | strTitle | 文字列 | ダイアログ ボックスのタイトルに表示されるテキスト | | strMessage | 文字列 | ダイアログ ボックス内に表示されるテキスト。テキストに HTML 書式を含めることができます。 | [表 : 31. パラメーター] {#r_ATSP-setStatusSuccess_S_S__table_ofq_q14_15} {#r_ATSP-setStatusSuccess_S_S__table_pfq_q14_15__entry__2} | タイプ | 説明 | |-|-| | なし | | [表 : 32. 返される内容] {#r_ATSP-setStatusSuccess_S_S__table_pfq_q14_15}