Layout

Description

This object is used to configure the chart layout. Each Layout object represents the engineering unit group displayed on the left panel. Layout object is used to decide which layout will be selected/active when content is opened, should chart display in stack single or multi axis y mode and another configuration related to the chart.

For example, the LayoutProperties object in following post data is used to display line chart in All Numeric group in stack mode, with limit line visible and Y-axis scaled to data available in it.

Required Parameters

• Name
  Names the tag group to be used this layout. These are possible values:

  • For analog tags listed in the Tags parameter:
    The name of any tag group for a specific unit of measure.

  • For non-analog tags listed in the Tags parameter:
    "" (An empty string), specifying the "String data" tag group will be used.

  • If isActiveGroup is set to true
    "All Numeric".

• isActiveGroup
  Indicate whether this layout is active. These are possible values:

  "IsActiveGroup":"true",

  "IsActiveGroup":"false",

  "IsActiveGroup":""

• LayoutProperties
  Contains a set of options for the layout. See LayoutProperties.

• TimeAggregate
  For charts that support time aggregation (such as column charts), specifies the time aggregation. Supported values are:

  • 1 = Day

  • 2 = Hour

  • 3 = 15-minute

  • 4 = Event (only applicable for column charts using sliceBy)

    Example:

    "TimeAggregate": "1"