Namespace: PP.Ui;
PlacedControlBase
Timeline
The Timeline class implements timeline.
PP.initClass(PP.Ui.Timeline, PP.Ui.PlacedControlBase, "PP.Ui.Timeline");
Constructor name | Brief description | |
Timeline | The Timeline constructor creates an instance of the Timeline class. |
Property name | Brief description | |
CurrentStep | The CurrentStep property sets and returns index of the current animation step. | |
DelayDuration | The DelayDuration property sets and returns animation delay in milliseconds. | |
Inverse | The Inverse property determines direction of timeline steps. | |
LastIndexAsInitial | The LastIndexAsInitial property determines whether the first or the last timeline step is selected as an initial one. | |
ReturnToInitialState | The ReturnToInitialState property determines whether timeline returns to initial state. | |
ScrollSpeed | The ScrollSpeed property sets timeline scroll speed. | |
StepDuration | The StepDuration property sets and returns animation step duration in milliseconds. | |
StepsNames | The StepsNames property sets and returns array of animation step names. | |
StepsVisibility | The StepsVisibility property sets and returns array of indications of animation steps visibility. | |
TickIndex | The TickIndex property sets and returns index of the current animation step. | |
Ticks | The Ticks property sets and returns array of animation step names. | |
ValueChangedWithTimeout | The ValueChangedWithTimeout property sets and returns whether the current timeline step changes with time. |
Method name | Brief description | |
addTick | The addTick method adds a tick mark to to timeline. | |
beginUpdate | The beginUpdate method disables rerendering of timeline until the endUpdate method is called. | |
endUpdate | The endUpdate method enables rerendering of timeline and refreshes it. | |
getIsStarted | The getIsStarted method determines whether animation is started. | |
pause | The pause method pauses timeline animation. | |
play | The play method starts playing timeline animation. | |
refresh | The refresh method refreshes timeline. | |
removeTick | The removeTick method removes tick mark from timeline by name or index. | |
resume | The resume method resumes timeline animation after it was paused. | |
stop | The stop method stops timeline animation. |
Event name | Brief description | |
Finished | The Finished event occurs when timeline animation is finished. | |
Paused | The Paused event occurs when timeline animation is paused. | |
Started | The Started event occurs when timeline animation is started. | |
TicksChanged | The TicksChanged event occurs after changing timeline tick marks. | |
TicksChanging | The TicksChanging event occurs on changing timeline tick marks. | |
ValueChanged | The ValueChanged event occurs after changing the current timeline step during animation. |
Property name | Brief description | |
Anchors | The Anchors property determines position of the component placed within container. | |
Animation | The Animation property determines component animation parameters. | |
Bottom | The Bottom property determines a bottom margin if a component is placed inside LayoutPanel. | |
Content | The Content property determines component contents. | |
ContextMenu | The ContextMenu property determines a component's context menu. | |
Data | The Data property is used to store any custom data. | |
Enabled | The Enabled property determines whether a component can be used. | |
Height | The Height property determines component height. | |
IsRTL | The IsRTL property determines whether component elements are aligned to the right. | |
IsVisible | The IsVisible property determines whether a component is displayed. | |
Left | The Left property determines a left margin if a component is placed inside GridPanel. | |
Opacity | The Opacity property determines component transparency. | |
Parent | The Parent property determines a parent component of a control. | |
ParentNode | The ParentNode property determines a parent DOM node. | |
ResourceKey | The ResourceKey property determines a component resource key. | |
Right | The Right property determines a right margin if a component is placed inside LayoutPanel. | |
Rotate | The Rotate property determines a component rotation angle. | |
ShowToolTip | The ShowToolTip property determines whether a tooltip of the component can be displayed. | |
Style | The Style property determines a component style. | |
TabIndex | The TabIndex property determines the order of the control element passing inside the container. | |
Tag | The Tag property determines a JSON object associated with the component. | |
ToolTip | The ToolTip property determines text of component tooltip. | |
Top | The Top property determines a top margin if a component is placed inside GridPanel. | |
Value | The Value property determines a component value. | |
Width | The Width property determines component width. |
Method name | Brief description | |
The addClass method adds a CSS class to the component. | ||
addEventHandler | The addEventHandler method adds an event handler to a DOM node. | |
The addStateClass method adds a CSS class to the component and removes the previous CSS class. | ||
The addToNode method adds a component to the specified node. | ||
bindEvents | The bindEvents method subscribes an element to all available events. | |
The getAnchorFlags method returns JSON object that contains settings of the current component's position. | ||
The getClass method returns the current CSS classes of the component. | ||
The getCssStyle method returns style for the specified node. | ||
The getDomNode method returns main DOM node of the component. | ||
The getFocused method determines whether the component is focused. | ||
getIsBinded | The getIsBinded method returns whether an element is subscribed to all DOM node events. | |
The hide method hides a control. | ||
The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown. | ||
refreshStyle | The refreshStyle method refreshes element CSS styles. | |
The removeClass method removes CSS class from the component. | ||
removeEventHandler | The removeEventHandler method removes event handler from DOM node. | |
removeFromDOM | The removeFromDOM method removes node from the DOM structure. | |
The removeStateClasses method removes CSS classes of the component. | ||
The setDraggable method determines whether a component can be dragged on the HTML page. | ||
The setFocus method sets the component focus. | ||
The setIsHovered method sets up component displaying only on mouseover. | ||
The setSize method establishes the sizes of the component. | ||
The show method displays a control. | ||
unBindEvents | The unBindEvents method unsubscribes an element from all standard events. | |
The updatePosition method updates size and position when absolute positioning based on the current parameters is used. | ||
The updateSize method updates the component size on changing the size of the container that contains the component. |
Event name | Brief description | |
Drag | The Drag event occurs on clicking and holding the mouse button. | |
DragEnd | The DragEnd event occurs when dragging the component finishes. | |
DragStart | The DragStart event occurs when dragging the component starts. | |
OnContextMenu | The OnContextMenu event occurs on calling context menu of the component. | |
SizeChanged | The SizeChanged event occurs after the component is resized. | |
SizeChanging | The SizeChanging event occurs during component resize. |
Property name | Brief description | |
The Id property determines a repository object identifier. |
Method name | Brief description | |
clone | The clone method creates an object copy. | |
dispose | The dispose method deletes the component. | |
getHashCode | The getHashCode method returns hash code of repository object. | |
getId | The getId method returns repository object identifier. | |
getSettings | The getSettings method returns repository object settings. | |
getTypeName | The getTypeName method returns the name of the object type without the namespace, to which it belongs. | |
isEqual | The isEqual method determines whether the specified object is equal to the current repository object. | |
isLive | The isLive method determines validity of repository object. | |
removeAllEvents | The removeAllEvents method removes all object event handlers by the specified context. | |
setId | The setId method determines a repository object identifier. | |
setSettings | The setSettings method determines repository object settings. | |
defineProps | The defineProps method creates get and set methods from name array for the specified class. | |
keys | The keys method returns array of methods and properties names for the specified object. |
See also: