-
Web timeline
+
+
+
+
+
+
+
+
Web timeline
-
Define a new view displaying events in an interactive visualization chart.
The widget is based on the external library @@ -390,14 +395,14 @@
Web timeline
-
@@ -585,7 +566,7 @@
Configuration
+Configuration
You need to define a view with the tag <timeline> as base element. These are the possible attributes for the tag:
| Attribute | @@ -408,104 +413,80 @@|||
|---|---|---|---|
| date_start | Yes | -Defines the name of the field of -type date that contains the start -of the event. | +Defines the name of the field of type date that +contains the start of the event. |
| date_stop | No | -Defines the name of the field of -type date that contains the end of -the event. The date_stop can be -equal to the attribute date_start -to display events has ‘point’ on -the Timeline (instantaneous event). | +Defines the name of the field of type date that +contains the end of the event. The date_stop can be +equal to the attribute date_start to display events +has ‘point’ on the Timeline (instantaneous event). |
| date_delay | No | -Defines the name of the field of -type float/integer that contain the -duration in hours of the event, + | Defines the name of the field of type float/integer +that contain the duration in hours of the event, default = 1. |
| default_group_by | Yes | -Defines the name of the field that -will be taken as default group by -when accessing the view or when no + | Defines the name of the field that will be taken as +default group by when accessing the view or when no other group by is selected. |
| zoomKey | No | -Specifies whether the Timeline is -only zoomed when an additional key -is down. Available values are ‘’ -(does not apply), ‘altKey’, -‘ctrlKey’, or ‘metaKey’. Set this -option if you want to be able to -use the scroll to navigate -vertically on views with a lot of -events. | +Specifies whether the Timeline is only zoomed when an +additional key is down. Available values are ‘’ (does +not apply), ‘altKey’, ‘ctrlKey’, or ‘metaKey’. Set +this option if you want to be able to use the scroll +to navigate vertically on views with a lot of events. |
| mode | No | -Specifies the initial visible -window. Available values are: ‘day’ -to display the current day, ‘week’, -‘month’ and ‘fit’. Default value is -‘fit’ to adjust the visible window -such that it fits all items. | +Specifies the initial visible window. Available values +are: ‘day’ to display the current day, ‘week’, ‘month’ +and ‘fit’. Default value is ‘fit’ to adjust the +visible window such that it fits all items. |
| margin | No | -Specifies the margins around the -items. It should respect the JSON -format. For example -‘{“item”:{“horizontal”:-10}}’. -Available values are: -‘{“axis”:<number>}’ (The minimal -margin in pixels between items and -the time axis) ‘{“item”:<number>}’ -(The minimal margin in pixels -between items in both horizontal -and vertical direction), -‘{“item”:{“horizontal”:<number>}}’ -(The minimal horizontal margin in -pixels between items), -‘{“item”:{“vertical”:<number>}}’ -(The minimal vertical margin in -pixels between items), -‘{“item”:{“horizont -al”:<number>,”vertical”:<number>}}’ -(Combination between horizontal and -vertical margins in pixels between -items). | +Specifies the margins around the items. It should +respect the JSON format. For example +‘{“item”:{“horizontal”:-10}}’. Available values are: +‘{“axis”:<number>}’ (The minimal margin in pixels +between items and the time axis) ‘{“item”:<number>}’ +(The minimal margin in pixels between items in both +horizontal and vertical direction), +‘{“item”:{“horizontal”:<number>}}’ (The minimal +horizontal margin in pixels between items), +‘{“item”:{“vertical”:<number>}}’ (The minimal vertical +margin in pixels between items), +‘{“item”:{“horizontal”:<number>,”vertical”:<number>}}’ +(Combination between horizontal and vertical margins +in pixels between items). |
| event_open_popup | No | -When set to true, it allows to edit -the events in a popup. If not -(default value), the record is -edited changing to form view. | +When set to true, it allows to edit the events in a +popup. If not (default value), the record is edited +changing to form view. |
| stack | No | -When set to false, items will not -be stacked on top of each other -such that they do overlap. | +When set to false, items will not be stacked on top of +each other such that they do overlap. |
| colors | No | -Allows to set certain specific -colors if the expressed condition -(JS syntax) is met. | +Allows to set certain specific colors if the expressed +condition (JS syntax) is met. |
| dependency_arrow | No | -Set this attribute to a x2many -field to draw arrows between the -records referenced in the x2many -field. | +Set this attribute to a x2many field to draw arrows +between the records referenced in the x2many field. |
Configuration
-
Usage
+Usage
For accessing the timeline view, you have to click on the button with the clock icon in the view switcher. The first time you access to it, the timeline window is zoomed to fit all the current elements, the same @@ -613,7 +594,7 @@
Usage
create a new record with the dragged start and end date.
-
Known issues / Roadmap
+Known issues / Roadmap
- Implement a more efficient way of refreshing timeline after a record update; @@ -632,7 +613,7 @@
Known issues / Roadmap
-
Bug Tracker
+Bug Tracker
Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed @@ -640,9 +621,9 @@
Bug Tracker
Do not contact contributors directly about support or help with technical issues.
-
Credits
+Credits
-
Contributors
+Contributors
- Laurent Mignon <laurent.mignon@acsone.eu>
- Adrien Peiffer <adrien.peiffer@acsone.eu> @@ -680,7 +661,7 @@
@@ -695,5 +676,6 @@