UI Component
This context allows a individual UI components to be managed. Each UI component also appears in the Component Palette, where it can be used in a Web UI Dashboard. More detail on how to develop a UI Component can be found in Custom UI Components.
Unique Actions
[?]
Configure UI Component
This action is used to edit the properties of a UI component.
Action Type: |
Edit Source
Opens a window to edit the Source property of the UI Component.
Common Actions
[?]
Delete, Make Copy, Replicate, Edit Context Permissions, View Status, Monitor Related Events
Advanced Information |
Context Information
Context Type: UI Component
Context Name: provided by user
Context Description: provided by user
Context Path: users.USER_NAME.uiComponents.UI_COMPONENT_NAME
Context Mask: users.*.uiComponents.*
Context Permissions
[?]
Level | Description |
None | No access allowed. |
Observer | No access allowed. |
Operator | Configuration browsing. |
Manager | UI Component configuration and removal. |
Engineer | Same as Manager. |
Administrator | Same as Manager. |
Public Variables (Properties)
[?]
Common Variables: groupMembership (Group Membership)
Properties
Defines the name and description of the UI Component, as well as giving access to the advanced properties of Source and Compiled Source.
Variable Name: | childInfo |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | 1-50 characters |
description | String | 1-50 characters |
source | String | Source code that defines the appearance and behaviour of the UI Component, integrates data from component variables, processes Component Functions, and can generate Component Events. Read-only. Edited via the Edit Source action. |
compiledSource | String | Read-only |
Component Variables
Definitions of variables that will be available to the UI Component.
Variable Name: | componentVariables |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level. |
Record Format:
Field Name | Field Type | Notes |
name | String | |
description | String | |
format | Data Table | |
writable | Boolean | |
help | String | |
group | String | |
historyRate | Integer |
Component Functions
Definitions of functions that will be available to the UI Component.
Variable Name: | componentFunctions |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | |
description | String | |
inputFormat | Data Table | |
outputFormat | Data Table | |
help | String | |
group | String | |
type | Integer | |
implementation | String | Only available if type indicates a Java implementation. |
expression | String | Only available if type indicates an Expression. |
concurrent | Boolean |
Component Events
Definitions of events that will be available to the UI component.
Variable Name: | componentEvents |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | |
description | String | |
format | Data Table | |
help | String | |
level | Integer | |
group | String |
Dependencies
List of typescript dependencies which can be imported into Source.
Variable Name: | componentDependencies |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | |
link | String | Web URL or a reference to Media Library Server API. |
Default Dependencies
UI components include a set of default dependencies that are available for import in Source.
Name | Type | Notes |
|
| Platform TypeScript/JavaScript SDK shipped with Web UI. |
|
| UI Component utility library shipped with Web UI. |
Public Functions
[?]
This context has no public functions.
Public Events
[?]
Common Events: Child Added, Child Removed, Evaluation, Evaluation Error, Visible Info Changed, Info.
Was this page helpful?