Differences

This shows you the differences between two versions of the page.

--- visual3d:documentation:pipeline:report_commands:add_graph_annotation [2025/04/29 13:37] – Cleaned up page, reordering parameters. wikisysop
+++ visual3d:documentation:pipeline:report_commands:add_graph_annotation [2025/09/08 17:11] (current) – wikisysop
@@ Line 1: / Line 1: @@
 ====== Add Graph Annotation ======
-[[Visual3D:Documentation:Reports:Report_2D_Graph#Annotations|Graph annotations]], which can be manually modified by using the annotations button on the Add/Modify Graph pop up dialog, can also be added using the Add_Graph_Annotation pipeline command.
+=====Overview=====
+[[Visual3D:Documentation:Reports:Report_2D_Graph#Annotations|Graph annotations]], which can be manually modified by using the annotations button on the Add/Modify Graph pop up dialog, can also be added using the Add_Graph_Annotation pipeline command.\\
+Annotations like setting the graph title, changing graph properties such as line colour/ line style and size can be done using this pipeline command.
+=====Pipeline Command=====
 <code>
 Add_Graph_Annotation
@@ Line 18: / Line 22: @@
 </code>
-===== Parameters =====
+===== Command Parameters =====
 The Page_Number, Column_Number, and Row_Number parameters are used to specify the location of the graph to be modified by the command.
@@ Line 64: / Line 68: @@
   - a number indicating the percent of the range
   - an event label, such that the event labels in all graphs are added
-==== Annotation_Style ====
 The following options are available:
-  - TICKS
-  - Top TICKS
-  - Bottom TICKS
-  - Vertical Line
-  - Box
-  - Triangle
-  - Cross
-  - Up Arrow
-  - Down Arrow
-==== Annotation_Color ====
+^Annotation_Style^Annotation_Color^Annotation Size^
+|TICKS| Black|Normal|
-The following options are available:
+|Top TICKS|Blue|Small|
-  - Black
+|Bottom TICKS|Cyan|Large|
-  - Blue
+|Vertical Line|Green|
-  - Cyan
+|Box|Purple|
-  - Green
+|Triangle|Red|
-  - Purple
+|Cross|Yellow|
-  - Red
+|Up Arrow|
-  - Yellow
+|Down Arrow|
-==== Annotation Size ====
-The following options are available:
-  - Normal
-  - Large
-  - Small
 ==== Annotation Global ====
-When set to **FALSE** will add graph annotation to only the graphs at the specified location (for example row 1 column 1) **based on the DRAW_ORDER.**
+When set to **FALSE** will add graph annotation to only the graphs at the specified location and on a specific line on the graph (for example row 1 column 1) **based on the DRAW_ORDER.**
 |<code>
@@ Line 115: / Line 101: @@
 </code>|{{:GraphAnnotation_GlobalFALSE.jpg}}|
-When set to **TRUE** will add graph annotation to all graphs at the specified location (for example, at row 1, column 1), **regardless of DRAW_ORDER.**
+When set to **TRUE** will add graph annotation to the graph at the DRAW_ORDER but find the ANOTATION_EVENT on all lines on specified on the graph (for example, at row 1, column 1).
 |<code>
@@ Line 173: / Line 159: @@
 Modifying the ANNOTATION_AVERAGE_EVENT is similar to using the "All Graphs" or "Average Event or Numeric Value" radial box when [[Visual3D:Documentation:Reports:Report_2D_Graph#Annotations|manually adding an annotation]].
+=====Dialog=====
 {{:GraphAnnotation_AverageEvent.jpg}}
+===== See Also =====
+It is also possible to [[visual3d:documentation:pipeline:report_commands:make_text_annotation|add free-form text annotations]] to reports. Or go back to the [[visual3d:documentation:pipeline:report_commands:report_commands_overview|Report Commands Overview]].