Layout

`LO_01`: Display a Single View Layout (Fullscreen)

Version: 1.0.0
Interface: layout
Action: lo_01

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00015`	Enum value out of range

`LO_02`: Display a 2x2 Grid Layout of a Single Instance

Version: 1.0.0
Interface: layout
Action: lo_02

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00015`	Enum value out of range

`LO_03`: Display a 1x3 Layout of a Single Instance

Version: 1.0.0
Interface: layout
Action: lo_03

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00015`	Enum value out of range

`LO_04`: Display a Custom Layout

Version: 1.0.0
Interface: layout
Action: lo_04

Payload Definition

Type: `LayoutData`

{
  "Version": "String",
  "SwitchOnViewChange": "Boolean",
  "PositionData": [
    {
      "Version": "String",
      "ActiveView": "Boolean",
      "DefaultView": "ENUM: ScanView",
      "Anchor": "ENUM: AnchorPoint",
      "Offset": {
        "Version": "String",
        "X": "Float",
        "Y": "Float"
      },
      "AspectRatio": "Float",
      "MaxSize": {
        "Version": "String",
        "X": "Float",
        "Y": "Float"
      },
      "Priority": "Int32"
    }
  ]
}

Example definition

Type: `LayoutData`

{
  "Version": "0.0.1",
  "SwitchOnViewChange": false,
  "PositionData": [
    {
      "Version": null,
      "ActiveView": false,
      "DefaultView": 0,
      "Anchor": 0,
      "Offset": {
        "Version": "1.0.0",
        "X": 0,
        "Y": 0
      },
      "AspectRatio": 0,
      "MaxSize": {
        "Version": "1.0.0",
        "X": 0,
        "Y": 0
      },
      "Priority": 0
    }
  ]
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00015`	Enum value out of range
`F00017`	Default view order for given layout is invalid. Ensure each position has a unique default view.
`F00018`	Active view positioning data is missing. Ensure only one of the position data has "ActiveView" set true.
`F00019`	Multiple active view positions is found. Only one position can be for the active view. Ensure only one of the position data has "ActiveView" set true.
`F00020`	Position data is not found. Ensure position data is provided and format is accurate.