A ScreenDefinition document defines the layout of a screen / page to display. The document contains some global properties of the screen and an array of ScreenElement objects, which each define one UI widget with its properties.
With the sat-nms software there are two general types of screen definitions: 'user defined screens' and 'device screens'. While the first type may contain widgets which show parameters of any device controlled by the sat-nms M&C are 'device screens' bound to one particular device. Device screens are returned by a GET /api/v1/dscreens/{name} call, user screens by a GET /api/v1/uscreens/{name} call.
Data Model
| Key | Type | Value |
|---|---|---|
| name | String | The file name of the screen definition |
| deviceRelative | Boolean | true = contains no device IDs, the front end application must add the device ID from the context of the screen |
| width | Number | Width of the screen (pixels in the Java client) |
| height | Number | Height of the screen (pixels in the Java client) |
| bgImage | String | Name of a background image to draw in the screen. An empty value states that there is no background image. |
| noEditTake | Boolean | true = exclude this screen from global edit/take if this feature has been set for the UI. |
| elements | Array | Contains ScreenElement objects, the list of the screen elements contained in this screen. |