Differences

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

--- visual3d:documentation:pipeline:report_commands:add_graph_annotation [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:report_commands:add_graph_annotation [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{{{{{{{{{{{{{{{{{===== manual annotations =====
+====== Add Graph Annotation ======
-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.\\
+==== Manual Annotations ====
+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 =====
+==== Pipeline Command ====
 <code>
-add_graph_annotation
+Add_Graph_Annotation
-  /page_number=
+  /PAGE_NUMBER=
-  /column_number=
+  /COLUMN_NUMBER=
-  /row_number=
+  /ROW_NUMBER=
-  /draw_order=
+  /DRAW_ORDER=
-  /annotation_event=
+  /ANNOTATION_EVENT=
-! /annotation_style=ticks
+! /ANNOTATION_STYLE=Ticks
-! /annotation_color=red
+! /ANNOTATION_COLOR=Red
-! /annotation_size=normal
+! /ANNOTATION_SIZE=Normal
-! /annotation_global=false
+! /ANNOTATION_GLOBAL=False
-! /annotation_average_event=false
+! /ANNOTATION_AVERAGE_EVENT=False
 ;
 </code>
-==== draw order ====
+=== Draw Order ===
-draw order indicates which graph will be annotated. the first graph that was drawn will be drawn first.
+Draw order indicates which graph will be annotated. The first graph that was drawn will be drawn first.
-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]].
+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=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=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|
+|<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]].
+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 ====
+=== Annotation Event ===
-the event times at which a symbol should be drawn.
+The event times at which a symbol should be drawn.
-if annotation_average_event is true, the edit box has two meanings
+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:
-the following options are available:
+TICKS
+Top TICKS
+Bottom TICKS
+Vertical Line
+Box
+Triangle
+Cross
+Up Arrow
+Down Arrow
+=== Annotation_Color ===
-ticks
+The following options are available:
-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
+=== Annotation Size ===
-black
+The following options are available:
-blue
-cyan
-green
-purple
-red
-yellow
-==== annotation size ====
-the following options are available:
+Normal
+Large
+Small
+=== Annotation Global ===
-normal
+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.**
-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 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]].
-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.
-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.
-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]].
-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
-}}}}}}}}}}}}}}}}}}