search

visit-dav / visit

VisIt - Visualization and Data Analysis for Mesh-based Scientific Data
https://visit.llnl.gov
BSD 3-Clause "New" or "Revised" License
432 stars 111 forks source link

Implement logging (or document API) for `SetAnnotationObjectOptions` #19764

Open vsisl opened 1 month ago

vsisl commented 1 month ago

Is your feature request related to a problem?

Hello everyone

I use VisIt in an automated way. I generate scripts and then run VisIt in the CLI mode. To build my scripts, I use the GUI feature "Controls -> Command ... -> Record" to record a scripts based on manual actions in the GUI. This feature is great and allowed me to build fairly complex plotting pipelines.

Now I face a surprising problem. I wanted to add a simple text annotation to my plot. I used the GUI menu "Controls -> Annotations... -> Objects -> Text". When I tried to view the script needed for doing the same in an automated way, I found the following message:

"Logging for SetAnnotationObjectOptions is not implemented yet."
Screenshot 2024-08-23 at 16 33 45

Also documentation did not help.

Is your feature request specific to a data set?

No.

Describe the solution you'd like.

I see two possible solutions:

1) Implement the logging mechanism for the SetAnnotationObjectOptions objecto so that the "Controls -> Command ... -> Record" feature can be used.

2) Add a documentation of this particular API so that it's clear how to add text annotations using a script.

Describe alternatives you've considered.

I tried to find other ways how I could add a custom text to the plot. I expected there will be e.g. an option to add a title to the legend or to override the database annotation with custom text. None of these worked for me.

Additional context

None.

Thank you for your effort developing VisIt!

JustinPrivitera commented 1 week ago

Additionally, it would be good to add logging of CreateAnnotationObject and/or correct the following message: logging for AddAnnotaionObject is not implemented yet. AddAnnotaionObject doesn't exist.