> Sjabloon dashboardobject

De volgende objecten zijn direct gerelateerd aan het templateashboard API.

Sjabloon dashboard

Het sjabloon dashboard object heeft de volgende eigenschappen.

Eigenschap Type Beschrijving
dashboardid string ID van het sjabloon dashboard.

Eigenschapsgedrag:
- alleen lezen
- vereist voor update bewerkingen
name string Naam van het sjabloon dashboard.

Eigenschapsgedrag:
- vereist voor aanmaak bewerkingen
templateid string ID van het sjabloon waartoe het dashboard behoort.

Eigenschapsgedrag:
- constant
- vereist voor aanmaak bewerkingen
display_period integer Standaard weergaveperiode van de pagina (in seconden).

Mogelijke waarden: 10, 30, 60, 120, 600, 1800, 3600.

Standaard: 30.
auto_start integer Automatisch starten van diavoorstelling.

Mogelijke waarden:
0 - diavoorstelling niet automatisch starten;
1 - (standaard) diavoorstelling automatisch starten.
uuid string Unieke universele identifier, gebruikt om geïmporteerde sjabloon dashboards te koppelen aan reeds bestaande. Wordt automatisch gegenereerd indien niet opgegeven.

Sjabloon dashboard pagina

Het sjabloon dashboard pagina object heeft de volgende eigenschappen.

Eigenschap Type Beschrijving
dashboard_pageid string ID van de dashboard pagina.

Eigenschapsgedrag:
- alleen lezen
name string Naam van de dashboard pagina.

Standaard: lege string.
display_period integer Weergaveperiode van de dashboard pagina (in seconden).

Mogelijke waarden: 0, 10, 30, 60, 120, 600, 1800, 3600.

Standaard: 0 (gebruikt de standaard weergaveperiode van de pagina).
widgets array Array van sjabloon dashboard widget objecten.

Sjabloon dashboard widget

Het sjabloon dashboard widget object heeft de volgende eigenschappen.

Eigenschap Type Beschrijving
widgetid string ID van de dashboard widget.

Eigenschapsgedrag:
- alleen lezen
type string Type van de dashboard widget.

Mogelijke waarden:
clock - Klok;
graph - Grafiek (klassiek);
graphprototype - Grafiek sjabloon;
item - Itemwaarde;
plaintext - Gewone tekst;
url - URL.

Eigenschapsgedrag:
- vereist
name string Aangepaste widgetnaam.
x integer Een horizontale positie vanaf de linkerkant van het dashboard.

Geldige waarden variëren van 0 tot 23.
y integer Een verticale positie vanaf de bovenkant van het dashboard.

Geldige waarden variëren van 0 tot 62.
width integer De breedte van de widget.

Geldige waarden variëren van 1 tot 24.
height integer De hoogte van de widget.

Geldige waarden variëren van 2 tot 32.
view_mode integer De weergavemodus van de widget.

Mogelijke waarden:
0 - (standaard) standaard widgetweergave;
1 - met verborgen koptekst;
fields array Array van sjabloon dashboard widget veld objecten.

Sjabloon dashboard widget veld

Het sjabloon dashboard widget veld object heeft de volgende eigenschappen.

Eigenschap Type Beschrijving
type integer Type van het widgetveld.

Mogelijke waarden:
0 - Integer;
1 - String;
4 - Item;
5 - Item sjabloon;
6 - Grafiek;
7 - Grafiek sjabloon.

Eigenschapsgedrag:
- vereist
name string Naam van het widgetveld.

Eigenschapsgedrag:
- vereist
value mixed Widgetveldwaarde afhankelijk van het type.

Eigenschapsgedrag:
- vereist