| Info | Value |
|---|---|
| Component Type | org.primefaces.component.Timeline |
| Handler Class | None |
| Renderer Type | org.primefaces.component.TimelineRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
id | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
rendered | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
binding | false | javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
widgetVar | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
style | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the container element. |
styleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the container element. |
var | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the request-scoped variable for underlaying object in the TimelineEvent for each iteration. |
value | true | javax.el.ValueExpression
(must evaluate to org.primefaces.model.timeline.TimelineModel)
| An instance of TimelineModel representing the backing model. |
varGroup | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the request-scoped variable for underlaying object in the TimelineGroup for each iteration. |
locale | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| User locale for i18n messages. The attribute can be either a String or Locale object. |
timeZone | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Target time zone to convert start / end dates for displaying. This time zone is the time zone the user would like to see dates in UI. The attribute can be either a String or TimeZone object or null. If null, timeZone defaults to the server's time zone the application is running in. |
browserTimeZone | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Time zone the user's browser / PC is running in. This time zone allows to correct the conversion of start / end dates to the target timeZone for displaying. The attribute can be either a String or TimeZone object or null. Note: browserTimeZone should be provided if the target timeZone is provided. If null, browserTimeZone defaults to the server's timeZone. |
height | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| The height of the timeline in pixels, as a percentage, or "auto". When the height is set to "auto", the height of the timeline is automatically adjusted to fit the contents. If not, it is possible that events get stacked so high, that they are not visible in the timeline. When height is set to "auto", a minimum height can be specified with the option minHeight. Default is "auto". |
minHeight | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Specifies a minimum height for the Timeline in pixels. Useful when height is set to "auto". Default is 0. |
width | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| The width of the timeline in pixels or as a percentage. Default is "100%". |
responsive | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Check if the timeline container is resized, and if so, resize the timeline. Useful when the webpage (browser window) or a layout pane / unit containing the timeline component is resized. Default is true. |
axisOnTop | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If false, the horizontal axis is drawn at the bottom. If true, the axis is drawn on top. Default is false. |
dragAreaWidth | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| The width of the drag areas in pixels. When an event with date range is selected, it has a drag area on the left and right side, with which the start or end dates of the event can be manipulated. Default is 10. |
editable | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, the events can be edited, changed, created and deleted. Events can only be editable when the option selectable is true (default). When editable is true, the timeline can fire AJAX events "change", "edit", "add", "delete", "drop". This global setting "editable" can be overwritten for individual events by setting a value in field "editable". Default is false. |
selectable | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, events on the timeline are selectable. Selectable events can fire AJAX "select" events. Default is true. |
unselectable | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, you can unselect an item by clicking in the empty space of the timeline. If false, you cannot unselect an item, there will be always one item selected. Default is true. |
zoomable | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, the timeline is zoomable. When the timeline is zoomed, AJAX "rangechange" events are fired. Default is true. |
moveable | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, the timeline is movable. When the timeline is moved, AJAX "rangechange" events are fired. Default is true. |
start | false | javax.el.ValueExpression
(must evaluate to java.util.Date)
| The initial start date for the axis of the timeline. If not provided, the earliest date present in the events is taken as start date. Default is null. |
end | false | javax.el.ValueExpression
(must evaluate to java.util.Date)
| The initial end date for the axis of the timeline. If not provided, the latest date present in the events is taken as end date. Default is null. |
min | false | javax.el.ValueExpression
(must evaluate to java.util.Date)
| Set a minimum Date for the visible range. It will not be possible to move beyond this minimum. Default is null. |
max | false | javax.el.ValueExpression
(must evaluate to java.util.Date)
| Set a maximum Date for the visible range. It will not be possible to move beyond this maximum. Default is null. |
zoomMin | false | javax.el.ValueExpression
(must evaluate to java.lang.Long)
| Set a minimum zoom interval for the visible range in milliseconds. It will not be possible to zoom in further than this minimum. Default is 10. |
zoomMax | false | javax.el.ValueExpression
(must evaluate to java.lang.Long)
| Set a maximum zoom interval for the visible range in milliseconds. It will not be possible to zoom out further than this maximum. Default value equals 315360000000000 ms (about 10000 years). |
preloadFactor | false | javax.el.ValueExpression
(must evaluate to java.lang.Float)
| Preload factor is a positive float value or 0 which can be used for lazy loading of events. When the lazy loading feature is active, the calculated time range for preloading will be multiplicated by the preload factor. The result of this multiplication specifies the additional time range which will be considered for the preloading during moving / zooming too. For example, if the calculated time range for preloading is 5 days and the preload factor is 0.2, the result is 5 * 0.2 = 1 day. That means, 1 day backwards and / or 1 day onwards will be added to the original calculated time range. The event's area to be preloaded is wider then. This helps to avoid frequently, time-consuming fetching of events. Default value is 0. |
eventMargin | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| The minimal margin in pixels between events. Default is 10. |
eventMarginAxis | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| The minimal margin in pixels between events and the horizontal axis. Default is 10. |
eventStyle | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies the style for the timeline events. Choose from "dot" or "box". Default is "box". |
groupsChangeable | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, items can be moved from one group to another. Only applicable when groups are used. Default is true. |
groupsOnRight | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If false, the groups legend is drawn at the left side of the timeline. If true, the groups legend is drawn on the right side. Default is false. |
groupsOrder | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Allows to customize the way groups are ordered. When true (default), groups will be ordered by content alphabetically (when the list of groups is missing) or by native ordering of TimelineGroup object in the list of groups (when the list of groups is available). When false, groups will not be ordered at all. |
groupsWidth | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| By default, the width of the groups legend is adjusted to the group names. A fixed width can be set for the groups legend by specifying the "groupsWidth" as a string, for example "200px". Default is null. |
groupMinHeight | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| The minimum height of each individual group even if they have no items. The group height is set as the greatest value between items height and the groupMinHeight. Default is 0. |
snapEvents | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, the start and end of an event will be snapped nice integer values when moving or resizing the event. Default is true. |
stackEvents | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, the events are stacked above each other to prevent overlapping events. Default is true. |
showCurrentTime | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, the timeline shows a red, vertical line displaying the current time. Default is true. |
showMajorLabels | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| By default, the timeline shows both minor and major date labels on the horizontal axis. For example the minor labels show minutes and the major labels show hours. When "showMajorLabels" is false, no major labels are shown. Default is true. |
showMinorLabels | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| By default, the timeline shows both minor and major date labels on the horizontal axis. For example the minor labels show minutes and the major labels show hours. When "showMinorLabels" is false, no minor labels are shown. When both "showMajorLabels" and "showMinorLabels" are false, no horizontal axis will be visible. Default is true. |
showButtonNew | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Show the button "Create new event" in the a navigation menu. Default is false. |
showNavigation | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Show a navigation menu with buttons to move and zoom the timeline. Default is false. |
timeChangeable | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If false, items can not be moved or dragged horizontally (neither start time nor end time is changable). This is useful when items should be editable but can only be changed regarding group or content (typical use case: scheduling events). Default is true. |
dropHoverStyleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style class to apply when an acceptable draggable is dragged over. Default is null. |
dropActiveStyleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style class to apply when an acceptable draggable is being dragged over. Default is null. |
dropAccept | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Selector to define the accepted draggables. Default is null. |
dropScope | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Scope key to match draggables and droppables. Default is null. |
animate | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true, events are moved animated when resizing or moving them. This is very pleasing for the eye, but does require more computational power. Default is true. |
animateZoom | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true, events are moved animated when zooming the Timeline. This looks cool, but does require more computational power. Default is true. |
Output generated by Vdldoc View Declaration Language Documentation Generator.