21 Wykres kołowy
Opis
Te parametry oraz możliwe wartości właściwości dla odpowiednich obiektów pól widgetu umożliwiają skonfigurowanie widgetu Pie chart w metodach dashboard.create i dashboard.update.
Właściwości fields widgetu nie są walidowane podczas tworzenia ani aktualizacji pulpitu.
Pozwala to użytkownikom modyfikować wbudowane widgety i tworzyć własne widgety, ale jednocześnie wprowadza ryzyko nieprawidłowego tworzenia lub aktualizowania widgetów.
Aby zapewnić pomyślne utworzenie lub zaktualizowanie widgetu Pie chart, zapoznaj się z zachowaniem parametrów opisanym w poniższych tabelach.
Parametry
Następujące parametry są obsługiwane dla widżetu Wykres kołowy.
| Parametr | type | name | value |
|---|---|---|---|
| Interwał odświeżania | 0 | rf_rate | 0 - Bez odświeżania; 10 - 10 sekund; 30 - 30 sekund; 60 - (domyślnie) 1 minuta; 120 - 2 minuty; 600 - 10 minut; 900 - 15 minut. |
Zestaw danych
Następujące parametry są obsługiwane przy konfigurowaniu Zestawu danych.
Pierwsza liczba w nazwie właściwości (np. ds.0.hosts.0, ds.0.items.0) oznacza konkretny zestaw danych, natomiast druga liczba, jeśli występuje, oznacza skonfigurowany host lub pozycję.
| Parametr | type | name | value | |
|---|---|---|---|---|
| Typ zestawu danych | 0 | ds.0.dataset_type | 0 - Lista pozycji; 1 - (domyślnie) Wzorce pozycji. |
|
| Pozycje | 4 | ds.0.itemids.0 | ID pozycji. Podczas konfigurowania widżetu na pulpicie szablonu należy ustawić tylko pozycje skonfigurowane w szablonie. Uwaga: Aby skonfigurować wiele pozycji, utwórz obiekt pola widżetu pulpitu dla każdej pozycji z inkrementowanym numerem w nazwie właściwości. Zachowanie parametru: - wymagane, jeśli Typ zestawu danych jest ustawiony na "Lista pozycji", a Pozycje (Widżet) nie są ustawione |
|
| Pozycje (Widżet) | 1 | ds.0.itemids.0._reference | Zamiast ID pozycji:ABCDE._itemid - ustaw kompatybilny widżet (z parametrem Reference ustawionym na "ABCDE") jako źródło danych dla pozycji.Uwaga: Aby skonfigurować wiele widżetów, utwórz obiekt pola widżetu pulpitu dla każdego widżetu z inkrementowanym numerem w nazwie właściwości. Zachowanie parametru: - wymagane, jeśli Typ zestawu danych jest ustawiony na "Lista pozycji", a Pozycje nie są ustawione |
|
| Kolor | 1 | ds.0.color.0 | Szesnastkowy kod koloru (np. FF0000).Zachowanie parametru: - wymagane, jeśli Typ zestawu danych jest ustawiony na "Lista pozycji" |
|
| Typ pozycji | 0 | ds.0.type.0 | 0 - (domyślnie) Normalny; 1 - Suma. Wartość "Suma" można ustawić tylko dla jednej pozycji na całym wykresie. Zachowanie parametru: - obsługiwane, jeśli Typ zestawu danych jest ustawiony na "Lista pozycji" |
|
| Wzorce hostów | 1 | ds.0.hosts.0 | Nazwa lub wzorzec hosta (np. "Zabbix*"). Zachowanie parametru: - wymagane, jeśli Typ zestawu danych jest ustawiony na "Wzorce pozycji" Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu. |
|
| Wzorce pozycji | 1 | ds.0.items.0 | Nazwa lub wzorzec pozycji (np. "*: Number of processed *values per second"). Podczas konfigurowania widżetu na pulpicie szablonu należy ustawić tylko wzorce dla pozycji skonfigurowanych w szablonie. Zachowanie parametru: - wymagane, jeśli Typ zestawu danych jest ustawiony na "Wzorce pozycji" |
|
| Kolor | 1 | ds.0.color | Szesnastkowy kod koloru (np. FF0000).Zachowanie parametru: - obsługiwane, jeśli Typ zestawu danych jest ustawiony na "Wzorce pozycji", a Paleta kolorów nie jest ustawiona |
|
| Paleta kolorów | 0 | ds.0.color_palette | Indeks palety kolorów. Możliwe wartości mieszczą się w zakresie 0-11. Domyślnie: 0. Zachowanie parametru: - obsługiwane, jeśli Typ zestawu danych jest ustawiony na "Wzorce pozycji", a Kolor nie jest ustawiony |
|
| Funkcja agregacji | 0 | ds.0.aggregate_function | 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - (domyślnie) last. |
|
| Agregacja zestawu danych | 0 | ds.0.dataset_aggregation | 0 - (domyślnie) brak; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum. Zachowanie parametru: - obsługiwane, jeśli Typ pozycji jest ustawiony na "Suma" |
|
| Etykieta zestawu danych | 1 | ds.0.data_set_label | Dowolna wartość tekstowa. Domyślnie: "" (puste). |
|
| Tagi pozycji | ||||
| Typ oceny | 0 | ds.0.item_tags_evaltype | 0 - (domyślnie) And/Or; 2 - Or. |
|
| Nazwa tagu | 1 | ds.0.item_tags.0.tag | Dowolna wartość tekstowa. Uwaga: Liczba w nazwie właściwości odnosi się do kolejności tagu na liście oceny tagów. Zachowanie parametru: - wymagane przy konfigurowaniu Tagów pozycji |
|
| Operator | 0 | ds.0.item_tags.0.operator | 0 - Zawiera; 1 - Równe; 2 - Nie zawiera; 3 - Nie równa się; 4 - Istnieje; 5 - Nie istnieje. Uwaga: Liczba w nazwie właściwości odnosi się do kolejności tagu na liście oceny tagów. Zachowanie parametru: - wymagane przy konfigurowaniu Tagów pozycji |
|
| Wartość tagu | 1 | ds.0.item_tags.0.value | Dowolna wartość tekstowa. Uwaga: Liczba w nazwie właściwości odnosi się do kolejności tagu na liście oceny tagów. Zachowanie parametru: - wymagane przy konfigurowaniu Tagów pozycji |
|
Opcje wyświetlania
Następujące parametry są obsługiwane przy konfigurowaniu opcji wyświetlania.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Wybór danych historycznych | 0 | source | 0 - (domyślnie) Auto; 1 - Historia; 2 - Trendy. |
|
| Rysuj | 0 | draw_type | 0 - (domyślnie) Wykres kołowy; 1 - Pierścień. |
|
| Szerokość | 0 | width | 20 - 20% promienia; 30 - 30% promienia; 40 - 40% promienia; 50 - (domyślnie) 50% promienia. Zachowanie parametru: - obsługiwane, jeśli Rysuj jest ustawione na "Pierścień" |
|
| Szerokość obramowania | 0 | stroke | Możliwe wartości mieszczą się w zakresie 0-10. Domyślnie: 0. Zachowanie parametru: - obsługiwane, jeśli Rysuj jest ustawione na "Pierścień" |
|
| Pokaż wartość całkowitą | 0 | total_show | 0 - (domyślnie) Wyłączone; 1 - Włączone. Zachowanie parametru: - obsługiwane, jeśli Rysuj jest ustawione na "Pierścień" |
|
| Rozmiar | 0 | value_size_type | 0 - (domyślnie) Auto; 1 - Niestandardowy. Zachowanie parametru: - obsługiwane, jeśli Pokaż wartość całkowitą jest ustawione na "Włączone" |
|
| Rozmiar (wartość dla rozmiaru niestandardowego) | 0 | value_size | Możliwe wartości mieszczą się w zakresie 1-100. Domyślnie: 20. Zachowanie parametru: - obsługiwane, jeśli Pokaż wartość całkowitą jest ustawione na "Włączone" |
|
| Miejsca dziesiętne | 0 | decimal_places | Możliwe wartości mieszczą się w zakresie 0-6. Domyślnie: 2. Zachowanie parametru: - obsługiwane, jeśli Pokaż wartość całkowitą jest ustawione na "Włączone" |
|
| Jednostki (pole wyboru) | 0 | units_show | 0 - (domyślnie) Wyłączone; 1 - Włączone. Zachowanie parametru: - obsługiwane, jeśli Pokaż wartość całkowitą jest ustawione na "Włączone" |
|
| Jednostki (wartość) | 1 | units | Dowolna wartość tekstowa. Zachowanie parametru: - obsługiwane, jeśli Jednostki (pole wyboru) jest ustawione na "Włączone" |
|
| Pogrubienie | 0 | value_bold | 0 - (domyślnie) Wyłączone; 1 - Włączone. Zachowanie parametru: - obsługiwane, jeśli Pokaż wartość całkowitą jest ustawione na "Włączone" |
|
| Kolor | 1 | value_color | Szesnastkowy kod koloru (np. FF0000).Zachowanie parametru: - obsługiwane, jeśli Pokaż wartość całkowitą jest ustawione na "Włączone" |
|
| Odstęp między sektorami | 0 | space | Możliwe wartości mieszczą się w zakresie 0-10. Domyślnie: 1. |
|
| Scal sektory mniejsze niż N% (pole wyboru) | 0 | merge | 0 - (domyślnie) Wyłączone; 1 - Włączone. |
|
| Scal sektory mniejsze niż N% (wartość) | 0 | merge_percent | Możliwe wartości mieszczą się w zakresie 1-10. Domyślnie: 1. Zachowanie parametru: - obsługiwane, jeśli Scal sektory mniejsze niż N% (pole wyboru) jest ustawione na "Włączone" |
|
| Scal sektory mniejsze niż N% (kolor) | 1 | merge_color | Szesnastkowy kod koloru (np. FF0000).Zachowanie parametru: - obsługiwane, jeśli Scal sektory mniejsze niż N% (pole wyboru) jest ustawione na "Włączone" |
|
Okres czasu
Następujące parametry są obsługiwane przy konfigurowaniu Okresu czasu.
| Parametr | type | name | value | |
|---|---|---|---|---|
| Okres czasu | 1 | time_period._reference | DASHBOARD._timeperiod - ustaw selektor okresu czasu pulpitu jako źródło danych;ABCDE._timeperiod - ustaw kompatybilny widget (z parametrem Reference ustawionym na "ABCDE") jako źródło danych.Domyślnie: DASHBOARD._timeperiodAlternatywnie możesz ustawić okres czasu tylko w parametrach Od i Do. |
|
| Od | 1 | time_period.from | Prawidłowy ciąg czasu w składni czasu bezwzględnego (YYYY-MM-DD hh:mm:ss) lub względnego (now, now/d, now/w-1w itd.).Zachowanie parametru: - obsługiwany, jeśli Okres czasu nie jest ustawiony - wymagany, jeśli ustawiono time_period.to |
|
| Do | 1 | time_period.to | Prawidłowy ciąg czasu w składni czasu bezwzględnego (YYYY-MM-DD hh:mm:ss) lub względnego (now, now/d, now/w-1w itd.).Zachowanie parametru: - obsługiwany, jeśli Okres czasu nie jest ustawiony - wymagany, jeśli ustawiono time_period.from |
|
Legenda
Następujące parametry są obsługiwane przy konfigurowaniu Legendy.
| Parametr | type | name | value |
|---|---|---|---|
| Pokaż legendę | 0 | legend | 0 - Wyłączone; 1 - (domyślnie) Włączone. |
| Pokaż wartość | 0 | legend_value | 0 - (domyślnie) Wyłączone; 1 - Włączone. Zachowanie parametru: - obsługiwane, jeśli Pokaż legendę jest ustawione na "Włączone" |
| Pokaż funkcję agregacji | 0 | legend_aggregation | 0 - (domyślnie) Wyłączone; 1 - Włączone. Zachowanie parametru: - obsługiwane, jeśli Pokaż legendę jest ustawione na "Włączone" |
| Wiersze | 0 | legend_lines_mode | 0 - (domyślnie) Stałe; 1 - Zmienne. Zachowanie parametru: - obsługiwane, jeśli Pokaż legendę jest ustawione na "Włączone" |
| Liczba wierszy/ Maksymalna liczba wierszy |
0 | legend_lines | Możliwe wartości mieszczą się w zakresie od 1 do 10. Domyślnie: 1. Zachowanie parametru: - obsługiwane, jeśli Pokaż legendę jest ustawione na "Włączone" |
| Liczba kolumn | 0 | legend_columns | Możliwe wartości mieszczą się w zakresie od 1 do 4. Domyślnie: 4. Zachowanie parametru: - obsługiwane, jeśli Pokaż wartość jest ustawione na "Wyłączone" |
Przykłady
Poniższe przykłady mają na celu jedynie opisanie konfiguracji obiektów pól widżetu pulpitu dla widżetu Pie chart.
Więcej informacji na temat konfiguracji pulpitu znajduje się w dashboard.create.
Konfigurowanie widżetu Pie chart
Skonfiguruj widżet Pie chart w następujący sposób:
- 2 zestawy danych dla łącznie 9 pozycji na 1 hoście.
- Pierwszy zestaw danych jest typu "Item list" i składa się z 3 pozycji, z których wszystkie mają typ "Normal" i są reprezentowane różnymi kolorami.
- Drugi zestaw danych jest typu "Item patterns", składa się z 6 pozycji, ma skonfigurowaną agregację dla każdej pozycji i jest reprezentowany przez niestandardowy kolor.
- Drugi zestaw danych ma również niestandardową etykietę zestawu danych.
- Dane na wykresie kołowym są wyświetlane jako wykres pierścieniowy z niestandardową szerokością oraz wartością całkowitą z jednostkami w środku.
- Dane na wykresie kołowym są wyświetlane i agregowane dla niestandardowego okresu czasu obejmującego ostatnie 3 godziny.
- Legenda wykresu kołowego wyświetla skonfigurowane pozycje w 4 wierszach.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "piechart",
"name": "Pie chart",
"x": 0,
"y": 0,
"width": 24,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "ds.0.dataset_type",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.0",
"value": 23264
},
{
"type": 1,
"name": "ds.0.color.0",
"value": "FF0000"
},
{
"type": 0,
"name": "ds.0.type.0",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.1",
"value": 23269
},
{
"type": 1,
"name": "ds.0.color.1",
"value": "BF00FF"
},
{
"type": 0,
"name": "ds.0.type.1",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.2",
"value": 23257
},
{
"type": 1,
"name": "ds.0.color.2",
"value": "0040FF"
},
{
"type": 0,
"name": "ds.0.type.2",
"value": 0
},
{
"type": 1,
"name": "ds.1.hosts.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.1.items.0",
"value": "*: Number of processed *values per second"
},
{
"type": 1,
"name": "ds.1.color",
"value": "000000"
},
{
"type": 0,
"name": "ds.1.aggregate_function",
"value": 3
},
{
"type": 1,
"name": "ds.1.data_set_label",
"value": "Number of processed values per second"
},
{
"type": 0,
"name": "draw_type",
"value": 1
},
{
"type": 0,
"name": "width",
"value": 30
},
{
"type": 0,
"name": "total_show",
"value": 1
},
{
"type": 0,
"name": "units_show",
"value": 1
},
{
"type": 0,
"name": "graph_time",
"value": 1
},
{
"type": 1,
"name": "time_period.from",
"value": "now-3h"
},
{
"type": 1,
"name": "time_period.to",
"value": "now"
},
{
"type": 0,
"name": "legend_lines",
"value": 4
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
Odpowiedź:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}