> Template dashboard object

Następujące obiekty są bezpośrednio związane z API templatedashboard.

Template dashboard

Obiekt template dashboard ma następujące właściwości.

Właściwość Typ Opis
dashboardid string (tylko do odczytu) ID pulpitu szablonu.
name
(wymagane)
string Nazwa pulpitu szablonu.
templateid
(wymagane)
string ID szablonu, do którego należy pulpit.
display_period integer Domyślny okres wyświetlania strony (w sekundach).

Możliwe wartości: 10, 30, 60, 120, 600, 1800, 3600.

Domyślnie: 30.
auto_start integer Automatyczne rozpoczęcie pokazu slajdów.

Możliwe wartości:
0 - nie rozpoczynaj pokazu slajdów automatycznie;
1 - (domyślne) rozpocznij pokaz slajdów automatycznie.
uuid string Uniwersalny identyfikator, używany do powiązania importowanych pulpitu szablonu z już istniejącymi. Automatycznie generowany, jeśli nie podano.

Należy zauważyć, że dla niektórych metod (aktualizacja, usuwanie) kombinacja parametrów wymaganych/opcjonalnych jest inna.

Template dashboard page

Obiekt template dashboard page ma następujące właściwości.

Właściwość Typ Opis
dashboard_pageid string (tylko do odczytu) ID strony pulpitu.
name string Nazwa strony pulpitu.

Domyślnie: pusty ciąg znaków.
display_period integer Okres wyświetlania strony pulpitu (w sekundach).

Możliwe wartości: 0, 10, 30, 60, 120, 600, 1800, 3600.

Domyślnie: 0 (będzie używany domyślny okres wyświetlania strony).
widgets array Tablica obiektów widżetu pulpitu szablonu.

Template dashboard widget

Obiekt template dashboard widget ma następujące właściwości.

Właściwość Typ Opis
widgetid string (tylko do odczytu) ID widżetu pulpitu.
type
(wymagane)
string Typ widżetu pulpitu.

Możliwe wartości:
clock - Zegar;
graph - Wykres (klasyczny);
graphprototype - Prototyp wykresu;
item - Wartość pozycji;
plaintext - Czysty tekst;
url - URL;
name string Niestandardowa nazwa widżetu.
x integer Położenie poziome od lewej strony pulpitu.

Dopuszczalne wartości są w zakresie od 0 do 23.
y integer Położenie pionowe od góry pulpitu.

Dopuszczalne wartości są w zakresie od 0 do 62.
width integer Szerokość widżetu.

Dopuszczalne wartości są w zakresie od 1 do 24.
height integer Wysokość widżetu.

Dopuszczalne wartości są w zakresie od 2 do 32.
view_mode integer Tryb widoku widżetu.

Możliwe wartości:
0 - (domyślnie) domyślny widok widżetu;
1 - z ukrytym nagłówkiem;
fields array Tablica obiektów pola widżetu pulpitu szablonu.

Template dashboard widget field

Obiekt template dashboard widget field ma następujące właściwości.

Właściwość Typ Opis
type
(wymagane)
integer Typ pola widżetu.

Możliwe wartości:
0 - Liczba całkowita;
1 - Ciąg znaków;
4 - Pozycja;
5 - Prototyp pozycji;
6 - Wykres;
7 - Prototyp wykresu.
name string Nazwa pola widżetu.
value
(wymagane)
mixed Wartość pola widżetu w zależności od typu.