Defaults to TimelineCfg. Type of the configuration object for this widget.
Creates a new instance of this widget. Please note that you should NOT override this constructor. Instead, override the init method, which is called at the end of the constructor once the instance is created.
The widget configuration to be used for this widget
instance. This widget configuration is usually created on the server by the javax.faces.render.Renderer for
this component.
Callback that is invoked when an event was added to this timeline.
The configuration of this widget instance. Please note that
no property is guaranteed to be present, you should always check for undefined before accessing a property.
This is partly because the value of a property is not transmitted from the server to the client when it equals
the default.
Callback for when an item of the timeline has changed or was moved.
Callback for when an item of the timeline was deleted.
Array of registered listeners invoked when this widget is destroyed. You should normally not use modify this directly, use addDestroyListener instead.
The client-side ID of this widget, with all parent naming containers, such as
myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs
multiple container elements (such as Paginator), this may also be an array if IDs.
When the timeline is move to the right or left, whether that move was initiated by the user.
The current vis-timeline instance.
The jQuery instance of the container element of this widget. In case id is an array, it will contain multiple elements. Please note that some widgets have got not DOM elements at all, in this case this will be an empty jQuery instance.
A CSS selector for the container element (or elements, in case id is an array) of
this widget, This is usually an ID selector (that is properly escaped). You can select the container element or
elements like this: $(widget.jqId).
Whether the lazy loading feature is enabled, which loads events dynamically via AJAX.
If restricting the timeline to a certain range, the upper bound.
If restricting the timeline to a certain range, the lower bound.
The current preload factor, see TimelineCfg.preloadFactor.
Time range of the events that were loaded.
Array of registered listeners invoked when this widget is refreshed. You should normally not use modify this directly, use addRefreshListener instead.
The name of the widget variables of this widget. The widget variable can be used to
access a widget instance by calling PF('myWidgetVar').
Sets up all event listeners for the timeline items.
Sets up all event listeners for the timeline's events.
Main element of this widget.
Creates timeline widget with all initialization steps.
(from super type DeferredWidget) This render method is called by this deferred widget once the widget container has become visible. You may now proceed with widget initialization.
Must be overridden, or an error will be thrown.
Adds a deferred rendering task for the given widget to the queue.
The ID of a deferred widget.
The container element that should be visible.
Callback that is invoked when the widget may possibly have become visible.
Should return true when the widget was rendered, or false when the widget still needs to be rendered
later.
Lets you register a listener that is called before the component is destroyed.
When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. When the element is removed from the DOM by the update, the DOM element is detached from the DOM and all destroy listeners are called. This makes it possible to add listeners from outside the widget code.
If you call this method twice with the same listener, it will be registered twice and later also called twice.
Note that for this to work, you must not override the destroy method; or if you do, call super.
Also, after this widget was detached is done, all destroy listeners will be unregistered.
A destroy listener to be registered.
Adds an event to the timeline.
Properties for the event.
When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. However, no new instance of the widget is created. Instead, after the DOM element was replaced, all refresh listeners are called. This makes it possible to add listeners from outside the widget code.
If you call this method twice with the same listener, it will be registered twice and later also called twice.
Note that for this to work, you must not override the refresh method; or if you do, call super.
Also, after the refresh is done, all refresh listeners will be deregistered. If you added the listeners from
within this widget, consider adding the refresh listeners not only in the init method, but also again in
the refresh method after calling super.
A refresh listener to be registered.
Callback that is invoked when the context menu is initialized. Lets the context menu provider register the appropriate event listeners for when the context menu should be shown and hidden.
The widget instance of the context menu.
The widget instance of the target widget that wants to add a context menu.
ID selector or DOM element of the target, i.e. the element the context menu belongs to.
The current configuration of the context menu.
Each widget may have one or several behaviors attached to it. This method calls all attached behaviors for the given event name. In case no such behavior exists, this method does nothing and returns immediately.
A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.
Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server
and processes the response once it is received. This enables several features such as updating or replacing
elements dynamically. You can add an AJAX behavior via
<p:ajax event="name" actionListener="#{...}" onstart="..." />.
The name of an event to call.
Additional configuration that is passed to the AJAX request for the server-side callback.
Cancels event adding.
Cancels event changing.
Cancels event deleting.
Changes properties of an existing item in the timeline. The provided parameter properties is an object, and can contain parameters "start" (Date), "end" (Date), "content" (String), "group" (String).
Properties for the event.
Deletes all events from the timeline.
Deletes an existing event.
Index of the event.
Cleans up deferred render tasks. When you extend this class and override this method, make sure to call
super.
Fires event for lazy loading.
Each widget may have one or several behaviors attached to it. This method returns the callback function for the given event.
Note: Do not call the method directly, the recommended way to invoke a behavior is via callBehavior.
A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.
Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server
and processes the response once it is received. This enables several features such as updating or replacing
elements dynamically. You can add an AJAX behavior via
<p:ajax event="name" actionListener="#{...}" onstart="..." />.
The name of an event for which to retrieve the behavior.
The behavior with the given name, or null if no such behavior
exists.
Retrieves the array of current data (events) as an JSON string. This method is useful when you done some changes
in timeline and want to send them to server to update the backing model (with pe:remoteCommand and
pe:convertTimelineEvents).
A JSON string with the current data.
Is the event by given id editable?
Index of the event to check.
An object with properties updateTime,
updateGroup and remove.
Retrieves the properties of a single event. The returned object can contain parameters start (Date), end
(Date), content (String), group (String).
0-based index of the item to retrieve.
The event at the given index, or null when no such events exists at the index.
Gets instance of the timeline object.
The current timeline instance.
Each widget has got a container element, this method returns that container. This container element is usually also the element whose ID is the client-side ID of the JSF component.
The jQuery instance representing the main HTML container element of this widget.
Gets time range(s) for events to be lazy loaded.
The internal time range for already loaded events will be updated.
The time range(s) for events to be lazy loaded.
Gets number of events (items in the timeline).
The number of event in the timeline.
Gets the closest parent form for this widget.
A JQuery instance that either contains the form when found, or an empty JQuery instance when the form could not be found.
Gets the closest parent form ID for this widget lazily so it can be used in AJAX requests.
Either the form ID or undefined if no form can be found.
Finds the currently selected event.
The currently selected event, or null when no event is selected.
Gets id of the currently selected event.
The index of the currently selected event, or null if no event
is currently selected.
The currently visible time range of the timeline.
The time range that is currently visible.
Each widget may have one or several behaviors attached to it. This method checks whether this widget has got at least one behavior associated with given event name.
A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.
Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server
and processes the response once it is received. This enables several features such as updating or replacing
elements dynamically. You can add an AJAX behavior via
<p:ajax event="name" actionListener="#{...}" onstart="..." />.
The name of an event to check.
true if this widget has the given behavior, false otherwise.
A widget class should not declare an explicit constructor, the default constructor provided by this base widget should be used. Instead, override this initialize method which is called after the widget instance was constructed. You can use this method to perform any initialization that is required. For widgets that need to create custom HTML on the client-side this is also the place where you should call your render method.
Please make sure to call the super method first before adding your own custom logic to the init method:
PrimeFaces.widget.MyWidget = PrimeFaces.widget.BaseWidget.extend({
init: function(cfg) {
this._super(cfg);
// custom initialization
}
});
The widget configuration to be used for this widget instance.
This widget configuration is usually created on the server by the javax.faces.render.Renderer for this
component.
Checks if this widget is detached, ie whether the HTML element of this widget is currently contained within the DOM (the HTML body element). A widget may become detached during an AJAX update, and it may remain detached in case the update removed this component from the component tree.
true if this widget is currently detached, or false otherwise.
Moves the timeline the given move factor to the left or right. Start and end date will be adjusted, and the timeline will be redrawn.
For example, try a move factor of 0.1 or -0.1. The move factor is a number that determines the moving amount.
A positive value will move right, a negative value will move left.
The parameter options must include an animation property, which can be a boolean or an object of the form
{duration: number, easingFunction: string}.
If true (default) or an object, the range is animated smoothly to the new window. An object can be provided to
specify duration and easing function.
Default duration is 500 ms, and default easing function is easeInOutQuad.
Available easing functions:
lineareaseInQuadeaseOutQuadeaseInOutQuadeaseInCubic,easeOutCubiceaseInOutCubiceaseInQuarteaseOutQuarteaseInOutQuarteaseInQuinteaseOutQuinteaseInOutQuint.The amount to move by. A positive value will move right, a negative value will move left.
Optional settings.
A callback function can be passed as an optional parameter. This function will be called at the end of move operation.
Called after the widget has become visible and after it was rendered. May be overridden, the default implementation is a no-op.
Used in ajax updates, reloads the widget configuration.
When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. However, no new instance of the widget is created. Instead, after the DOM element was replaced, this method is called with the new widget configuration from the server. This makes it possible to persist client-side state during an update, such as the currently selected tab.
Please note that instead of overriding this method, you should consider adding a refresh listener instead via addRefreshListener. This has the advantage of letting you add multiple listeners, and makes it possible to add additional listeners from code outside this widget.
By default, this method calls all refresh listeners, then reinitializes the widget by calling the init
method.
The new widget configuration from the server.
The value as returned by the init method, which is often undefined.
Removes the widget's script block from the DOM. Currently, the ID of this script block consists of the
client-side ID of this widget with the prefix _s, but this is subject to change.
The client-side ID of the widget.
This render method to check whether the widget container is visible. Do not override this method, or the deferred widget functionality may not work properly anymore.
true if the widget container is visible, false or
undefined otherwise.
Force render the timeline component.
Selects an event by its ID. The visible range will be moved, so that the selected event is placed in the middle.
To unselect all events, pass null as the parameter.
Index of the event to select. When negative, unselects all events.
Set the current visible window. The parameters start and end can be a date, number, or string.
If the parameter value of start or end is null, the parameter will be left unchanged.
The parameter options must include an animation property, which can be a boolean or an object of the form
{duration: number, easingFunction: string}.
If true (default) or an object, the range is animated smoothly to the new window. An object can be provided to
specify duration and easing function.
Default duration is 500 ms, and default easing function is easeInOutQuad.
Available easing functions:
lineareaseInQuadeaseOutQuadeaseInOutQuadeaseInCubic,easeOutCubiceaseInOutCubiceaseInQuarteaseOutQuarteaseInOutQuarteaseInQuinteaseOutQuinteaseInOutQuint.Start of the time range.
End of the time range.
Optional settings.
Function A callback function can be passed as an optional parameter. This function
will be called at the end of the setVisibleRange function.
Always returns undefined.
Updates a group of the timeline, adding it if it does not exists.
The provided parameter properties is an object, containing the properties
id (string)content (string)style (string)className (string)order (number)Parameters style, className and order are optional.
The event's properties.
Zooms the timeline the given zoom factor in or out.
The parameter options must include an animation property, which can be a boolean or an object of the form
{duration: number, easingFunction: string}.
If true (default) or an object, the range is animated smoothly to the new window. An object can be provided to
specify duration and easing function.
Default duration is 500 ms, and default easing function is easeInOutQuad.
Available easing functions:
lineareaseInQuadeaseOutQuadeaseInOutQuadeaseInCubic,easeOutCubiceaseInOutCubiceaseInQuarteaseOutQuarteaseInOutQuarteaseInQuinteaseOutQuinteaseInOutQuint.An number between -1 and +1. If positive zoom in, and if negative zoom out.
Optional settings.
A callback function can be passed as an optional parameter. This function will be called at the end of the zooming operation.
Always returns undefined.
Generated using TypeDoc
PrimeFaces Timeline Widget
Timeline is an interactive graph to visualize events in time. Currently uses vis-timeline.