selectedOptions

Description

Defines layout options.

Optional Parameters

• xAxis
  Configures the X axis of the specified chart (for example, line chart or composite chart). Parameters are:

  • label
    Defines the axis label text.

  • ticks
    Specifies the number of tick marks to display. Use "-1" to display the chart's default ticks.

  • visible
    Specifies whether to make the axis visible (true or false).

  • tag
    For XY plots, specifies the fully qualified name of a tag used for the X axis.

    Example:

    "xAxis": {

    "label": "Dallas.Wind Speed",

    "tag": "Weatherapp.Dallas.Wind Speed",

    "ticks": -1,

    "visible": true

    },

• yAxis
  Configures the Y axis of the specified chart (for example, line chart or composite chart). Parameters are:

  • label
    Defines the axis label text.

  • ticks
    Specifies the number of tick marks to display. Use "-1" to display the chart's default ticks.

  • visible
    Specifies whether to make the axis visible (true or false).

  • type
    Specifies the type of Y axis to use -- stacked, single, or multi.

    Example:

    yAxis: {

    "label": "All Tags",

    "ticks": -1,

    "visible": true,

    "type": "stacked"

    }

• limitLine
  Defines a limit line for the chart. Parameters are:

  • position
    Sets the position on the Y axis for the limit line.

  • text
    Defines the limit line text.

  • visible
    Specifies whether the limit line displays on the chart (true or false).

    Example:

    "limitLine": {

    "position": 10,

    "text": "Limit Line Text",

    "visible": false

    }

• legend
  Specifies whether to include a legend for the chart. There is one parameter:

  • visible
    Indicate whether the legend displays (true or false).

    Example:

    "legend": {

    "visible": true

    }

• scaleY
  For a line chart or composite chart, specifies whether the Y axis scales according to the data in the chart.

  Example:

  "scaleY": true

• scaleX
  For an XY plot, specifies whether the X axis scales according to the data in the chart.

  Example:

  "scaleX": true

• lookBack
  For integers in a cumulative sum chart or rolling sum chart, specifies the lookback period.

  Example:

  "lookBack": 7

• units
  In a cumulative sum chart or rolling sum chart, specifies the units used for the lookBack value -- days or hours.

  Example:

  "unit": "hours"

• sortType
  In a summary bar chart, indicates the sorting order for tags. Supported values are:

  • Largest to Smallest

  • Smallest to Largest

  • A-Z

    Example:

    "sortType":"Largest To Smallest"

• displayLines
  For XY plots, specifies whether plot points will be joined with a line.

  Example:

  "displayLines": true

• aggregation
  For a chart that supports value aggregation (such as a column chart), this sets the selected value aggregation for chart. Supported values are:

  average integral (analog tags only) last maximum

  meter (analog tags only) minimum summary (non-analog tags only) total (non-analog tags only)

  Example:

  "aggregation": "Maximum"

• map
  For map charts, this sets the selected value aggregation for chart. Parameters are:

  • zoomLevel
    Specifies the zoom level of the map. If not specified or invalid, the chart automatically zooms to fit all tags.

    Example:

    "zoomLevel": 10,

  • center
    Specifies the geolocation for the center of the map, specified with longitude and latitude.

    Example:

    "center": {

    "Longitude": -110.44413636978399,

    "Latitude": 48.38785248165351

    }

• SliceByTag
  For column charts, this sets an event aggregate for the specified non-analog tag. The value must be a fully qualified tag name.

  Example:
  "sliceByTag": "Weather.Auckland.Clouds",

Sample

"LayoutProperties": {

"selectedOptions": {

"xAxis": {

"label": "DateTime",

"ticks": -1,

"visible": true

},

"yAxis": {

"label": "All Tags",

"ticks": -1,

"visible": true,

"type": "stacked"

},

"limitLine": {

"position": 10,

"text": "Limit Line Text",

"visible": false

},

"legend": {

"visible": true

},

"scaleY": true,

"map": {

"zoomLevel": 10,

"center": {

"Longitude": -110.44413636978399,

"Latitude": 48.38785248165351

}

}

}

}