TimelineSpan - Global

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 8 minutes de lecture

    • The TimelineSpan API provides methods to define a set of properties that describe the characteristics and interactive behavior of an element rendered within a time line item.

    Since it is extremely important for all of a time line item's collection of spans to be unique, the creation of a new instance should be performed using the createTimelineItem() method of an existing time line Item instance.

    TimelineSpan - addPredecessor(Object Array objArray)

    Adds multiple relationships between the current instance and other TimelineSpan objects by enumerating through the array of JavaScript objects.

    Each object should have an internal property relationship_sys_id and predecessor_sys_id specified.

    Tableau 1. Parameters
    Name Type Description
    objArray Object Array JavaScript object array that contains two internal properties: relationship_sys_id and predecessor_sys_id.
    Tableau 2. Returns
    Type Description
    void

    TimelineSpan - addPredecessor(String strPredecessorSysId, String strRelationshipSysId, String strTableName)

    Adds the specified relationship between the current instance and another TimelineSpan and allows the relationship to open a GlideWindow to display information about the relationship.

    Tableau 3. Parameters
    Name Type Description
    strPredecessorSysId String Sys_id of the planned task record that is the predecessor of the relationship.
    strRelationshipSysId String Sys_id of the relationship record of the relationship.
    strTableName String Name of the table for the relationship.
    Tableau 4. Returns
    Type Description
    void

    TimelineSpan - addPredecessor(String strPredecessorSysId, String strRelationshipSysId)

    Adds the specified relationship between the current instance and another time line span with sys_id strPredecessorSysId.

    The drawn line will not have any double click handlers associated with it.

    Tableau 5. Parameters
    Name Type Description
    strPredecessorSysId String Sys_id of the planned task record that is the predecessor of the relationship.
    strRelationshipSysId String Sys_id of the relationship record of the relationship.
    Tableau 6. Returns
    Type Description
    void

    TimelineSpan - getAllowXDragLeft()

    Returns the boolean value of the AllowXDragLeft property.

    Tableau 7. Parameters
    Name Type Description
    None
    Tableau 8. Returns
    Type Description
    Boolean Flag that indicates whether the object's start time can be adjusted.
    Valid values:
    • true: Object start time can be adjusted.
    • false: Object start time can't be adjusted.

    TimelineSpan - getAllowXDragRight()

    Returns the boolean value of the AllowXDragRight property.

    Tableau 9. Parameters
    Name Type Description
    None
    Tableau 10. Returns
    Type Description
    Boolean Flag that indicates whether the object's end time can be adjusted.
    Valid values:
    • true: Object end time can be adjusted.
    • false: Object end time can't be adjusted.

    TimelineSpan - getAllowXMove()

    Returns the boolean value of the AllowXMove property.

    Tableau 11. Parameters
    Name Type Description
    None
    Tableau 12. Returns
    Type Description
    Boolean Flag that indicates whether the object can be moved horizontally.
    Valid values:
    • true: Object can be moved horizontally.
    • false: Object can't be moved horizontally.

    TimelineSpan - getAllowYMove()

    Returns the boolean value of the AllowYMove property.

    Tableau 13. Parameters
    Name Type Description
    None
    Tableau 14. Returns
    Type Description
    Boolean Flag that indicates whether the object can be moved vertically.
    Valid values:
    • true: Object can be moved vertically.
    • false: Object can't be moved vertically.

    TimelineSpan - getAllowYMovePredecessor()

    Returns the boolean value of the AllowYMovePredecessor property.

    Tableau 15. Parameters
    Name Type Description
    None
    Tableau 16. Returns
    Type Description
    Boolean Flag that indicates whether the a dashed relationship line can be drawn from the current object to a new successor.
    Valid values:
    • true: Dashed relationship line can be drawn from the current object to a new successor.
    • false: Dashed relationship line can't be drawn from the current object to a new successor.

    TimelineSpan - getInnerSegmentClass()

    Returns the name of the current inner segment class for the time line span.

    Tableau 17. Parameters
    Name Type Description
    None
    Tableau 18. Returns
    Type Description
    String Name of the class for the current inner segment style.

    TimelineSpan - getInnerSegmentEndTimeMs()

    Returns the time in milliseconds of the end time of the inner segment portion of the timeline span.

    Tableau 19. Parameters
    Name Type Description
    None
    Tableau 20. Returns
    Type Description
    Number End time of the timeline span inner segment portion.

    Unit: Milliseconds

    TimelineSpan - getInnerSegmentStartTimeMs()

    Returns the time in milliseconds of the start time of the inner segment portion of the timeline span.

    Tableau 21. Parameters
    Name Type Description
    None
    Tableau 22. Returns
    Type Description
    Number Start time of the timeline span inner segment portion.

    Unit: Milliseconds

    TimelineSpan - getIsChanged()

    Returns a boolean that specifies whether or not the current timeline item has been modified after initialization.

    Tableau 23. Parameters
    Name Type Description
    None
    Tableau 24. Returns
    Type Description
    Boolean Flag that indicates whether the current span has been marked as changed.
    Valid values:
    • true: Marked as changed.
    • false: Not marked as changed.

    TimelineSpan - getPointIconClass()

    Returns a string that specifies the name of the icon class to use for displaying the element on the timeline if the current instance has zero duration.

    Tableau 25. Parameters
    Name Type Description
    None
    Tableau 26. Returns
    Type Description
    String Name of the icon class to use for displaying the current timeline span if the duration is zero.

    TimelineSpan - getPredecessors()

    Returns an array of all the predecessor objects associated with the current instance. Each array object is a HashMap that contains a predecessor_sys_id and relationship_sys_id property.

    Tableau 27. Parameters
    Name Type Description
    None
    Tableau 28. Returns
    Type Description
    Object Array List of HashMaps that contain two internal properties: predecessor_sys_id and relationship_sys_id.

    TimelineSpan - getSpanColor()

    Returns the string name of the background color specified for displaying this span.

    Tableau 29. Parameters
    Name Type Description
    None
    Tableau 30. Returns
    Type Description
    String HTML color name to use as the background color for the element.

    TimelineSpan - getSpanText()

    Returns the string that specifies the text to display adjacent to the time element.

    Remarque :
    This text only displays if the GlideTimeline object has enabled timeline text defined using the glideTimeline.showTimelineText(true) method.
    Tableau 31. Parameters
    Name Type Description
    None
    Tableau 32. Returns
    Type Description
    String Text displayed adjacent to the element.

    TimelineSpan - getStartTimeMs()

    Returns the start time in milliseconds of the current TimelineSpan object.

    Tableau 33. Parameters
    Name Type Description
    None
    Tableau 34. Returns
    Type Description
    Number Start time of the element.

    Unit: Milliseconds

    TimelineSpan - getSysId()

    Returns the sys_id of the current object.

    This method is useful for returning the sys_id when the current object instance was created without a specific sys_id to obtain the dynamically generated GUID.

    Tableau 35. Parameters
    Name Type Description
    None
    Tableau 36. Returns
    Type Description
    String Unique sys_id of the current element.

    TimelineSpan - getTable()

    Returns the name of the table where the sys_id is referenced.

    Tableau 37. Parameters
    Name Type Description
    None
    Tableau 38. Returns
    Type Description
    String Table name.

    TimelineSpan - getTooltip()

    Returns the text/html to display in the tooltip when the TimelineSpan element is being hovered over.

    Tableau 39. Parameters
    Name Type Description
    None
    Tableau 40. Returns
    Type Description
    String Tooltip text.

    TimelineSpan - setAllowXDragLeft(Boolean bFlag)

    Sets a flag that determines whether the element's start date can be dragged left or right therefore adjusting the duration of the task.

    The effect of this behavior is controlled by the script include that handles the appropriate event. The default value for this property is false.

    Tableau 41. Parameters
    Name Type Description
    bFlag Boolean Flag that indicates whether the element's start date can be adjusted.
    Valid values:
    • true: Start date can be adjusted.
    • false: Start date can't be adjusted.
    Tableau 42. Returns
    Type Description
    void

    TimelineSpan - setAllowXDragRight(Boolean bFlag)

    Sets a flag that determines whether the element's end date can be dragged left or right therefore adjusting the duration of the task.

    The effect of this behavior is controlled by the script include that handles the appropriate event. The default value for this property is false.

    Tableau 43. Parameters
    Name Type Description
    bFlag Boolean Flag that indicates whether the element's end date can be adjusted.
    Valid values:
    • true: End date can be adjusted.
    • false: End date can't be adjusted.
    Tableau 44. Returns
    Type Description
    void

    TimelineSpan - setAllowXMove(Boolean bFlag )

    Sets a flag that determines whether the element can be moved to start at a different time.

    The effect of this behavior is controlled by the script include that handles the appropriate event. The default value for this property is false.

    Tableau 45. Parameters
    Name Type Description
    bFlag Boolean Flag that indicates whether the element can be moved horizontally.
    Valid values:
    • true: Element can be moved horizontally.
    • false: Element can't be moved horizontally.
    Tableau 46. Returns
    Type Description
    void

    TimelineSpan - setAllowYMove(Boolean bFlag )

    Sets a flag that determines whether the element can be dragged vertically on the timeline.

    The effect of this behavior is controlled by the script include that handles the appropriate event. The default value for this property is false.

    Tableau 47. Parameters
    Name Type Description
    bFlag Boolean Flag that indicates whether the element can be moved vertically.
    Valid values:
    • true: Element can be moved vertically.
    • false: Element can't be moved vertically.
    Tableau 48. Returns
    Type Description
    void

    TimelineSpan - setAllowYMovePredecessor(Boolean bFlag)

    Sets a flag that determines whether a dashed relationship line can be drawn from this element interactively on the timeline.

    The effect of this behavior is controlled by the script include that handles the appropriate event. The default value for this property is false.

    Tableau 49. Parameters
    Name Type Description
    bFlag Boolean Flag that indicates whether the a dashed relationship line can be drawn from the current object to a new successor.
    Valid values:
    • true: Dashed relationship line can be drawn from the current object to a new successor.
    • false: Dashed relationship line can't be drawn from the current object to a new successor.
    Tableau 50. Returns
    Type Description
    void

    TimelineSpan - setInnerSegmentClass(String styleClass)

    Sets the name of the class to use for stylizing the inner segment if it exists.

    Tableau 51. Parameters
    Name Type Description
    styleClass String Name of the color class to use to stylize the inner segment.
    Valid values:
    • blue
    • green
    • silver
    Default: green
    Tableau 52. Returns
    Type Description
    void

    TimelineSpan - setInnerSegmentTimeSpan(Number startTimeMs, Number endTimeMs)

    Creates an inner segment to show within the current timespan defined by the specified range.

    Tableau 53. Parameters
    Name Type Description
    startTimeMs Number Start time.

    Unit: Milliseconds
    endTimeMs Number End time.

    Unit: Milliseconds
    Tableau 54. Returns
    Type Description
    void

    TimelineSpan - setPointIconClass(String iconClassName)

    Sets the icon class to use for displaying the current element on the timeline if the current instance has zero duration.

    Remarque :
    This only affects the current TimelineSpan object and will take precedence over the defaultPointIconClass specified by the GlideTimeline.
    Tableau 55. Parameters
    Name Type Description
    iconClassName String Icon class to use to display the current element on the timeline if the current instance has zero duration.
    Valid values:
    • black_circle
    • black_square
    • blue_circle
    • blue_square
    • green_circle
    • green_square
    • milestone
    • red_circle
    • red_square
    • sepia_circle
    • sepia_square
    Tableau 56. Returns
    Type Description
    void

    TimelineSpan - setSpanColor(String strColor)

    Sets the color for displaying this span.

    Tableau 57. Parameters
    Name Type Description
    strColor String HTML name for the color of this span.
    Tableau 58. Returns
    Type Description
    void

    TimelineSpan - setSpanText(String strSpanText)

    Sets the text to display adjacent to the time element.

    Remarque :
    This text only displays if the GlideTimeline object has enabled timeline text set using the glideTimeline.showTimelineText(true) method.
    Tableau 59. Parameters
    Name Type Description
    strSpanText String Text to display next to the time element.
    Tableau 60. Returns
    Type Description
    void

    TimelineSpan - setTimeSpan(Number nStartTime, Number nEndTimeMs)

    Sets the start and end dates for the current span.

    Tableau 61. Parameters
    Name Type Description
    nStartTime Number Start time.

    Unit: Milliseconds
    nEndTimeMs Number End time.

    Unit: Milliseconds
    Tableau 62. Returns
    Type Description
    void

    TimelineSpan - setTimeSpan(String strStartTime, String strEndTimeMs)

    Sets the start and end times for the current span.

    Tableau 63. Parameters
    Name Type Description
    strStartTime String Start time.

    Unit: Milliseconds
    strEndTimeMs String End time.

    Unit: Milliseconds
    Tableau 64. Returns
    Type Description
    void

    TimelineSpan - setTooltip(String strTooltipText)

    Sets the text to display in the tooltip when the TimelineSpan element is being hovered over.

    Tableau 65. Parameters
    Name Type Description
    strTooltipText String Text to display in the tooltip.
    Remarque :
    You can specify valid HTML in this string.
    Tableau 66. Returns
    Type Description
    void