GRAFFITITIMELINE - GRAFFITISUITE DOCS

# GraffitiTimeline Class Inherits GraffitiWebUIControl ## About GraffitiTimeline is a powerful timeline display component designed to allow your users to view tasks in a time-oriented mechanism. ## Compatibility ### Framework API Version | 1.0 | 2.0 | | :---: | :---: | | True | True | ### Web | 32-Bit | 64-Bit | | :---: | :---: | | True | True | ## Enumerations | Name | Value | Description | | --- | :---: | --- | | Alignments | Default Center Left Right | Supported alignments. | | AxisOrientations | Bottom Top Both None | Supported axis orientations. | | HeightModes | Auto Fixed FitItems | Supported height models. | | ItemOrientations | Bottom Top | Supported item orientations. | | SupportedLocales | en en_US en_GB it it_IT it_CH nl nl_NL nl_BE de de_DE fr fr_FR fr_CA fr_BE uk uk_UA ru ru_RU pl pl_PL es es_ES ja ja_JP | Supported languages or locales. | | TimeScales | None Year Month Week Weekday Day Hour Minute Second | Supported timescales. | ## Event Definitions | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | AxisRightClick | atDate as Date X as Integer Y as Integer | (None) | Raised when the user right-clicks one of the axes. | | BarMoved | bar as GraffitiTimelineBar | (None) | Raised when the user drags a bar to a new position. | | GroupBackgroundRightClick | group as GraffitiTimelineGroup atDate as Date pageX as Integer pageY as Integer | (None) | Raised when use right-clicks the background of a group. | | GroupLabelRightClick | group as GraffitiTimelineGroup X as Integer Y as Integer | (None) | Raised when the user right-clicks a group label. | | GroupsOrderChange | (None) | (None) | Raised when the user has reordered groups. | | ItemAction | item as GraffitiTimelineItem | (None) | Raised when the user clicks on an item. | | ItemMoved | item as GraffitiTimelineItem | (None) | Raised when the user has moved an item on the timeline. | | ItemRemoved | item as GraffitiTimelineItem | (None) | Raised when the user removes an item by clicking the X button. | | ItemRightClick | item as GraffitiTimelineItem pageX as Integer pageY as Integer | (None) | Raised when user right-clicks an item on the timeline. | | ItemSelectionChange | selectedItems() as GraffitiTimelineItem | (None) | Raised when the user has altered the selected items in the display. | | Open | (None) | (None) | (None) | | RightClick | atDate as Date pageX as Integer pageY as Integer | (None) | Raised when the user right-clicked a part of the timeline that does not contain a group or item. | | Shown | (None) | (None) | (None) | | TimeAction | atDate as Date toGroup as GraffitiTimelineGroup | (None) | Raised when user clicks an area of the timeline that does not contain an item. | | ViewChanged | (None) | (None) | Raised when the user has change the viewable area range by scrolling, dragging, or zooming. | ## Methods | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | AddBar | newBar as GraffitiTimelineBar | (None) | Adds a new bar to the timeline. | | AddGroup | newGroup as GraffitiTimelineGroup | (None) | Adds a new group to the timeline. | | AddItem | newItem as GraffitiTimelineItem | (None) | Adds a new item to the timeline. | | AddRestriction | newRestriction as GraffitiTimelineRestriction | (None) | Adds a new restriction to the timeline. | | BarAt | index as Integer | GraffitiTimelineBar | Returns the bar at the specified index. | | DeslectAll | (None) | (None) | Deselects all items. | | GroupAt | Index as Integer | GraffitiTimelineGroup | Returns the group at the specified index. | | ItemAt | Index as Integer | GraffitiTimelineItem | Returns the item at the specified index. | | LastBarIndex | (None) | Integer | Returns the index of the final bar added. | | LastGroupIndex | (None) | Integer | Returns the index of the final group added. | | LastItemIndex | (None) | Integer | Returns the index of the final item added. | | LastRestrictionIndex | (None) | Integer | Returns the index of the final restriction added. | | Print | (None) | (None) | Initiates a print-safe preview of the Timeline's current view. | | Redraw | (None) | (None) | Force a UI update. | | RemoveAllBars | (None) | (None) | Removes all bars from the component. | | RemoveAllGroups | (None) | (None) | Removes all groups from the component. | | RemoveAllItems | (None) | (None) | Removes all items from the component. | | RemoveAllRestrictions | (None) | (None) | Removes all restrictions from the component. | | RemoveBar | BarToRemove as GraffitiTimelineBar | (None) | Removes the specified bar. | | RemoveGroup | GroupToRemove as GraffitiTimelineGroup RemoveAllItems as Boolean = True | (None) | Removes the specified group. | | RemoveItem | ItemToRemove as GraffitiTimelineItem | (None) | Removes the specified item. | | RemoveRestriction | RestrictionToRemove as GraffitiTimelineRestriction | (None) | Removes the specified restriction. | | RestrictionAt | index as Integer | GraffitiTimelineRestriction | Returns the restriction at the specified index. | | ShowAll | (None) | (None) | Scroll and Zoom the display to fit all items. | | ShowItem | ItemToShow as GraffitiTimelineItem | (None) | Scroll and Zoom the display to show the specified item. | | ShowTime | TimeToShow as Date | (None) | Scroll and Zoom the display to show the specified date object's value. | | ZoomIn | Percentage as Integer | (None) | Zoom the display in by the supplied percentage value. | | ZoomOut | Percentage as Integer | (None) | Zoom the display out by the supplied percentage value. | ## Properties | Name | Type | Default Value | Description | | --- | :---: | :---: | --- | | Alignment | Alignments | (None) | Alignment of items with type 'box', 'range', and 'background'. | | CanAddItem | Boolean | (None) | When True, users are able to add items by interacting with the component. | | CanMove | Boolean | (None) | Specifies whether the Timeline can be moved and zoomed by dragging the window. | | CanMultiselect | Boolean | (None) | When True, users can select multiple items. | | CanMultiselectGroup | Boolean | (None) | When True, users can select multiple groups. | | CanOrderGroups | Boolean | (None) | When True users can drag groups to reorder them. | | CanRemoveGroup | Boolean | (None) | When True, users can remove groups by interacting with the UI. | | CanSelect | Boolean | (None) | When True, users can select items by clicking on them. | | CanZoom | Boolean | (None) | When True, users can zoom the display by interacting with it. | | CanZoomMouse | Boolean | (None) | When True, users can zoom the display using the mouse wheel. | | DateMaximum | Date | (None) | The maximum date and time that can be displayed. | | DateMinimum | Date | (None) | The minimum date and time that can be displayed. | | DisplayLocale | SupportedLocales | (None) | Current display locale. | | HeightMode | HeightModes | (None) | Vertical sizing of the timeline display within the component. | | MarginAxis | Integer | (None) | Distance between axis points. | | MarginItemHorizontal | Integer | (None) | Margin for horizontal item display. | | MarginItemVertical | Integer | (None) | Margin for vertical item display. | | OrientationAxis | AxisOrientations | (None) | Orientation of axis display. | | OrientationItem | ItemOrientations | (None) | Orientation of items relative to the axis. | | OverrideItemEdit | Boolean | (None) | When True, item edit properties are overridden in favor of those on the Timeline instance. | | RollingMode | Boolean | (None) | When True, the timeline display will shift continuously to display the current date/time at center. | | RollingModeOffset | Integer | (None) | Set how far from the left the rolling mode is implemented from. Percentage value (0-100). | | ShowCurrentTime | Boolean | (None) | When True, displays a bar at the current date/time that the user cannot interact with. | | ShowHelpTags | Boolean | (None) | When the mouse is hovered of an item with a helptag, it will be displayed if this value is true. | | ShowMajorLabels | Boolean | (None) | Determines whether major labels, such as the day, are displayed. | | ShowMinorLabels | Boolean | (None) | Determines whether minor labels, such as seconds, are displayed. | | StyleAxisGroups | GraffitiStyle | (None) | GraffitiStyle to apply to the group axis. | | StyleAxisTime | GraffitiStyle | (None) | GraffitiStyle to apply to the time axis. | | StyleColumnsEven | GraffitiStyle | (None) | GraffitiStyle to apply to even major labeled columns in the display. | | StyleColumnsOdd | GraffitiStyle | (None) | GraffitiStyle to apply to odd major labeled columns in the display. | | StyleDayToday | GraffitiStyle | (None) | GraffitiStyle to apply to the current date column. | | StyleDayTomorrow | GraffitiStyle | (None) | GraffitiStyle to apply to the column for tomorrow. | | StyleWeekdayFriday | GraffitiStyle | (None) | GraffitiStyle to apply to the specified day of the week. | | StyleWeekdayMonday | GraffitiStyle | (None) | GraffitiStyle to apply to the specified day of the week. | | StyleWeekdaySaturday | GraffitiStyle | (None) | GraffitiStyle to apply to the specified day of the week. | | StyleWeekdaySunday | GraffitiStyle | (None) | GraffitiStyle to apply to the specified day of the week. | | StyleWeekdayThursday | GraffitiStyle | (None) | GraffitiStyle to apply to the specified day of the week. | | StyleWeekdayTuesday | GraffitiStyle | (None) | GraffitiStyle to apply to the specified day of the week. | | StyleWeekdayWednesday | GraffitiStyle | (None) | GraffitiStyle to apply to the specified day of the week. | | TimeAxisScale | TimeScales | (None) | Granularity of the time display. When set to anything other than None , scaling on zoom will be disabled. | | TimeAxisStep | Integer | (None) | Interval used for the TimeAxisScale. | | ViewEnd | Date | (None) | The current maximum viewable date in the display. | | ViewStart | Date | (None) | The current minimum viewable date in the display. |