Widget

The 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

There are 9 types of widgets in SAYMON, 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.

Note that each of the fields below has to be specified inside the parameter field.

counter

Field

Type

Description

metric

String

The name of a metric displayed on the widget.

metricCaption

String

The caption of the displayed metric.

showName

Boolean

Whether to show a metric's caption.

metricAvg

String

The type of transformation applied for metric values. Available options: current, min, avg, max, count, zimsum, dev.

periodAvg

String

The size of a time interval on which metric values should be displayed. Available options:1h, 1d, 1w, 1n, 3n, 1y, custom.

customAvgPeriod

.from

Integer

A starting timestamp for the custom metric time interval.

customAvgPeriod

.to

Integer

An ending timestamp for the custom metric time interval.

bindPeriod

String

The type of a bind used for a metric time interval. Available options: present, calendar.

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.

theme

String

Widget's theme. Available options: minimal, car, train-station.

multiline

Boolean

Whether to use the multiline format to display metrics.

fontSize

Integer

The size of a font used for a multiline metric.

dictionary

String

The name of a dictionary used for metric values.

position

.width

Integer

Widget's width.

position

.height

Integer

Widget's height.

ring

Field

Type

Description

metric

String

The name of the metric displayed on the widget.

metricCaption

String

The caption of the displayed metric.

showName

Boolean

Whether to show a metric's caption.

metricAvg

String

The type of transformation applied for metric values. Available options: current, min, avg, max, count, zimsum, dev.

periodAvg

String

The size of a time interval on which metric values should be displayed. Available options:1h, 1d, 1w, 1n, 3n, 1y, custom.

customAvgPeriod

.from

Integer

A starting timestamp for the custom metric time interval.

customAvgPeriod

.to

Integer

An ending timestamp for the custom metric time interval.

bindPeriod

String

The type of a bind used for a metric time interval. Available options: present, calendar.

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.

position

.width

Integer

Widget's width.

position

.height

Integer

Widget's height.

percent-bar

This widget has the same model as the ring widget.

pie

Field

Type

Description

metric

Array<String>

An array of metrics that should be displayed on the pie widget.

metricCaption

String

The caption of the displayed metrics.

showName

Boolean

Whether to show a metrics' caption.

metricAvg

String

The type of transformation applied for metric values. Available options: current, min, avg, max, count, zimsum, dev.

periodAvg

String

The type of transformation applied for metric values. Available options: current, min, avg, max, count, zimsum, dev.

customAvgPeriod

.from

Integer

A starting timestamp for the custom metric time interval.

customAvgPeriod

.to

Integer

An ending timestamp for the custom metric time interval.

bindPeriod

String

The type of a bind used for a metric time interval. Available options: present, calendar.

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.

position

.width

Integer

Widget's width.

position

.height

Integer

Widget's height.

colors

Array<String>

An array of colors used for metrics of the pie widget.

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.

legend

Boolean

Whether to display a widget's legend.

innerRadius

Integer

The radius of an inner circle.

radar

Field

Type

Description

metric

Array<String>

An array of metrics that should be displayed on the radar widget.

metricCaption

String

The caption of the displayed metrics.

showName

Boolean

Whether to show a metrics' caption.

metricAvg

String

The type of transformation applied for metric values. Available options: current, min, avg, max, count, zimsum, dev.

periodAvg

String

The type of transformation applied for metric values. Available options: current, min, avg, max, count, zimsum, dev.

customAvgPeriod

.from

Integer

A starting timestamp for the custom metric time interval.

customAvgPeriod

.to

Integer

An ending timestamp for the custom metric time interval.

bindPeriod

String

The type of a bind used for a metric time interval. Available options: present, calendar.

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.

position

.width

Integer

Widget's width.

position

.height

Integer

Widget's height.

legend

Boolean

Whether to display a widget's legend.

chart

Field

Type

Description

metric

String

A metric (of several metrics) displayed on the chart widget. The metrics should be specified as a mathematical formula.

chartType

String

The type of a char. Available types: lines, bars.

legend

Boolean

Whether to show a legend on the widget.

duration

Integer

The length of a period on which metrics are displayed. Should be specified in milliseconds.

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.

downsample

Integer

The size of an interval used for downsampling.

position

.width

Integer

Widget's width.

position

.height

Integer

Widget's height.

graph

Field

Type

Description

graphType

String

The type of a graph. Available types: block, blockVert, mindMap, force.

depth

Integer

The depth of a graph.

position

.width

Integer

Widget's width.

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.

section

Field

Type

Description

section

String

The type of a section displayed inside the widget. Available types: stat, properties, documents, state-history, operations-history.

position

.width

Integer

Widget's width.

position

.height

Integer

Widget's height.

operation-widget

Field

Type

Description

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.

color

String

The color of a button displayed on the widget.

position

.width

Integer

Widget's width.

position

.height

Integer

Widget's height.