-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enhancements for Derived Telemetry object
- Closes #7823 - Added new `ObjectPathString.vue` UI component, based on `ObjectPath.vue`.
- Loading branch information
1 parent
cce3008
commit 2793da4
Showing
1 changed file
with
171 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,171 @@ | ||
<!-- | ||
Open MCT, Copyright (c) 2014-2024, United States Government | ||
as represented by the Administrator of the National Aeronautics and Space | ||
Administration. All rights reserved. | ||
Open MCT is licensed under the Apache License, Version 2.0 (the | ||
"License"); you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0. | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
License for the specific language governing permissions and limitations | ||
under the License. | ||
Open MCT includes source code licensed under additional open source | ||
licenses. See the Open Source Licenses file (LICENSES.md) included with | ||
this source code distribution or the Licensing information page available | ||
at runtime from the About dialog for additional information. | ||
--> | ||
|
||
<template> | ||
<div | ||
v-if="orderedPath.length" | ||
class="c-object-path-string" | ||
:aria-label="`${domainObject.name}`" | ||
role="navigation" | ||
> | ||
{{ orderedPathStr }} | ||
</div> | ||
</template> | ||
|
||
<script> | ||
// import ObjectLabel from './ObjectLabel.vue'; | ||
export default { | ||
inject: ['openmct'], | ||
props: { | ||
domainObject: { | ||
type: Object, | ||
required: true | ||
}, | ||
readOnly: { | ||
type: Boolean, | ||
required: false, | ||
default() { | ||
return false; | ||
} | ||
}, | ||
showObjectItself: { | ||
type: Boolean, | ||
required: false, | ||
default() { | ||
return false; | ||
} | ||
}, | ||
objectPath: { | ||
type: Array, | ||
default() { | ||
return null; | ||
} | ||
} | ||
}, | ||
data() { | ||
return { | ||
orderedPath: [], | ||
orderedPathStr: '' | ||
}; | ||
}, | ||
async mounted() { | ||
this.abortController = new AbortController(); | ||
this.nameChangeListeners = {}; | ||
const keyString = this.openmct.objects.makeKeyString(this.domainObject.identifier); | ||
if (keyString && this.keyString !== keyString) { | ||
this.keyString = keyString; | ||
this.originalPath = []; | ||
let rawPath = null; | ||
if (this.objectPath === null) { | ||
try { | ||
rawPath = await this.openmct.objects.getOriginalPath( | ||
keyString, | ||
[], | ||
this.abortController.signal | ||
); | ||
} catch (error) { | ||
// aborting the search is ok, everything else should be thrown | ||
if (error.name !== 'AbortError') { | ||
throw error; | ||
} | ||
} | ||
} else { | ||
rawPath = this.objectPath; | ||
} | ||
const pathWithDomainObject = rawPath.map((domainObject, index, pathArray) => { | ||
let key = this.openmct.objects.makeKeyString(domainObject.identifier); | ||
const objectPath = pathArray.slice(index); | ||
return { | ||
domainObject, | ||
key, | ||
objectPath | ||
}; | ||
}); | ||
if (this.showObjectItself) { | ||
// remove ROOT only | ||
this.orderedPath = pathWithDomainObject.slice(0, pathWithDomainObject.length - 1).reverse(); | ||
} else { | ||
// remove ROOT and object itself from path | ||
this.orderedPath = pathWithDomainObject.slice(1, pathWithDomainObject.length - 1).reverse(); | ||
} | ||
this.orderedPath.forEach((pathObject) => { | ||
this.orderedPathStr = this.orderedPathStr.concat('/').concat(pathObject.domainObject.name); | ||
// this.addNameListenerFor(pathObject.domainObject); | ||
}); | ||
} | ||
}, | ||
unmounted() { | ||
if (this.abortController) { | ||
this.abortController.abort(); | ||
} | ||
Object.values(this.nameChangeListeners).forEach((unlisten) => { | ||
unlisten(); | ||
}); | ||
}, | ||
methods: { | ||
/** | ||
* Generate the hash url for the given object path, removing the '/ROOT' prefix if present. | ||
* @param {import('../../api/objects/ObjectAPI').DomainObject[]} objectPath | ||
*/ | ||
navigateToPath(objectPath) { | ||
/** @type {string} */ | ||
const path = `/browse/${this.openmct.objects.getRelativePath(objectPath)}`; | ||
return path.replace('ROOT/', ''); | ||
}, | ||
updateObjectPathName(keyString, newName) { | ||
this.orderedPath = this.orderedPath.map((pathObject) => { | ||
if (this.openmct.objects.makeKeyString(pathObject.domainObject.identifier) === keyString) { | ||
return { | ||
...pathObject, | ||
domainObject: { ...pathObject.domainObject, name: newName } | ||
}; | ||
} | ||
return pathObject; | ||
}); | ||
}, | ||
removeNameListenerFor(domainObject) { | ||
const keyString = this.openmct.objects.makeKeyString(domainObject.identifier); | ||
if (this.nameChangeListeners[keyString]) { | ||
this.nameChangeListeners[keyString](); | ||
delete this.nameChangeListeners[keyString]; | ||
} | ||
}, | ||
addNameListenerFor(domainObject) { | ||
const keyString = this.openmct.objects.makeKeyString(domainObject.identifier); | ||
if (!this.nameChangeListeners[keyString]) { | ||
this.nameChangeListeners[keyString] = this.openmct.objects.observe( | ||
domainObject, | ||
'name', | ||
this.updateObjectPathName.bind(this, keyString) | ||
); | ||
} | ||
} | ||
} | ||
}; | ||
</script> |