AppInterface.set_scen_attach_hidden
AppInterface.set_scen_attach_hidden |
Purpose
Mark an existing scenario attachment as hidden or visible in the Xpress Insight UI.
Synopsis
set_scen_attach_hidden(self, filename: str, hidden: bool) -> None
Arguments
|
filename
|
The filename of the scenario attachment to hide or show.
|
|
hidden
|
If
True, the attachment will be hidden in the Xpress Insight UI; if
False, it will be visible.
|
Example
Example of hiding of a scenario attachment
my_attach.dat
>>> insight.set_scen_attach_hidden('my_attach.dat', True)
... if insight.attach_status == AttachStatus.OK:
... print("Attachment hidden ok")
... else:
... print("Error hiding attachment")
Further information
1. Check the attachment status code using
insight.attach_status to determine whether the update was successful.
2. The attachment will not be updated on the Insight server until the scenario completes.
3. Attempting to access attachments when the model is not being run through Xpress Insight will cause the model to abort with an error.
Related topics