> Graph object

The following objects are directly related to the graph API.

Graph

The graph object has the following properties.

PropertyTypeDescription
graphidstringID of the graph.

Property behavior:
- read-only
- required for update operations
heightintegerHeight of the graph in pixels.

Property behavior:
- required for create operations
namestringName of the graph.

Property behavior:
- required for create operations
widthintegerWidth of the graph in pixels.

Property behavior:
- required for create operations
flagsintegerOrigin of the graph.

Possible values:
0 - (default) a plain graph;
4 - a discovered graph.

Property behavior:
- read-only
graphtypeintegerGraph’s layout type.

Possible values:
0 - (default) normal;
1 - stacked;
2 - pie;
3 - exploded.
percent_leftfloatLeft percentile.

Default: 0.
percent_rightfloatRight percentile.

Default: 0.
show_3dintegerWhether to show pie and exploded graphs in 3D.

Possible values:
0 - (default) show in 2D;
1 - show in 3D.
show_legendintegerWhether to show the legend on the graph.

Possible values:
0 - hide;
1 - (default) show.
show_work_periodintegerWhether to show the working time on the graph.

Possible values:
0 - hide;
1 - (default) show.
show_triggersintegerWhether to show the trigger line on the graph.

Possible values:
0 - hide;
1 - (default) show.
templateidstringID of the parent template graph.

Property behavior:
- read-only
yaxismaxfloatThe fixed maximum value for the Y axis.

Default: 100.
yaxisminfloatThe fixed minimum value for the Y axis.

Default: 0.
ymax_itemidstringID of the item that is used as the maximum value for the Y axis.

If a user has no access to the specified item, the graph is rendered as if ymax_type is set to “calculated”.
ymax_typeintegerMaximum value calculation method for the Y axis.

Possible values:
0 - (default) calculated;
1 - fixed;
2 - item.
ymin_itemidstringID of the item that is used as the minimum value for the Y axis.

If a user has no access to the specified item, the graph is rendered as if ymin_type is set to “calculated”.
ymin_typeintegerMinimum value calculation method for the Y axis.

Possible values:
0 - (default) calculated;
1 - fixed;
2 - item.
uuidstringUniversal unique identifier, used for linking imported graphs to already existing ones. Auto-generated, if not given.

Property behavior:
- supported if the graph belongs to a template