Els objectes següents tenen relació directa amb l'API templatedashboard.
L'objecte tauler de plantilla té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| dashboardid | cadena | ID del tauler de plantilla. Comportament de la propietat: - només lectura - obligatori per operacions d'actualització |
| name | cadena | Nom del tauler de plantilla. Comportament de la propietat: - obligatori per operacions de creació |
| templateid | cadena | ID de la plantilla on pertany el tauler. Comportament de la propietat: - constant - obligatori per operacions de creació |
| display_period | enter | Període (en segons) de mostra de la pàgina per defecte. Valors possibles: 10, 30, 60, 120, 600, 1800, 3600. Per defecte: 30. |
| auto_start | enter | Iniciar presentació automàticament. Valors possibles: 0 - no iniciar-la automàticament; 1 - (per defecte) iniciar-la automàticament. |
| uuid | cadena | ID únic universal, emprat per enllaçar els taulers de plantilles importats als ja existents. Es genera automàticament si no es passen com a paràmetre. |
L'objecte de plantilla de pàgina de tauler té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| dashboard_pageid | string | (només lectura) ID de la pàgina del tauler. |
| name | string | Nom de la pàgina del tauler. Per defecte: cadena buida. |
| display_period | integer | Temps de mostra de la pàgina del tauler (en segons). Valors possibles: 0, 10, 30, 60, 120, 600, 1800, 3600. Per defecte: 0 (empra el període de mostra de pàgina per defecte). |
| widgets | array | Matriu dels objectes ginys de plantilla de tauler. |
L'objecte té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| widgetid | string | ID del giny del tauler de control. Comportament de la propietat: - només lectura |
| type (obligatori) | cadena | Tipus del giny del tauler de control. Valors possibles: rellotge - Rellotge; gràfic - Gràfic (clàssic);< br> graphprototype - Prototip de gràfic; element - Valor de l'element; text pla - Text pla; url - URL. Comportament de la propietat: - obligatori |
| name | string | Nom del giny personalitzat. |
| x | integer | Una posició horitzontal des del costat esquerre del tauler. Els valors vàlids són 0-23. |
| y | integer | Una posició vertical des de la part superior del tauler. Els valors vàlids són 0-62. |
| width | integer | L'amplada del giny. Els valors vàlids són de l'1 al 24. |
| height | integer | L'alçada del giny. Els valors vàlids són del 2 al 32. |
| view_mode | integer | El mode de visualització del giny. Valors possibles: 0 - (per defecte) vista del giny; 1 - amb la capçalera oculta; |
| fields | array | Matriu d'objectes camp del giny del tauler de plantilla. |
### Camp de giny de plantilla de tauler
L'objecte té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| type | integer | Tipus de camp de giny. Valors possibles: 0 - Enter; 1 - Cadena; 4 - Element;< br>5 - Prototip d'element; 6 - Gràfic; 7 - Prototip gràfic. Comportament de la propietat: - obligatori |
| name | string | Nom del camp del giny. Comportament de la propietat: - obligatori |
| value | mixed | Valor del camp del giny segons el tipus. Comportament de la propietat: - obligatori |