Skip to content

Commit

Permalink
Add title note to event format docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dgarciabriseno committed May 29, 2024
1 parent e7346e9 commit f14d4aa
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/src/source/appendix/helioviewer_event_format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ The data field is where the actual event specific data goes.
| views | | List of views into the data. |
| | | This is parsed into the tabs that appear on Helioviewer |
+----------+---------------------------------------------------------------------------+
| title | Event information dialog popup title |
+----------+---------------------------------------------------------------------------+

The event object allows normalized positioning and labeling for any type of event while still containing the event-specific data.
Helioviewer is using this format for all features and events.
Expand Down

0 comments on commit f14d4aa

Please sign in to comment.