Differences

This shows you the differences between two versions of the page.

--- onboarding:nova:mdctranslatoruiconfig [2022/10/11 12:26] – created 10.91.110.100
+++ onboarding:nova:mdctranslatoruiconfig [2022/10/11 12:44] (current) – 10.91.110.100
@@ Line 1: / Line 1: @@
 ====== MDC Translator Ui Configuration for Nova ======
  --- //[[anna.dowling@errigal.com|Anna Dowling]] 2022/10/11 11:25//
+See also: [[onboarding:mobile:mdctranslatoruiconfig|MDC Translator Ui Configuration for Mobile]]
 ===== Overview =====
@@ Line 9: / Line 11: @@
 If a UiProperty is found on a parameter object, it uses the UiProperty specification to attempt to render the parameter in a card. The same object can be used across both mobile and nova to prevent duplication of technology entries.
-See sample of UiProperty object for mobile below:
+See sample of UiProperty object for nova below:
 <code>
- "uiProperty": [
+"uiProperty": [
                     {
-                        "title": "PSU Current 1",
+                        "title": "Power",
                         "uiType": "GAUGE",
                         "row": 2,
                         "column": 1,
-                        "order": 12,
+                        "order": 1
-                        "uiCategory": "POWER",
-                        "properties": {
-                            "showOnComponent": "true",
-                            "showOnOverView": "true"
-                        }
                     }
                 ],
@@ Line 31: / Line 28: @@
   * **title** - will render on parameter card / list entry instead of prettyName or key if specified
-  *   **uiType** - not needed for mobile but used in nova to show different card types
+  *   **uiType** - used in nova to show different card types
-  *   **row** - not needed for mobile but used in nova to determine how many rows card takes up
+  *   **row** - used in nova to determine how many rows card takes up
-  *   **column** - not needed for mobile but used in nova to determine how many columns card takes up
+  *   **column** - used in nova to determine how many columns card takes up
-  *   **order** - determines card order - used in both apps
+  *   **order** - determines card order on page
-  *   **uiCategory** - used in mobile to customise performanceIcon displayed for parameter. For full list of icons see: [[https://bitbucket.org/errigal/idms-mobile/src/master/src/config/performanceIcons/|performance icons dir]]
+  *   **uiCategory** -
-  *   **properties**: properties are configured via the translator key_value table. Mobile has a few extra properties that can be used to further control the ui. These are:
+  *   **properties**: properties are configured via the translator key_value table, unused in nova currently but can be leveraged to add addiitonal data / configuration to ui components if required.
-      - showOnOverView : boolean - true / false (Controls device overview parameter display. Defaults to true if property not set but UiProperty is found for parameter)
+===== Current Supported Parameter UiTypes in Nova Device Overview =====
-      - showOnComponent: boolean - true / false (Controls component overview parameter display. Defaults to true if property not set but UiProperty is found for parameter and matches component id / discoveredName)
-      - mobileUiTag:  string - RANGE_SLIDER / INPUT_TEXT / INPUT_SELECT (Defaults to '', used on parameter edit card to render different ui types for configuration values)
+  - GAUGE
+  - CHART
+  - AMPLIFIER
+  - 24HRCHART
+  - HORIZONTAL_SLIDER
+  - VERTICAL_SLIDER
+  - STACKED_SLIDER
+  - ANTENNA
+  - MICROWAVE
+  - TEMPERATURE

Sidebar

Internal Errigal Collaboration Wiki

Differences

Sidebar

Internal Errigal Collaboration Wiki

User Tools

Site Tools

Differences

Page Tools