From d4354e7e22ff8e1526c190f28120b163c6defa0f Mon Sep 17 00:00:00 2001 From: Jamie V Date: Thu, 10 Apr 2025 10:43:01 -0700 Subject: [PATCH] tweak priorities for inspector views, added new priority constants HIGHEST/LOWEST, update docs --- API.md | 12 ++++++++++++ .../plugins/notebook/notebookTags.e2e.spec.js | 4 +++- src/api/priority/PriorityAPI.js | 5 ++++- .../inspector/ScatterPlotInspectorViewProvider.js | 2 +- .../FaultManagementInspectorViewProvider.js | 2 +- .../annotations/AnnotationsViewProvider.js | 2 +- .../properties/PropertiesViewProvider.js | 2 +- .../plan/inspector/ActivityInspectorViewProvider.js | 2 +- .../inspector/GanttChartInspectorViewProvider.js | 2 +- .../plot/inspector/PlotsInspectorViewProvider.js | 2 +- .../inspector/StackedPlotsInspectorViewProvider.js | 2 +- .../telemetryTable/TableConfigurationViewProvider.js | 2 +- .../inspector/TimeListInspectorViewProvider.js | 2 +- 13 files changed, 29 insertions(+), 12 deletions(-) diff --git a/API.md b/API.md index 40d8b7a178..e607deeb3c 100644 --- a/API.md +++ b/API.md @@ -31,6 +31,10 @@ - [`latest` request strategy](#latest-request-strategy) - [`minmax` request strategy](#minmax-request-strategy) - [Telemetry Formats](#telemetry-formats) + - [Built-in Formats](#built-in-formats) + - [**Number Format (default):**](#number-format-default) + - [**String Format**](#string-format) + - [**Enum Format**](#enum-format) - [Registering Formats](#registering-formats) - [Telemetry Data](#telemetry-data) - [Telemetry Datums](#telemetry-datums) @@ -59,6 +63,12 @@ - [Custom Indicators](#custom-indicators) - [Priority API](#priority-api) - [Priority Types](#priority-types) + - [User API](#user-api) + - [Example](#example) + - [Visibility-Based Rendering in View Providers](#visibility-based-rendering-in-view-providers) + - [Overview](#overview) + - [Implementing Visibility-Based Rendering](#implementing-visibility-based-rendering) + - [Example](#example-1) @@ -1301,9 +1311,11 @@ Open MCT provides some built-in priority values that can be used in the applicat Currently, the Open MCT Priority API provides (type: numeric value): +- HIGHEST: Infinity - HIGH: 1000 - Default: 0 - LOW: -1000 +- LOWEST: -Infinity View provider Example: diff --git a/e2e/tests/functional/plugins/notebook/notebookTags.e2e.spec.js b/e2e/tests/functional/plugins/notebook/notebookTags.e2e.spec.js index 4c86a2a97f..a0c9d6e50d 100644 --- a/e2e/tests/functional/plugins/notebook/notebookTags.e2e.spec.js +++ b/e2e/tests/functional/plugins/notebook/notebookTags.e2e.spec.js @@ -65,9 +65,11 @@ test.describe('Tagging in Notebooks @addInit', () => { }); test('Can add tags with blank entry', async ({ page }) => { await createDomainObjectWithDefaults(page, { type: 'Notebook' }); - await page.getByRole('tab', { name: 'Annotations' }).click(); await enterTextEntry(page, ''); + + await page.getByRole('tab', { name: 'Annotations' }).click(); + await page.hover(`button:has-text("Add Tag")`); await page.locator(`button:has-text("Add Tag")`).click(); diff --git a/src/api/priority/PriorityAPI.js b/src/api/priority/PriorityAPI.js index 8d915b1e1f..e82ff8f3f8 100644 --- a/src/api/priority/PriorityAPI.js +++ b/src/api/priority/PriorityAPI.js @@ -21,8 +21,11 @@ *****************************************************************************/ const PRIORITIES = Object.freeze({ + HIGHEST: Infinity, HIGH: 1000, DEFAULT: 0, - LOW: -1000 + LOW: -1000, + LOWEST: -Infinity }); + export default PRIORITIES; diff --git a/src/plugins/charts/scatter/inspector/ScatterPlotInspectorViewProvider.js b/src/plugins/charts/scatter/inspector/ScatterPlotInspectorViewProvider.js index 44bdff2ab7..dc11b6650e 100644 --- a/src/plugins/charts/scatter/inspector/ScatterPlotInspectorViewProvider.js +++ b/src/plugins/charts/scatter/inspector/ScatterPlotInspectorViewProvider.js @@ -40,7 +40,7 @@ export default function ScatterPlotInspectorViewProvider(openmct) { _destroy = destroy; }, priority: function () { - return openmct.editor.isEditing() ? openmct.priority.HIGH + 1 : openmct.priority.DEFAULT; + return openmct.editor.isEditing() ? openmct.priority.HIGH : openmct.priority.DEFAULT; }, destroy: function () { if (_destroy) { diff --git a/src/plugins/faultManagement/FaultManagementInspectorViewProvider.js b/src/plugins/faultManagement/FaultManagementInspectorViewProvider.js index 4e5902925a..6f65fc8a9a 100644 --- a/src/plugins/faultManagement/FaultManagementInspectorViewProvider.js +++ b/src/plugins/faultManagement/FaultManagementInspectorViewProvider.js @@ -63,7 +63,7 @@ export default function FaultManagementInspectorViewProvider(openmct) { _destroy = destroy; }, priority: function () { - return openmct.priority.HIGH + 1; + return openmct.priority.HIGH; }, destroy: function () { if (_destroy) { diff --git a/src/plugins/inspectorViews/annotations/AnnotationsViewProvider.js b/src/plugins/inspectorViews/annotations/AnnotationsViewProvider.js index 4f7d9d19bf..dedd7b5156 100644 --- a/src/plugins/inspectorViews/annotations/AnnotationsViewProvider.js +++ b/src/plugins/inspectorViews/annotations/AnnotationsViewProvider.js @@ -77,7 +77,7 @@ export default function AnnotationsViewProvider(openmct) { }, priority: function () { if (isNotebookEntry) { - return openmct.priority.HIGH + 1; + return openmct.priority.HIGHEST; } if (isConditionSet) { diff --git a/src/plugins/inspectorViews/properties/PropertiesViewProvider.js b/src/plugins/inspectorViews/properties/PropertiesViewProvider.js index 8053a9e2ae..2ecb1cc01e 100644 --- a/src/plugins/inspectorViews/properties/PropertiesViewProvider.js +++ b/src/plugins/inspectorViews/properties/PropertiesViewProvider.js @@ -58,7 +58,7 @@ export default function PropertiesViewProvider(openmct) { _destroy = destroy; }, priority: function () { - return openmct.editor.isEditing() ? openmct.priority.LOW : openmct.priority.HIGH + 2; + return openmct.editor.isEditing() ? openmct.priority.LOW : openmct.priority.HIGH; }, destroy: function () { if (_destroy) { diff --git a/src/plugins/plan/inspector/ActivityInspectorViewProvider.js b/src/plugins/plan/inspector/ActivityInspectorViewProvider.js index e4cbe982f2..c44e06fefc 100644 --- a/src/plugins/plan/inspector/ActivityInspectorViewProvider.js +++ b/src/plugins/plan/inspector/ActivityInspectorViewProvider.js @@ -62,7 +62,7 @@ export default function ActivityInspectorViewProvider(openmct) { _destroy = destroy; }, priority: function () { - return openmct.priority.HIGH + 1; + return openmct.priority.HIGH; }, destroy: function () { if (_destroy) { diff --git a/src/plugins/plan/inspector/GanttChartInspectorViewProvider.js b/src/plugins/plan/inspector/GanttChartInspectorViewProvider.js index 23f63992e8..7499ca1b6d 100644 --- a/src/plugins/plan/inspector/GanttChartInspectorViewProvider.js +++ b/src/plugins/plan/inspector/GanttChartInspectorViewProvider.js @@ -62,7 +62,7 @@ export default function GanttChartInspectorViewProvider(openmct) { _destroy = destroy; }, priority: function () { - return openmct.editor.isEditing() ? openmct.priority.HIGH + 1 : openmct.priority.DEFAULT; + return openmct.editor.isEditing() ? openmct.priority.HIGH : openmct.priority.DEFAULT; }, destroy: function () { if (_destroy) { diff --git a/src/plugins/plot/inspector/PlotsInspectorViewProvider.js b/src/plugins/plot/inspector/PlotsInspectorViewProvider.js index c5bd07f6a7..ec906c8190 100644 --- a/src/plugins/plot/inspector/PlotsInspectorViewProvider.js +++ b/src/plugins/plot/inspector/PlotsInspectorViewProvider.js @@ -52,7 +52,7 @@ export default function PlotsInspectorViewProvider(openmct) { _destroy = destroy; }, priority: function () { - return openmct.priority.HIGH + 1; + return openmct.priority.DEFAULT; }, destroy: function () { if (_destroy) { diff --git a/src/plugins/plot/inspector/StackedPlotsInspectorViewProvider.js b/src/plugins/plot/inspector/StackedPlotsInspectorViewProvider.js index 21507adb1d..3ef6aba827 100644 --- a/src/plugins/plot/inspector/StackedPlotsInspectorViewProvider.js +++ b/src/plugins/plot/inspector/StackedPlotsInspectorViewProvider.js @@ -50,7 +50,7 @@ export default function StackedPlotsInspectorViewProvider(openmct) { _destroy = destroy; }, priority: function () { - return openmct.editor.isEditing() ? openmct.priority.HIGH + 1 : openmct.priority.DEFAULT; + return openmct.editor.isEditing() ? openmct.priority.HIGH : openmct.priority.DEFAULT; }, destroy: function () { if (_destroy) { diff --git a/src/plugins/telemetryTable/TableConfigurationViewProvider.js b/src/plugins/telemetryTable/TableConfigurationViewProvider.js index 3802778988..c8a290c1e3 100644 --- a/src/plugins/telemetryTable/TableConfigurationViewProvider.js +++ b/src/plugins/telemetryTable/TableConfigurationViewProvider.js @@ -69,7 +69,7 @@ export default function TableConfigurationViewProvider(openmct, options) { return true; }, priority: function () { - return openmct.editor.isEditing() ? openmct.priority.HIGH + 1 : openmct.priority.DEFAULT; + return openmct.editor.isEditing() ? openmct.priority.HIGH : openmct.priority.DEFAULT; }, destroy: function () { if (_destroy) { diff --git a/src/plugins/timelist/inspector/TimeListInspectorViewProvider.js b/src/plugins/timelist/inspector/TimeListInspectorViewProvider.js index bd876d2c6a..e5dc3a512d 100644 --- a/src/plugins/timelist/inspector/TimeListInspectorViewProvider.js +++ b/src/plugins/timelist/inspector/TimeListInspectorViewProvider.js @@ -63,7 +63,7 @@ export default function TimeListInspectorViewProvider(openmct) { _destroy = destroy; }, priority: function () { - return openmct.editor.isEditing() ? openmct.priority.HIGH + 1 : openmct.priority.DEFAULT; + return openmct.editor.isEditing() ? openmct.priority.HIGH : openmct.priority.DEFAULT; }, destroy: function () { if (_destroy) {