The Timeline is a flexible widget that displays events in a vertical timeline.
- UI Type:
- Properties 13
- Style 4
- Events 5
- Functions 19
Properties
Style
Events
Function
getPeriod ( ) →{ Object }
Returns the current displayed period.
refresh ( opts: Object )
Refreshes the timeline.
Parameters
Name | Type | Description |
---|---|---|
opts | Object | Optional options object to configure the refresh. |
setRenderType ( renderType: currentDay )
Sets the timeline's render type.
Parameters
Name | Type | Description |
---|---|---|
renderType | currentDay | The new render type |
get ( name: String ) →{ Object }
Gets the value of the specified property.
Parameters
Name | Type | Description |
---|---|---|
name | String | The name of the property. |
Returns
The property's value.
isEnabled ( ) →{ Boolean }
Returns true if the widget is enabled.
Returns
True if enabled, otherwise false.
isHidden ( ) →{ Boolean }
Returns true if the widget is hidden.
Returns
True if hidden, otherwise false.
set ( name: String , value: Object )
Sets the value of the specified property.
Parameters
Name | Type | Description |
---|---|---|
name | String | The name of the property. |
value | Object | The new value. |
setEnabled ( Enabled: Boolean )
Enables/disables the widget.
Parameters
Name | Type | Description |
---|---|---|
Enabled | Boolean | True to enable the widget, false to disable. |
setStyle ( Object: Object )
Set the widget-style
Parameters
Name | Type | Description |
---|---|---|
Object | Object | properties |