Techsystech
/
web
mirror of https://github.com/OCA/web.git
3
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

[IMP] Readme: Available attribute list

pull/1557/head
tarteo 2018-10-31 15:09:16 +01:00 committed by Alexandre Díaz
parent 10dbbc78d8
commit 10553fcb42
2 changed files with 42 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
web_timeline/README.rst
View File

@ -41,30 +41,27 @@ Configuration
You need to define a view with the tag <timeline> as base element. These are You need to define a view with the tag <timeline> as base element. These are
the possible attributes for the tag: the possible attributes for the tag:
* date_start (required): it defines the name of the field of type date that +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
contains the start of the event. | Attribute | Required? | Description |
* date_stop (optional): it 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 | **Yes** | Defines the name of the field of type date that contains the start of the event. |
date_start to display events has 'point' on the Timeline (instantaneous event) +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
* date_delay (optional): it defines the name of the field of type float/integer | 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). |
that contain the duration in hours of the event, default = 1 +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
* default_group_by (required): it defines the name of the field that will be | date_delay | No | Defines the name of the field of type float/integer that contain the duration in hours of the event, default = 1. |
taken as default group by when accessing the view or when no other group by +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
is selected. | 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 other group by is selected. |
* zoomKey (optional): Specifies whether the Timeline is only zoomed when an +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
additional key is down. Available values are '' (does not apply), 'altKey', | 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. |
'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. |
* mode (optional): Specifies the initial visible window. Available values are: +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
'day' to display the current day, 'week', 'month' and 'fit'. | 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. |
Default value is 'fit' to adjust the visible window such that it fits all items +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
* event_open_popup (optional): when set to true, it allows to edit the events | colors | No | Allows to set certain specific colors if the expressed condition (JS syntax) is met. |
in a popup. If not (default value), the record is edited changing to form +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
view. | dependency_arrow | No | Set this attribute to a x2many field to draw arrows between the records referenced in the x2many field. |
* colors (optional): it allows to set certain specific colors if the expressed +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
condition (JS syntax) is met.
* dependency_arrow (optional): set this attribute to a x2many field to draw
arrows between the records referenced in the x2many field.
Optionally you can declare a custom template, which will be used to render the Optionally you can declare a custom template, which will be used to render the
timeline items. You have to name the template 'timeline-item'. timeline items. You have to name the template 'timeline-item'.

45
web_timeline/readme/CONFIGURE.rst
View File

@ -1,30 +1,27 @@
You need to define a view with the tag <timeline> as base element. These are You need to define a view with the tag <timeline> as base element. These are
the possible attributes for the tag: the possible attributes for the tag:
* date_start (required): it defines the name of the field of type date that +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
contains the start of the event. | Attribute | Required? | Description |
* date_stop (optional): it 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 | **Yes** | Defines the name of the field of type date that contains the start of the event. |
date_start to display events has 'point' on the Timeline (instantaneous event) +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
* date_delay (optional): it defines the name of the field of type float/integer | 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). |
that contain the duration in hours of the event, default = 1 +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
* default_group_by (required): it defines the name of the field that will be | date_delay | No | Defines the name of the field of type float/integer that contain the duration in hours of the event, default = 1. |
taken as default group by when accessing the view or when no other group by +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
is selected. | 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 other group by is selected. |
* zoomKey (optional): Specifies whether the Timeline is only zoomed when an +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
additional key is down. Available values are '' (does not apply), 'altKey', | 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. |
'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. |
* mode (optional): Specifies the initial visible window. Available values are: +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
'day' to display the current day, 'week', 'month' and 'fit'. | 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. |
Default value is 'fit' to adjust the visible window such that it fits all items +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
* event_open_popup (optional): when set to true, it allows to edit the events | colors | No | Allows to set certain specific colors if the expressed condition (JS syntax) is met. |
in a popup. If not (default value), the record is edited changing to form +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
view. | dependency_arrow | No | Set this attribute to a x2many field to draw arrows between the records referenced in the x2many field. |
* colors (optional): it allows to set certain specific colors if the expressed +--------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
condition (JS syntax) is met.
* dependency_arrow (optional): set this attribute to a x2many field to draw
arrows between the records referenced in the x2many field.
Optionally you can declare a custom template, which will be used to render the Optionally you can declare a custom template, which will be used to render the
timeline items. You have to name the template 'timeline-item'. timeline items. You have to name the template 'timeline-item'.