- Overview
- Display Builder
- Display Runner
- Processed Variables
- Widgets
- Actions
- Borders
- Rules
- Scripts
- Macros
- Tuning
Yamcs Studio Release Notes
Source Code Documentation
GUIUtilΒΆ
Helper methods for window-level operations on Yamcs Studio.
- fullScreen()
Enter or exit full-screen.
- openConfirmDialog( message )
Open a confirmation dialog with the given message.
Returns
trueif the user confirmed.- openConfirmDialogAsync( message, onResult )
Open a confirmation dialog with the given message, without blocking the script.
onResultis a function that is called withtrueif the user confirmed,falseotherwise.In the Yamcs web interface, this shows an application dialog, whereas
openConfirmDialogrelies on a browser dialog. Prefer this method for displays that are used in both.- openInformationDialog( message )
Open an information dialog with the given message.
- openWarningDialog( message )
Open a warning dialog with the given message.
- openErrorDialog( message )
Open an error dialog with the given message.
- openPasswordDialog( message, password )
Open a password input dialog.
Returns
trueif the user entered the expected password.Note
OPIs are rendered on the client. The use of this method provides only a false sense of security.
- openPasswordDialogAsync( message, password, onResult )
Open a password input dialog, without blocking the script.
onResultis a function that is called withtrueif the user entered the expected password,falseotherwise.In the Yamcs web interface, this shows an application dialog with a masked input field, whereas
openPasswordDialogrelies on a browser dialog.The note of
openPasswordDialogapplies here too.
Examples
if (GUIUtil.openConfirmDialog("Are you sure?")) {
// Do something clever.
}
GUIUtil.openConfirmDialogAsync("Are you sure?", function (confirmed) {
if (confirmed) {
// Do something clever.
}
});