Differenze
Queste sono le differenze tra la revisione selezionata e la versione attuale della pagina.
| Entrambe le parti precedenti la revisione Revisione precedente Prossima revisione | Revisione precedente | ||
|
custom:api_js_opengwtimetabletab [2020/01/08 09:46] giorgio.scali |
custom:api_js_opengwtimetabletab [2020/01/08 10:22] (versione attuale) giorgio.scali |
||
|---|---|---|---|
| Linea 1: | Linea 1: | ||
| ====== Apertura scheda gwTimeTable ====== | ====== Apertura scheda gwTimeTable ====== | ||
| - | La gwTimeTable è una particolare tipologia di scheda descritta [[gwusermanual:interface:schede#gwTimeTable (ex gwTimeLine)|qui]]. | + | La gwTimeTable è una particolare tipologia di scheda descritta [[gwusermanual:interface:schede#gwTimeTable|qui]]. |
| ===== openGwTimeTableTab() ===== | ===== openGwTimeTableTab() ===== | ||
| Linea 7: | Linea 7: | ||
| ==== Parametri ==== | ==== Parametri ==== | ||
| - | * **params** Object, optional required | + | * **title** String, optional |
| + | * **params** Object, required | ||
| * **className** String, required, gwClass name where the gwTimeTable works | * **className** String, required, gwClass name where the gwTimeTable works | ||
| * **listedAttributesNames** String, optional, default null. gwAttributes name, comma separated (','). Allow to control which columns to show inside the gwTimetable list. If not provided the default for the gwClass will be used | * **listedAttributesNames** String, optional, default null. gwAttributes name, comma separated (','). Allow to control which columns to show inside the gwTimetable list. If not provided the default for the gwClass will be used | ||
| * **detailLayoutName** String, optional. detailLayout name used to open the gwClassDetail on the gwTimeTable's cells click. If omitted the gwClass's default detailLayout is used | * **detailLayoutName** String, optional. detailLayout name used to open the gwClassDetail on the gwTimeTable's cells click. If omitted the gwClass's default detailLayout is used | ||
| - | * **title** String, optional. A title used for the tab. | ||
| * **gwdResources** String, optional, default null, alternative to gwdResourcesFilters. String, comma separated (',') list containing the cod_resource inside gwd_resource relation. It can be used the notation #{gw_activeUser} that a will be replaced with the session gwUser. | * **gwdResources** String, optional, default null, alternative to gwdResourcesFilters. String, comma separated (',') list containing the cod_resource inside gwd_resource relation. It can be used the notation #{gw_activeUser} that a will be replaced with the session gwUser. | ||
| * **gwdResourcesFilters** Object[], optional, alternative to gwdResources. Filter[] that impose selection criteria on gwd_resource records. | * **gwdResourcesFilters** Object[], optional, alternative to gwdResources. Filter[] that impose selection criteria on gwd_resource records. | ||
| Linea 21: | Linea 21: | ||
| * **reportPath** String, optional, default null, se presente sara disponibile sulla toolbar un bottone che al click apre la report come da path, passando come parametro 'gwd_resources', String contenente una clausola fra parentesi tonde di valori (valori gwd_resource in ingresso al widget) String separati dal carattere ','. Esempio: gwd_resources: ('001','002'). | * **reportPath** String, optional, default null, se presente sara disponibile sulla toolbar un bottone che al click apre la report come da path, passando come parametro 'gwd_resources', String contenente una clausola fra parentesi tonde di valori (valori gwd_resource in ingresso al widget) String separati dal carattere ','. Esempio: gwd_resources: ('001','002'). | ||
| * **openReportButtonLabel** String, optional, default null, valutato solo se reportPath è presente. E' la label (e tooltip) applicata al bottone che apre la report. Se omessa viene mostrato un bottone senza label e con un generico 'Apri' localizzato come tooltip. | * **openReportButtonLabel** String, optional, default null, valutato solo se reportPath è presente. E' la label (e tooltip) applicata al bottone che apre la report. Se omessa viene mostrato un bottone senza label e con un generico 'Apri' localizzato come tooltip. | ||
| - | | ||
| - | Gli ultimi 4 parametri influiscono sulla visualizzazione grafica della scheda dettaglio delle attività assegnate e/o programmate in un dato giorno. Questa scheda è basata principalmente sul componente **dojox/calendar/Calendar**. Sono tutti opzionali, e in caso di omissione sono utilizzati dei valori di default. Essi agiscono come descritto nella documentazione ufficiale visualizzabile [[https://dojotoolkit.org/reference-guide/1.10/dojox/calendar.html|qui]] | ||
| * **hourSize** Integer, optional, default 100. The desired size (height) in pixels of one hour | * **hourSize** Integer, optional, default 100. The desired size (height) in pixels of one hour | ||
| * **timeSlotDuration** Integer, optional, default 15. The duration of minutes of the time slot (must be a divisor of 60) | * **timeSlotDuration** Integer, optional, default 15. The duration of minutes of the time slot (must be a divisor of 60) | ||
| * **minHours** Integer, optional, in range [0, 23], 8 default | * **minHours** Integer, optional, in range [0, 23], 8 default | ||
| * **maxHours** Integer, optional, in range [1, 36], 16 default | * **maxHours** Integer, optional, in range [1, 36], 16 default | ||
| + | Gli ultimi 4 parametri influiscono sulla visualizzazione grafica della scheda dettaglio delle attività assegnate e/o programmate in un dato giorno. Questa scheda è basata principalmente sul componente **dojox/calendar/Calendar**. Sono tutti opzionali, e in caso di omissione sono utilizzati dei valori di default. Essi agiscono come descritto nella documentazione ufficiale visualizzabile [[https://dojotoolkit.org/reference-guide/1.10/dojox/calendar.html|qui]]. | ||
| + | * **insertIndex** Integer, opzional. Determina in quale posizione verrà aperta la scheda. Se omesso la scheda verrà aperta a destra, in ultima posizione | ||
| ==== Esempi ==== | ==== Esempi ==== | ||
| Linea 33: | Linea 32: | ||
| Codice minimale. | Codice minimale. | ||
| <code javascript example.js> | <code javascript example.js> | ||
| + | var title = 'Title'; | ||
| var gwClassName = 'gw_class_name'; | var gwClassName = 'gw_class_name'; | ||
| var params = { | var params = { | ||
| - | title: 'title', | ||
| className: gwClassName | className: gwClassName | ||
| }; | }; | ||
| - | var gwTimetableTab = openGwTimeTableTab(params); | + | var gwTimetableTab = openGwTimeTableTab(title, params); |
| </code> | </code> | ||
| Passaggio filtro delle risorse come stringa. | Passaggio filtro delle risorse come stringa. | ||
| <code javascript example.js> | <code javascript example.js> | ||
| + | var title = 'Title'; | ||
| var gwClassName = 'gw_class_name'; | var gwClassName = 'gw_class_name'; | ||
| var gwdResources = '001,002,003,004,005'; | var gwdResources = '001,002,003,004,005'; | ||
| var params = { | var params = { | ||
| - | title: 'title', | ||
| className: gwClassName, | className: gwClassName, | ||
| gwdResources: gwdResources | gwdResources: gwdResources | ||
| }; | }; | ||
| - | var gwTimetableTab = openGwTimeTableTab(params); | + | var gwTimetableTab = openGwTimeTableTab(title, params); |
| </code> | </code> | ||
| Passaggio filtro delle risorse come lista di oggetti filtro. | Passaggio filtro delle risorse come lista di oggetti filtro. | ||
| <code javascript example.js> | <code javascript example.js> | ||
| + | var title = 'Title'; | ||
| var gwClassName = 'gw_class_name'; | var gwClassName = 'gw_class_name'; | ||
| var gwdResourcesFilters = [ | var gwdResourcesFilters = [ | ||
| Linea 61: | Linea 61: | ||
| }; | }; | ||
| var params = { | var params = { | ||
| - | title: 'title', | ||
| className: gwClassName, | className: gwClassName, | ||
| gwdResourcesFilters: gwdResourcesFilters | gwdResourcesFilters: gwdResourcesFilters | ||
| } | } | ||
| - | var gwTimetableTab = openGwTimeTableTab(params); | + | var gwTimetableTab = openGwTimeTableTab(title, params); |
| </code> | </code> | ||
| Passaggio filtro delle risorse come lista di oggetti filtro. Se lanciata da un gwAction di tipo 'List', gwdResourcesFilters è reperibile dai filtri attualmente impostati sulla griglia della scheda gwClassList. Essi sono contenuti nel parametro in ingresso alla gwAction, chiamato **queryParameter**. | Passaggio filtro delle risorse come lista di oggetti filtro. Se lanciata da un gwAction di tipo 'List', gwdResourcesFilters è reperibile dai filtri attualmente impostati sulla griglia della scheda gwClassList. Essi sono contenuti nel parametro in ingresso alla gwAction, chiamato **queryParameter**. | ||
| <code javascript example.js> | <code javascript example.js> | ||
| + | var title = 'Title'; | ||
| var gwClassName = 'gw_class_name'; | var gwClassName = 'gw_class_name'; | ||
| var gwdResourcesFilters = queryParameter.filters; | var gwdResourcesFilters = queryParameter.filters; | ||
| var params = { | var params = { | ||
| - | title: 'title', | ||
| className: gwClassName, | className: gwClassName, | ||
| gwdResourcesFilters: gwdResourcesFilters, | gwdResourcesFilters: gwdResourcesFilters, | ||
| - | var gwTimetableTab = openGwTimeTableTab(params); | + | var gwTimetableTab = openGwTimeTableTab(title, params); |
| </code> | </code> | ||
| Esempio con utilizzo di tutti i parametri, anche opzionali | Esempio con utilizzo di tutti i parametri, anche opzionali | ||
| <code javascript example.js> | <code javascript example.js> | ||
| + | var title = 'Title'; | ||
| var gwClassName = 'gw_class_name'; | var gwClassName = 'gw_class_name'; | ||
| //var gwdResources = '001,002,003,004,005'; | //var gwdResources = '001,002,003,004,005'; | ||
| Linea 88: | Linea 88: | ||
| }; | }; | ||
| var params = { | var params = { | ||
| - | title: 'title', | ||
| className: gwClassName, | className: gwClassName, | ||
| detailLayoutName: 'who_n_when', | detailLayoutName: 'who_n_when', | ||
| Linea 106: | Linea 105: | ||
| openReportButtonLabel: 'Stampa Programmazione Settimanale' | openReportButtonLabel: 'Stampa Programmazione Settimanale' | ||
| }; | }; | ||
| - | var gwTimetableTab = openGwTimeTableTab(params); | + | var gwTimetableTab = openGwTimeTableTab(title, params); |
| </code> | </code> | ||