GlideTimeline - グローバル

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：18分

    • GlideTimeline API は、Glide ウィンドウツールキットのタイムラインを構成および表示するためのコア実装を提供します。

    セキュリティ上の理由から、GlideTimeline は GlideTimeline という単一のインスタンス変数としてすでにインスタンス化されています。すべての設定は、このインスタンス変数を参照する対応するスケジュールページのクライアントスクリプトセクションで行う必要があります。

    GlideTimeline - groupByParent(ブーリアン b)

    タイムラインアイテムを親別にグループ化するかどうかを指定します。 [true] の場合、すべての子アイテムが親内にネストされます。これは表示順序に影響し、子は常に親の直後にリストされます。groupByParent プロパティのデフォルト値は [false] です。

    [true] の場合、すべての子アイテムが親内にネストされます。これは表示順序に影響し、子は常に親の直後にリストされます。groupByParent プロパティのデフォルト値は [false] です。

    表 : 1. パラメーター
    名前 タイプ 説明
    b ブーリアン [true] の場合、親別にグループ化されたタイムラインアイテムを表示します。
    表 : 2. 返される内容
    タイプ 説明
    なし 
    glideTimeline.groupByParent(true);

    GlideTimeline - registerEvent(文字列 strServerEvent, 文字列 strScriptIncludeName)

    指定されたタイムラインサーバーイベントを登録します。 登録が正しく機能するためには、strServerEvent が許可されたイベントの 1 つである必要があります。イベントが発生すると、GlideTimeline はサーバーに要求を送信し、strScriptIncludeName クラス内で処理されたイベントを処理します。

    登録が正しく機能するためには、strServerEvent が許可されたイベントの 1 つである必要があります。イベントが発生すると、GlideTimeline はサーバーに要求を送信し、strScriptIncludeName クラス内で処理されたイベントを処理します。

    表 : 3. パラメーター
    名前 タイプ 説明
    strServerEvent 文字列 大文字と小文字を区別する次のいずれかのイベントを指定します。
    • getItems
    • elementMoveX
    • elementMoveY
    • elementMoveXY
    • elementSuccessor
    • elementTimeAdjustStart
    • elementTimeAdjustEnd
    • inputBox
    • itemMove
    strScriptIncludeName 文字列 strServerEvent を受け取るクラスの名前を指定します。このクラスは、AbstractTimelineSchedulePage を拡張するスクリプトインクルードで定義する必要があります。
    表 : 4. 返される内容
    タイプ 説明
    なし 
    glideTimeline.registerEvent("getItems", "TimelineGanttSchedulePage");

    GlideTimeline - setAutoRefresh(数値 intSeconds)

    タイムライン上のデータの自動リフレッシュを実行するまで待機する秒数を指定します。 秒数を 0 に設定すると、自動リフレッシュがオフになります。デフォルトでは、自動リフレッシュは無効になっています。intSeconds が 0 より大きく、最小許容時間 (10) より小さい場合は、10 秒に設定されます。

    秒数を 0 に設定すると、自動リフレッシュがオフになります。デフォルトでは、自動リフレッシュは無効になっています。intSeconds が 0 より大きく、最小許容時間 (10) より小さい場合は、10 秒に設定されます。

    表 : 5. パラメーター
    名前 タイプ 説明
    intSeconds 数値 自動リフレッシュの間隔を秒単位で指定する整数。
    表 : 6. 返される内容
    タイプ 説明
    なし 
    glideTimeline.setAutoRefresh(15); // Sets the interval for auto-refreshing to 15 seconds.

    GlideTimeline - setDefaultPointIconClass(文字列 icon_class)

    サーバーから返されたタイムラインスパンのプロパティにアイコンクラスが明示的に指定されていない場合、期間がゼロのタイムラインスパンに使用するデフォルトのアイコンクラスを指定します。 setDefaultPointIconClass プロパティのデフォルト値は milestone です。

    setDefaultPointIconClass プロパティのデフォルト値は milestone です。

    表 : 7. パラメーター
    名前 タイプ 説明
    icon_class 文字列 次のいずれかの値を指定する文字列。
    • milestone
    • blue_square
    • sepia_square
    • green_square
    • red_square
    • black_square
    • blue_circle
    • sepia_circle
    • green_circle
    • red_circle
    • black_circle
    表 : 8. 返される内容
    タイプ 説明
    なし 
    glideTimeline.setDefaultPointIconClass('blue_circle');

    GlideTimeline - setExtraAjaxParam(文字列 strName, 文字列 strValue)

    getParameter() メソッドを使用して、対応するスクリプトインクルードイベントで使用できるように、クライアントスクリプトの追加パラメーターを設定できます。 sysparm_timeline_ のプリフィックスが付いた URI パラメーターは、すべてのサーバー側 AJAX 呼び出しに自動的に含まれます。

    sysparm_timeline_ のプリフィックスが付いた URI パラメーターは、すべてのサーバー側 AJAX 呼び出しに自動的に含まれます。

    表 : 9. パラメーター
    名前 タイプ 説明
    strName 文字列 URI パラメーター名。
    strValue 文字列 strName の値。
    表 : 10. 返される内容
    タイプ 説明
    なし 
    glideTimeline.setExtraAjaxParam("sysparm_timeline_limit", "5");

    GlideTimeline - setInitialViewRange(文字列 objStartDate, 文字列 objEndDate)

    タイムラインの初期表示可能な範囲を指定します。 開始日と終了日の形式は、デフォルトのタイムスタンプ形式 (yyyy-MM-dd HH:mm:ss) にする必要があります。デフォルトの範囲は、最も早いタイムラインスパンポイントから最新のタイムラインスパンまでを指定する範囲です。initialViewRange プロパティを指定すると、デフォルトの範囲が上書きされます。

    開始日と終了日の形式は、デフォルトのタイムスタンプ形式 (yyyy-MM-dd HH:mm:ss) にする必要があります。デフォルトの範囲は、最も早いタイムラインスパンポイントから最新のタイムラインスパンまでを指定する範囲です。initialViewRange プロパティを指定すると、デフォルトの範囲が上書きされます。

    表 : 11. パラメーター
    名前 タイプ 説明
    objStartDate 文字列 yyyy-MM-dd HH:mm:ss 形式の表示範囲の開始時間。
    objEndDate 文字列 yyyy-MM-dd HH:mm:ss 形式の表示範囲の終了時間。
    表 : 12. 返される内容
    タイプ 説明
    なし 
    // Sets the initial range to begin on June 20th, 2010 at 8:00 AM and end on June 28th, 2010 at 2:00 PM UTC time.
      glideTimeline.setInitialViewRange("2010-06-20 08:00:00", "2010-06-28 14:00:00");

    GlideTimeline - setInitialViewRange(数値 objStartDate, 数値 objEndDate)

    タイムラインの初期表示可能な範囲を指定します。 デフォルトの範囲は、最も早いタイムラインスパンポイントから最新のタイムラインスパンまでを指定する範囲です。initialViewRange プロパティを指定すると、デフォルトの範囲が上書きされます。

    デフォルトの範囲は、最も早いタイムラインスパンポイントから最新のタイムラインスパンまでを指定する範囲です。initialViewRange プロパティを指定すると、デフォルトの範囲が上書きされます。

    表 : 13. パラメーター
    名前 タイプ 説明
    objStartDate 数値 表示範囲の開始時刻 (ミリ秒)。
    objEndDate 数値 終了時間 (ミリ秒)。
    表 : 14. 返される内容
    タイプ 説明
    なし 
    // Sets the initial range to begin on June 20th, 2010 at 8:00 AM and end on June 28th, 2010 at 2:00 PM UTC time.
      glideTimeline.setInitialViewRange(1277046000000, 1277647200000);

    GlideTimeline - setInitialViewRange(文字列 objStartDate, 数値 objEndDate)

    タイムラインの初期表示可能な範囲を指定します。 デフォルトの範囲は、最も早いタイムラインスパンポイントから最新のタイムラインスパンまでを指定する範囲です。initialViewRange プロパティを指定すると、デフォルトの範囲が上書きされます。

    デフォルトの範囲は、最も早いタイムラインスパンポイントから最新のタイムラインスパンまでを指定する範囲です。initialViewRange プロパティを指定すると、デフォルトの範囲が上書きされます。

    表 : 15. パラメーター
    名前 タイプ 説明
    objStartDate 文字列 yyyy-MM-dd HH:mm:ss 形式の表示範囲の開始時間。
    objEndDate 数値 終了時間 (ミリ秒)。
    表 : 16. 返される内容
    タイプ 説明
    なし

    ExampleExplanation

    // Sets the initial range to begin on June 20th, 2010 at 8:00 AM and end on June 28th, 2010 at 2:00 PM UTC time.
      glideTimeline.setInitialViewRange("2010-06-20 08:00:00", 1277647200000);

    GlideTimeline - setInitialViewRange(数値 objStartDate, 文字列 objEndDate)

    タイムラインの初期表示可能な範囲を指定します。 デフォルトの範囲は、最も早いタイムラインスパンポイントから最新のタイムラインスパンまでを指定する範囲です。initialViewRange プロパティを指定すると、デフォルトの範囲が上書きされます。

    デフォルトの範囲は、最も早いタイムラインスパンポイントから最新のタイムラインスパンまでを指定する範囲です。initialViewRange プロパティを指定すると、デフォルトの範囲が上書きされます。

    表 : 17. パラメーター
    名前 タイプ 説明
    objStartDate 数値 表示範囲の開始時刻 (ミリ秒)。
    objEndDate 文字列 yyyy-MM-dd HH:mm:ss 形式の表示範囲の終了時間。
    表 : 18. 返される内容
    タイプ 説明
    なし

    ExampleExplanation

    // Sets the initial range to begin on June 20th, 2010 at 8:00 AM and end on June 28th, 2010 at 2:00 PM UTC time.
      glideTimeline.setInitialViewRange(1277046000000, "2010-06-28 14:00:00");

    GlideTimeline - setReadOnly(ブーリアン b)

    すべてのタイムラインイベントのインタラクションを有効または無効にします。 有効にすると、各 Timeline アイテムで指定された対応する属性からイベントインタラクションが決定されます。readOnly プロパティのデフォルト値は [false] です。

    有効にすると、各 Timeline アイテムで指定された対応する属性からイベントインタラクションが決定されます。readOnly プロパティのデフォルト値は [false] です。

    表 : 19. パラメーター
    名前 タイプ 説明
    b ブーリアン [true] の場合、タイムライン全体を [読み取り専用] (非インタラクティブ) としてマークします。
    表 : 20. 返される内容
    タイプ 説明
    なし 
    glideTimeline.setReadOnly(true);

    GlideTimeline - showDependencyLines(ブーリアン b)

    タイムラインスパン間の依存関係行を表示するかどうかを指定します。 このメソッドは、サーバーから返されたタイムラインアイテムのセットに依存関係が含まれている場合にのみ適用されます。showDependencyLines プロパティのデフォルト値は [false] です。

    このメソッドは、サーバーから返されたタイムラインアイテムのセットに依存関係が含まれている場合にのみ適用されます。showDependencyLines プロパティのデフォルト値は [false] です。

    表 : 21. パラメーター
    名前 タイプ 説明
    b ブーリアン [true] の場合、タイムラインに依存関係行を表示します。それ以外の場合は表示しません。
    表 : 22. 返される内容
    タイプ 説明
    なし 
    glideTimeline.showDependencyLines(true);

    GlideTimeline - showGridLines(ブーリアン bShowGridlines, 数値 amount)

    タイムライン上のデータの各行にグリッド線を表示するかどうかを指定します。 デフォルトでは、グリッド線は有効です。

    デフォルトでは、グリッド線は有効です。

    表 : 23. パラメーター
    名前 タイプ 説明
    bShowGridlines ブーリアン [true] の場合、タイムラインにグリッド線が表示されます。それ以外の場合、グリッド線は表示されません。
    amount 数値 amount
    表 : 24. 返される内容
    タイプ 説明
    なし ReturnValue 
    glideTimeline.showGridLines(false); // Disables grid lines.

    GlideTimeline - showLeftPane(ブーリアン b)

    タイムラインの左側のペインを表示するかどうかを指定します。 leftPane プロパティのデフォルト値は [true] です。

    leftPane プロパティのデフォルト値は [true] です。

    表 : 25. パラメーター
    名前 タイプ 説明
    b ブーリアン [true] の場合、タイムラインには左ペインが表示されます。それ以外の場合、左ペインは表示されません。
    表 : 26. 返される内容
    タイプ 説明
    なし 
    glideTimeline.showLeftPane(false);

    GlideTimeline - showLeftPaneAsTree(ブーリアン b)

    タイムラインの左ペインに子アイテムを表示する方法を指定します。子アイテムは、展開と折りたたみ機能を備えたネストされインデントされたノードとして、または単一のインデントレベルで表示されます。 showLeftPaneAsTree プロパティのデフォルト値は [false] です。

    showLeftPaneAsTree プロパティのデフォルト値は [false] です。

    表 : 27. パラメーター
    名前 タイプ 説明
    b ブーリアン [true] の場合、子アイテムノードは展開/折りたたみ機能としてインデントされて表示されます。それ以外の場合は、左ペインのすべてのアイテムが 1 つのインデントレベルで表示されます。
    表 : 28. 返される内容
    タイプ 説明
    なし 
    glideTimeline.showLeftPaneAsTree(true);

    GlideTimeline - showLeftPaneInputBox(ブーリアン b, 文字列 strDefaultValue)

    左ペインの下部に、strDefaultValue で指定されたデフォルト値を含むテキスト入力ボックスを表示するかどうかを指定します。 showLeftPane() を使用して左ペインを無効にすると、入力ボックスは表示されません。showLeftPaneInputBox プロパティのデフォルト値は [false] です。

    showLeftPane() を使用して左ペインを無効にすると、入力ボックスは表示されません。showLeftPaneInputBox プロパティのデフォルト値は [false] です。

    表 : 29. パラメーター
    名前 タイプ 説明
    b ブーリアン [true] の場合、左ペインの入力ボックスを表示します。
    strDefaultValue 文字列 入力ボックスに表示するデフォルト値。
    表 : 30. 返される内容
    タイプ 説明
    なし 
    glideTimeline.showLeftPaneInputBox(true, 'Add a new task ...');

    GlideTimeline - showSummaryPane(ブーリアン b)

    タイムラインの下部でサマリーペインを表示するかどうかを指定します。 showSummaryPane プロパティのデフォルト値は [true] です。

    showSummaryPane プロパティのデフォルト値は [true] です。

    表 : 31. パラメーター
    名前 タイプ 説明
    b ブーリアン [true] の場合、タイムラインにはサマリーペインが含まれます。それ以外の場合、サマリーペインは表示されません。
    表 : 32. 返される内容
    タイプ 説明
    なし 
    glideTimeline.showSummaryPane(false);

    GlideTimeline - showTimelineText(ブーリアン b)

    プライマリタイムラインペインの各タイムラインスパンの下にタイムラインテキストを表示するかどうかを指定します。 showTimelineText プロパティのデフォルト値は [false] です。

    showTimelineText プロパティのデフォルト値は [false] です。

    表 : 33. パラメーター
    名前 タイプ 説明
    b ブーリアン [true] の場合、各タイムラインスパンの下に説明テキストが表示されます。それ以外の場合、各タイムラインスパンの下にテキストは表示されません。
    表 : 34. 返される内容
    タイプ 説明
    なし 
    glideTimeline.showTimelineText(true);

    GlideTimeline - snapVertScrollingIntoRows(ブーリアン b)

    タイムラインスパンオブジェクト (このイベントを実行するように適切に登録されている場合) の垂直移動を最も近い行にスナップして調整するかどうかを指定します。 デフォルトでは、この値は有効になっています。

    デフォルトでは、この値は有効になっています。

    表 : 35. パラメーター
    名前 タイプ 説明
    b ブーリアン [true] の場合、タイムラインスパンオブジェクトの垂直移動を行にスナップします。それ以外の場合、アイテムはマウスを基準にして正確に移動します。
    表 : 36. 返される内容
    タイプ 説明
    なし 
    glideTimeline.snapVertScrollingIntoRows(false);

    GlideTimeline -sortByLeftLabelText(ブーリアン b)

    アイテムをその左のラベルテキスト別にグループ化するかどうかを指定します。 sortByLeftLabelText プロパティのデフォルト値は [false] です。

    sortByLeftLabelText プロパティのデフォルト値は [false] です。

    表 : 37. パラメーター
    名前 タイプ 説明
    b ブーリアン [true] の場合、各アイテムの左ラベルで指定されたテキストでタイムラインアイテムをアルファベット順にソートします。
    表 : 38. 返される内容
    タイプ 説明
    なし 
    glideTimeline.sortByLeftLabelText(true);

    GlideTimeline - sortByStartDate(ブーリアン b)

    返されたタイムラインアイテムのリストを、アイテムのタイムラインスパンオブジェクトの最も早い開始日でソートするかどうかを指定します。 groupByParent() が [true] に設定されている場合、グループ化が行われた後にアイテムがソートされます。sortByStartDate プロパティのデフォルト値は [false] です。

    groupByParent() が [true] に設定されている場合、グループ化が行われた後にアイテムがソートされます。sortByStartDate プロパティのデフォルト値は [false] です。

    表 : 39. パラメーター
    名前 タイプ 説明
    b ブーリアン [true] の場合、タイムラインアイテムを最も早い開始日から時系列にソートします。
    表 : 40. 返される内容
    タイプ 説明
    なし 
    glideTimeline.sortByStartDate(true);

    GlideTimeline - sortByTimelineLabelText(ブーリアン b)

    タイムラインペインに表示するように指定されたテキストに従って、返されたタイムラインアイテムのリストをアルファベット順でソートするかどうかを指定します。

    注:
    このソート順は、showTimelineText() メソッドでタイムラインテキストが [false] に設定されている場合でも適用されます。さらに、groupByParent() が [true] に設定されている場合、アイテムはグループ化が行われた後にアルファベット順でソートされます。

    sortByTimelineLabelText プロパティのデフォルト値は [false] です。

    表 : 41. パラメーター
    名前 タイプ 説明
    b ブーリアン [true] の場合、各アイテムのタイムラインスパンテキストで指定されたテキストでタイムラインアイテムをアルファベット順にソートします。
    表 : 42. 返される内容
    タイプ 説明
    なし 
    glideTimeline.sortByTimelineLabelText(true);