TimelineSpan - Global

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 8 minutes to read

    • This class defines a set of properties that describe the characteristics and interactive behavior of an element rendered within a TimelineItem.

    Since it is extremely important for all of a TimelineItem's collection of spans to be unique, the creation of a new instance should be performed via the createTimelineItem method of an existing TimelineIteminstance.

    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.

    Table 1. Parameters
    Name Type Description
    objArray Object Array JavaScript object array that contains two internal properties: relationship_sys_id and predecessor_sys_id.
    Table 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.

    Table 3. Parameters
    Name Type Description
    strPredecessorSysId String The sys ID of the planned task that is the predecessor of the relationship.
    strRelationshipSysId String The sys ID of the relationship of the relationship.
    strTableName String The name of the table for the relationship.
    Table 4. Returns
    Type Description
    void

    TimelineSpan - addPredecessor(String strPredecessorSysId, String strRelationshipSysId)

    Adds the specified relationship between the current instance and another TimelineSpan with sys ID strPredecessorSysId.

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

    Table 5. Parameters
    Name Type Description
    strPredecessorSysId String The sys ID of the planned task that is the predecessor of the relationship.
    strRelationshipSysId String The sys ID of the relationship of the relationship.
    Table 6. Returns
    Type Description
    void

    TimelineSpan - getAllowXDragLeft()

    Returns the boolean value of the AllowXDragLeft property.

    Table 7. Parameters
    Name Type Description
    none
    Table 8. Returns
    Type Description
    Boolean True if the object's start time can be adjusted; False otherwise.

    TimelineSpan - getAllowXDragRight()

    Returns the boolean value of the AllowXDragRight property.

    Table 9. Parameters
    Name Type Description
    none
    Table 10. Returns
    Type Description
    Boolean True if the object's end time can be adjusted; false otherwise.

    TimelineSpan - getAllowXMove()

    Returns the boolean value of the AllowXMove property.

    Table 11. Parameters
    Name Type Description
    none
    Table 12. Returns
    Type Description
    Boolean True if the object can be moved; false otherwise.

    TimelineSpan - getAllowYMove()

    Returns the boolean value of the AllowYMove property.

    Table 13. Parameters
    Name Type Description
    none
    Table 14. Returns
    Type Description
    Boolean True if the object can be moved vertically; false otherwise.

    TimelineSpan - getAllowYMovePredecessor()

    Returns the boolean value of the AllowYMovePredecessor property.

    Table 15. Parameters
    Name Type Description
    none
    Table 16. Returns
    Type Description
    Boolean True if the a dashed relationship line can be drawn from the current object to a new successor; false otherwise.

    TimelineSpan - getInnerSegmentClass()

    Returns the name of the current inner segment class for the TimelineSpan.

    Table 17. Parameters
    Name Type Description
    none
    Table 18. Returns
    Type Description
    String The 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 TimelineSpan .

    Table 19. Parameters
    Name Type Description
    none
    Table 20. Returns
    Type Description
    Number The end time of the TimelineSpan inner segment portion in milliseconds.

    TimelineSpan - getInnerSegmentStartTimeMs()

    Returns the time in milliseconds of the start time of the inner segment portion of the TimelineSpan.

    Table 21. Parameters
    Name Type Description
    none
    Table 22. Returns
    Type Description
    Number The start time of the TimelineSpan inner segment portion in milliseconds.

    TimelineSpan - getIsChanged()

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

    Table 23. Parameters
    Name Type Description
    none
    Table 24. Returns
    Type Description
    Boolean True if the current span has been marked as changed; otherwise false.

    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.

    Table 25. Parameters
    Name Type Description
    none
    Table 26. Returns
    Type Description
    String The name of the icon class to use for displaying the current TimelineSpan 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.

    Table 27. Parameters
    Name Type Description
    none
    Table 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 color specified for displaying this span.

    Table 29. Parameters
    Name Type Description
    none
    Table 30. Returns
    Type Description
    String The 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.

    Note:
    This text will only display if the GlideTimeline object has enabled timeline text via glideTimeline.showTimelineText(true).
    Table 31. Parameters
    Name Type Description
    None
    Table 32. Returns
    Type Description
    String Text displayed adjacent to the element.

    TimelineSpan - getStartTimeMs()

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

    Table 33. Parameters
    Name Type Description
    none
    Table 34. Returns
    Type Description
    Number The start time of the element in 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.

    Table 35. Parameters
    Name Type Description
    none
    Table 36. Returns
    Type Description
    String The unique system ID of the current element.

    TimelineSpan - getTable()

    Returns the name of the table where the sys ID is referenced.

    Table 37. Parameters
    Name Type Description
    none
    Table 38. Returns
    Type Description
    String The table name.

    TimelineSpan - getTooltip()

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

    Table 39. Parameters
    Name Type Description
    none
    Table 40. Returns
    Type Description
    String The 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.

    Table 41. Parameters
    Name Type Description
    bFlag Boolean True to enable the element's start date to be adjusted; false otherwise.
    Table 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.

    Table 43. Parameters
    Name Type Description
    bFlag Boolean True to enable the element's end date to be adjusted; false otherwise.
    Table 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.

    Table 45. Parameters
    Name Type Description
    bFlag Boolean True to enable the element to be moved horizontally; false otherwise.
    Table 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.

    Table 47. Parameters
    Name Type Description
    bFlag Boolean True to enable the element to be moved vertically; false otherwise.
    Table 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.

    Table 49. Parameters
    Name Type Description
    bFlag Boolean True to enable a relationship line to be drawn from this element; false otherwise.
    Table 50. Returns
    Type Description
    void

    TimelineSpan - setInnerSegmentClass(String styleClass)

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

    The default value is green.

    Table 51. Parameters
    Name Type Description
    styleClass String One of the following values: green, blue, or silver.
    Table 52. Returns
    Type Description
    void

    TimelineSpan - setInnerSegmentTimeSpan(Number startTimeMs, Number endTimeMs)

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

    Table 53. Parameters
    Name Type Description
    startTimeMs Number The start time in milliseconds.
    endTimeMs Number The end time in milliseconds.
    Table 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.

    Note:
    This only affects the current TimelineSpan object and will take precedence over the defaultPointIconClass specified by the GlideTimeline.
    Table 55. Parameters
    Name Type Description
    iconClassName String String that specifies one of the following values:
    • milestone
    • blue_square
    • sepia_square
    • green_square
    • red_square
    • black_square
    • blue_circle
    • sepia_circle
    • green_circle
    • red_circle
    • black_circle
    Table 56. Returns
    Type Description
    void

    TimelineSpan - setSpanColor(String strColor)

    Sets the color for displaying this span.

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

    TimelineSpan - setSpanText(String strSpanText)

    Sets the text to display adjacent to the time element.

    Note:
    This text will only be displayed if the GlideTimeline object has enabled timeline text via glideTimeline.showTimelineText(true).
    Table 59. Parameters
    Name Type Description
    strSpanText String The text to display next to the time element.
    Table 60. Returns
    Type Description
    void

    TimelineSpan - setTimeSpan(Number nStartTime, Number nEndTimeMs)

    Sets the start and end dates for the current span.

    Table 61. Parameters
    Name Type Description
    nStartTime Number The start time in milliseconds.
    nEndTimeMs Number The end time in milliseconds.
    Table 62. Returns
    Type Description
    void

    TimelineSpan - setTimeSpan(String strStartTime, String strEndTimeMs)

    Sets the start and end times for the current span.

    Table 63. Parameters
    Name Type Description
    strStartTime String The start time in milliseconds.
    strEndTimeMs String The end time in milliseconds.
    Table 64. Returns
    Type Description
    void

    TimelineSpan - setTooltip(String strTooltipText)

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

    Note:
    You can specify valid HTML in the string that sets the tooltip.
    Table 65. Parameters
    Name Type Description
    strTooltipText String The text to display in the tooltip.
    Table 66. Returns
    Type Description
    void