Differences

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

--- visual3d:documentation:pipeline:report_commands:add_graph_annotation [2024/07/12 14:06] – created sgranger
+++ visual3d:documentation:pipeline:report_commands:add_graph_annotation [2025/04/29 13:43] (current) – Added "See Also" section. wikisysop
@@ Line 1: / Line 1: @@
-====== Add_Graph_Annotation ======
+====== Add Graph Annotation ======
-==== Manual Annotations ====
+[[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.
-Graph Annotations can be manually modified by using the annotations button on the Add/Modify Graph pop up dialog. For more information about graphing annotations, see the [[Visual3D:Documentation:Reports:Report_2D_Graph#Annotations|2D Graph Annotations]] page.\\
-==== Pipeline Command ====
 <code>
@@ Line 23: / Line 18: @@
 </code>
-=== Draw Order ===
+===== Parameters =====
-Draw order indicates which graph will be annotated. The first graph that was drawn will be drawn first.
+The Page_Number, Column_Number, and Row_Number parameters are used to specify the location of the graph to be modified by the command.
-The graphs are drawn in the order they are created. It is possible to check which graph was drawn first, two methods can be found [[Visual3D:Documentation:Reports:Draw_Order|here]].
+==== Draw Order ====
-|<code>\\ Add_Graph_Annotation\\ /PAGE_NUMBER=2\\ /COLUMN_NUMBER=1\\ /ROW_NUMBER=1\\ /DRAW_ORDER=1\\ /ANNOTATION_EVENT=LTO\\ /ANNOTATION_STYLE=VERTICAL LINE\\ /ANNOTATION_COLOR=GREEN\\ /ANNOTATION_SIZE=Normal\\ /ANNOTATION_GLOBAL=False\\ /ANNOTATION_AVERAGE_EVENT=False\\ ;\\ </code>|{{GraphAnnotation_DrawOrder_1.jpg}}|
+Draw order indicates which graph will be annotated. The first graph that was drawn will be drawn first. By default the graphs are drawn in the order they are created. It is possible to check which graph was drawn first, two methods can be found [[Visual3D:Documentation:Reports:Draw_Order|here]].
-|<code>\\ Add_Graph_Annotation\\ /PAGE_NUMBER=2\\ /COLUMN_NUMBER=1\\ /ROW_NUMBER=1\\ /DRAW_ORDER=2\\ /ANNOTATION_EVENT=LTO\\ /ANNOTATION_STYLE=VERTICAL LINE\\ /ANNOTATION_COLOR=PURPLE\\ /ANNOTATION_SIZE=Normal\\ /ANNOTATION_GLOBAL=False\\ /ANNOTATION_AVERAGE_EVENT=False\\ ;\\ </code>|{{GraphAnnotation_DrawOrder_2.jpg}}|
+|<code>
+Add_Graph_Annotation
+/PAGE_NUMBER=2
+/COLUMN_NUMBER=1
+/ROW_NUMBER=1
+/DRAW_ORDER=1
+/ANNOTATION_EVENT=LTO
+/ANNOTATION_STYLE=VERTICAL LINE
+/ANNOTATION_COLOR=GREEN
+/ANNOTATION_SIZE=Normal
+/ANNOTATION_GLOBAL=False
+/ANNOTATION_AVERAGE_EVENT=False
+;
+</code>|{{:GraphAnnotation_DrawOrder_1.jpg}}|
+|<code>
+Add_Graph_Annotation
+/PAGE_NUMBER=2
+/COLUMN_NUMBER=1
+/ROW_NUMBER=1
+/DRAW_ORDER=2
+/ANNOTATION_EVENT=LTO
+/ANNOTATION_STYLE=VERTICAL LINE
+/ANNOTATION_COLOR=PURPLE
+/ANNOTATION_SIZE=Normal
+/ANNOTATION_GLOBAL=False
+/ANNOTATION_AVERAGE_EVENT=False
+;
+</code>|{{:GraphAnnotation_DrawOrder_2.jpg}}|
-\\
 Modifying the DRAW_ORDER is similar to using the "Set annotation local" radial box when [[Visual3D:Documentation:Reports:Report_2D_Graph#Annotations|manually adding an annotation]].
-{{GraphAnnotation_LocalGlobal.jpg}}
+{{:GraphAnnotation_LocalGlobal.jpg}}
-=== Annotation Event ===
-The event times at which a symbol should be drawn.
+==== Annotation Event ====
-If Annotation_Average_Event is true, the edit box has two meanings
+The event times at which a symbol should be drawn. If Annotation_Average_Event is true, the edit box has two meanings:
   - a number indicating the percent of the range
   - an event label, such that the event labels in all graphs are added
-=== Annotation_Style ===
+==== Annotation_Style ====
 The following options are available:
+  - TICKS
+  - Top TICKS
+  - Bottom TICKS
+  - Vertical Line
+  - Box
+  - Triangle
+  - Cross
+  - Up Arrow
+  - Down Arrow
-TICKS
+==== Annotation_Color ====
-Top TICKS
-Bottom TICKS
-Vertical Line
-Box
-Triangle
-Cross
-Up Arrow
-Down Arrow
-=== Annotation_Color ===
 The following options are available:
+  - Black
+  - Blue
+  - Cyan
+  - Green
+  - Purple
+  - Red
+  - Yellow
-Black
+==== Annotation Size ====
-Blue
-Cyan
-Green
-Purple
-Red
-Yellow
-=== Annotation Size ===
 The following options are available:
+  - Normal
+  - Large
+  - Small
-Normal
+==== Annotation Global ====
-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.**
-|<code>\\ Add_Graph_Annotation\\ /PAGE_NUMBER=2\\ /COLUMN_NUMBER=1\\ /ROW_NUMBER=1\\ /DRAW_ORDER=1\\ /ANNOTATION_EVENT=LTO\\ /ANNOTATION_STYLE=VERTICAL LINE\\ /ANNOTATION_COLOR=GREEN\\ /ANNOTATION_SIZE=Normal\\ /ANNOTATION_GLOBAL=FALSE\\ /ANNOTATION_AVERAGE_EVENT=False\\ ;\\ </code>|{{GraphAnnotation_GlobalFALSE.jpg}}|
+|<code>
+Add_Graph_Annotation
+/PAGE_NUMBER=2
+/COLUMN_NUMBER=1
+/ROW_NUMBER=1
+/DRAW_ORDER=1
+/ANNOTATION_EVENT=LTO
+/ANNOTATION_STYLE=VERTICAL LINE
+/ANNOTATION_COLOR=GREEN
+/ANNOTATION_SIZE=Normal
+/ANNOTATION_GLOBAL=FALSE
+/ANNOTATION_AVERAGE_EVENT=False
+;
+</code>|{{:GraphAnnotation_GlobalFALSE.jpg}}|
-When set to **TRUE** will add graph annotation to all graphs at the specified location (for example row 1 column 1), **regardless of DRAW_ORDER.**
+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.**
-|<code>\\ Add_Graph_Annotation\\ /PAGE_NUMBER=2\\ /COLUMN_NUMBER=1\\ /ROW_NUMBER=1\\ /DRAW_ORDER=1\\ /ANNOTATION_EVENT=LTO\\ /ANNOTATION_STYLE=VERTICAL LINE\\ /ANNOTATION_COLOR=GREEN\\ /ANNOTATION_SIZE=Normal\\ /ANNOTATION_GLOBAL=TRUE\\ /ANNOTATION_AVERAGE_EVENT=False\\ ;\\ </code>|{{GraphAnnotation_GlobalTRUE.jpg}}|
+|<code>
+Add_Graph_Annotation
+/PAGE_NUMBER=2
+/COLUMN_NUMBER=1
+/ROW_NUMBER=1
+/DRAW_ORDER=1
+/ANNOTATION_EVENT=LTO
+/ANNOTATION_STYLE=VERTICAL LINE
+/ANNOTATION_COLOR=GREEN
+/ANNOTATION_SIZE=Normal
+/ANNOTATION_GLOBAL=TRUE
+/ANNOTATION_AVERAGE_EVENT=False
+;
+</code>|{{:GraphAnnotation_GlobalTRUE.jpg}}|
 Modifying the ANNOTATION_GLOBAL is similar to using the "Set annotation globally" radial box when [[Visual3D:Documentation:Reports:Report_2D_Graph#Annotations|manually adding an annotation]].
-{{GraphAnnotation_LocalGlobal.jpg}}
+{{:GraphAnnotation_LocalGlobal.jpg}}
-=== Annotation Average Event ===
+==== Annotation Average Event ===
 When set to **FALSE**, all instances of the event will be displayed.
-|<code>\\ Add_Graph_Annotation\\ /PAGE_NUMBER=2\\ /COLUMN_NUMBER=1\\ /ROW_NUMBER=1\\ /DRAW_ORDER=1\\ /ANNOTATION_EVENT=LTO\\ /ANNOTATION_STYLE=VERTICAL LINE\\ /ANNOTATION_COLOR=GREEN\\ /ANNOTATION_SIZE=Normal\\ /ANNOTATION_GLOBAL=False\\ /ANNOTATION_AVERAGE_EVENT=FALSE\\ ;\\ </code>|{{GraphAnnotation_AverageFALSE.jpg}}|
+|<code>
+Add_Graph_Annotation
+/PAGE_NUMBER=2
+/COLUMN_NUMBER=1
+/ROW_NUMBER=1
+/DRAW_ORDER=1
+/ANNOTATION_EVENT=LTO
+/ANNOTATION_STYLE=VERTICAL LINE
+/ANNOTATION_COLOR=GREEN
+/ANNOTATION_SIZE=Normal
+/ANNOTATION_GLOBAL=False
+/ANNOTATION_AVERAGE_EVENT=FALSE
+;
+</code>|{{:GraphAnnotation_AverageFALSE.jpg}}|
 When set to **TRUE**, all instances of the event will be averaged, and only the average event will be displayed.
-|<code>\\ Add_Graph_Annotation\\ /PAGE_NUMBER=2\\ /COLUMN_NUMBER=1\\ /ROW_NUMBER=1\\ /DRAW_ORDER=1\\ /ANNOTATION_EVENT=LTO\\ /ANNOTATION_STYLE=VERTICAL LINE\\ /ANNOTATION_COLOR=GREEN\\ /ANNOTATION_SIZE=Normal\\ /ANNOTATION_GLOBAL=False\\ /ANNOTATION_AVERAGE_EVENT=TRUE\\ ;\\ </code>|{{GraphAnnotation_AverageTRUE.jpg}}|
+|<code>
+Add_Graph_Annotation
+/PAGE_NUMBER=2
+/COLUMN_NUMBER=1
+/ROW_NUMBER=1
+/DRAW_ORDER=1
+/ANNOTATION_EVENT=LTO
+/ANNOTATION_STYLE=VERTICAL LINE
+/ANNOTATION_COLOR=GREEN
+/ANNOTATION_SIZE=Normal
+/ANNOTATION_GLOBAL=False
+/ANNOTATION_AVERAGE_EVENT=TRUE
+;
+</code>|{{:GraphAnnotation_AverageTRUE.jpg}}|
 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]].
-{{GraphAnnotation_AverageEvent.jpg}}
+{{: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]].