> Graph prototype object

The following objects are directly related to the graphprototype API.

Graph prototype

The graph prototype object has the following properties.

PropertyTypeDescription
graphidstringID of the graph prototype.

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

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

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

Property behavior:
- required for create operations
graphtypeintegerGraph prototypes’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 discovered 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 discovered graph.

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

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

Property behavior:
- read-only
yaxismaxfloatThe fixed maximum value for the Y axis.
yaxisminfloatThe fixed minimum value for the Y axis.
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.
discoverintegerGraph prototype discovery status.

Possible values:
0 - (default) new graphs will be discovered;
1 - new graphs will not be discovered and existing graphs will be marked as lost.
uuidstringUniversal unique identifier, used for linking imported graph prototypes to already existing ones. Auto-generated, if not given.

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