Widget

Widgets allow you to display metrics in the standard view of the SAYMON UI.

Widgets are a part of entity's client data.

Widget Model

Field	Type	Description
id	String	Widget's ID.
type	String	Widget's type.
parameters	Object	A set of widget's parameters.

Widgets' Types

SAYMON provides 10 types of widgets, each having its own set of parameters. Below you can find the names of widgets' types (shown as a header) along with a set of parameters for each of the widgets.

Widget settings described below are defined in the parameter field.

counter

Counter widget displays the text and numeric values from the Data table.

Field	Type	Description
bindPeriod	String	The type of a bind used for a metric time interval. Available options: present, calendar.
customAvgPeriod.from	Integer	A starting timestamp for the custom metric time interval.
customAvgPeriod.to	Integer	An ending timestamp for the custom metric time interval.
dictionary	String	The name of a dictionary used for metric values.
fontSize	Integer	The size of a font used for a multiline metric.
metric	String	The name of a metric displayed on the widget.
metricAvg	String	The type of transformation applied for metric values. Available options: current, min, avg, max, count, zimsum, dev.
metricCaption	String	The caption of the displayed metric.
multiline	Boolean	Whether to use the multiline format to display metrics.
periodAvg	String	The size of a time interval on which metric values should be displayed. Available options:1h, 1d, 1w, 1n, 3n, 1y, custom.
position.height	Integer	Widget's height.
position.width	Integer	Widget's width.
showBefore	Boolean	Whether to show metrics for a previous period.
showBeforeTimes	Integer	The offset that should be used to show metrics for a previous period.
showName	Boolean	Whether to show a metric's caption.
theme	String	Widget's theme. Available options: minimal, car, train-station.

ring

Ring widget displays percentage values from the Data table.

Field	Type	Description
bindPeriod	String	The type of a bind used for a metric time interval. Available options: present, calendar.
customAvgPeriod.from	Integer	A starting timestamp for the custom metric time interval.
customAvgPeriod.to	Integer	An ending timestamp for the custom metric time interval.
metric	String	The name of the metric displayed on the widget.
metricAvg	String	The type of transformation applied for metric values. Available options: current, min, avg, max, count, zimsum, dev.
metricCaption	String	The caption of the displayed metric.
periodAvg	String	The size of a time interval on which metric values should be displayed. Available options:1h, 1d, 1w, 1n, 3n, 1y, custom.
position.height	Integer	Widget's height.
position.width	Integer	Widget's width.
showBefore	Boolean	Whether to show metrics for a previous period.
showBeforeTimes	Integer	The offset that should be used to show metrics for a previous period.
showName	Boolean	Whether to show a metric's caption.

percent-bar

Percent bar (or level) displays percentage values from the Data table.

This widget has the same model as the ring widget.

pie

Pie chart widget allows to choose and compare several metrics from one object or several metrics with the same names from several objects.

Field	Type	Description
bindPeriod	String	The type of a bind used for a metric time interval. Available options: present, calendar.
colors	Array<String>	An array of colors used for metrics of the pie widget.
customAvgPeriod.from	Integer	A starting timestamp for the custom metric time interval.
customAvgPeriod.to	Integer	An ending timestamp for the custom metric time interval.
innerRadius	Integer	The radius of an inner circle.
legend	Boolean	Whether to display a widget's legend.
metric	Array<String>	An array of metrics that should be displayed on the pie widget.
metricAvg	String	The type of transformation applied for metric values. Available options: current, min, avg, max, count, zimsum, dev.
metricCaption	String	The caption of the displayed metrics.
periodAvg	String	The type of transformation applied for metric values. Available options: current, min, avg, max, count, zimsum, dev.
position.height	Integer	Widget's height.
position.width	Integer	Widget's width.
sectorLabel	String	The type of a label used for pie widget metrics. Available options: none, percent, value, entity.
sectorLabelColor	String	The color of a section label.
showBefore	Boolean	Whether to show metrics for a previous period.
showBeforeTimes	Integer	The offset that should be used to show metrics for a previous period.
showName	Boolean	Whether to show a metrics' caption.

radar

Radar widget allows you to display and compare metrics of multiple entities.

Field	Type	Description
bindPeriod	String	The type of a bind used for a metric time interval. Available options: present, calendar.
customAvgPeriod.from	Integer	A starting timestamp for the custom metric time interval.
customAvgPeriod.to	Integer	An ending timestamp for the custom metric time interval.
legend	Boolean	Whether to display a widget's legend.
metric	Array<String>	An array of metrics that should be displayed on the radar widget.
metricAvg	String	The type of transformation applied for metric values. Available options: current, min, avg, max, count, zimsum, dev.
metricCaption	String	The caption of the displayed metrics.
periodAvg	String	The type of transformation applied for metric values. Available options: current, min, avg, max, count, zimsum, dev.
position.height	Integer	Widget's height.
position.width	Integer	Widget's width.
showBefore	Boolean	Whether to show metrics for a previous period.
showBeforeTimes	Integer	The offset that should be used to show metrics for a previous period.
showName	Boolean	Whether to show a metrics' caption.

chart

Chart widget allows you to plot a graph based on a specified metric.

Field	Type	Description
chartType	String	The type of a char. Available types: lines, bars.
downsample	Integer	The size of an interval used for downsampling.
duration	Integer	The length of a period on which metrics are displayed. Should be specified in milliseconds.
legend	Boolean	Whether to show a legend on the widget.
metric	String	A metric (of several metrics) displayed on the chart widget. The metrics should be specified as a mathematical formula.
movingAverage	Boolean	Whether to use a moving average on a chart.
movingAveragePeriod	Integer	The length of an interval on which a moving average should be calculated.
position.height	Integer	Widget's height.
position.width	Integer	Widget's width.

graph

Graph widget displays the relations of object's child entities.

Field	Type	Description
depth	Integer	The depth of a graph.
graphType	String	The type of a graph. Available types: block, blockVert, mindMap, force.
position.height	Integer	Widget's height.
position.scale	Integer	The scale of a graph.
position.translation	Array<Integer>	The coordinates of a graph inside the widget.
position.width	Integer	Widget's width.

section

Section widget allows you to display a section from an end view

Field	Type	Description
position.height	Integer	Widget's height.
position.width	Integer	Widget's width.
section	String	The type of a section displayed inside the widget. Available types: stat, properties, documents, state-history, operations-history.

operation-widget

Operation widget is a button that performs a specified operation.

Field	Type	Description
color	String	The color of a button displayed on the widget.
operation	String	The ID of an operation. This operation will be executed after the user clicks the button on the widget.
operationCaption	String	Operation's caption.
position.height	Integer	Widget's height.
position.width	Integer	Widget's width.

iframe

Iframe widget allows to embed content from other resources to the system web interface.

Field	Type	Description
src	String	URL of the page shown in an iframe.
type	String	MIME type of the media shown in an iframe.
position.height	Integer	Widget's height.
position.width	Integer	Widget's width.