User Tools

Site Tools


visual3d:documentation:pipeline:report_commands:add_graph_annotation

Differences

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

Link to this comparison view

Next revision
Previous revision
visual3d:documentation:pipeline:report_commands:add_graph_annotation [2024/06/14 17:29] – created sgrangervisual3d:documentation:pipeline:report_commands:add_graph_annotation [2024/07/17 15:46] (current) – created sgranger
Line 1: Line 1:
-|**Language:**|** English**  • [[index.php?title=Add_Graph_Annotation/fr&action=edit&redlink=1|français]] • [[index.php?title=Add_Graph_Annotation/it&action=edit&redlink=1|italiano]] • [[Add_Graph_Annotation/pt|português]] • [[index.php?title=Add_Graph_Annotation/es&action=edit&redlink=1|español]] ****|+====== Add Graph Annotation ======
  
-|===== Contents =====\\ \\ \\ \\ * [[#Manual_Annotations|1 Manual Annotations]]\\ * [[#Pipeline_Command|2 Pipeline Command]]\\   * [[#Draw_Order|2.1 Draw Order]]\\   * [[#Annotation_Event|2.2 Annotation Event]]\\   * [[#Annotation_Style|2.3 Annotation_Style]]\\   * [[#Annotation_Color|2.4 Annotation_Color]]\\   * [[#Annotation_Size|2.5 Annotation Size]]\\   * [[#Annotation_Global|2.6 Annotation Global]]\\   * [[#Annotation_Average_Event|2.7 Annotation Average Event]]| +==== Manual Annotations ====
- +
-===== 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.\\ 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> <code>
Line 25: Line 23:
 </code> </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.
Line 31: Line 29:
 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>|[[File:GraphAnnotation_DrawOrder_1.jpg|{{/images/thumb/c/c0/GraphAnnotation_DrawOrder_1.jpg/450px-GraphAnnotation_DrawOrder_1.jpg?450x295}}]]|+|<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>|[[File:GraphAnnotation_DrawOrder_2.jpg|{{/images/thumb/f/f8/GraphAnnotation_DrawOrder_2.jpg/450px-GraphAnnotation_DrawOrder_2.jpg?450x298}}]]|+|<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]].
  
-[[File:GraphAnnotation_LocalGlobal.jpg|{{/images/thumb/6/6c/GraphAnnotation_LocalGlobal.jpg/700px-GraphAnnotation_LocalGlobal.jpg?700x164}}]]+{{: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.
Line 49: Line 47:
   - an event label, such that the event labels in all graphs are added   - 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:
Line 62: Line 60:
 Up Arrow Up Arrow
 Down Arrow Down Arrow
-==== Annotation_Color ====+=== Annotation_Color ===
  
 The following options are available: The following options are available:
Line 73: Line 71:
 Red Red
 Yellow Yellow
-==== Annotation Size ====+=== Annotation Size ===
  
 The following options are available: The following options are available:
Line 80: Line 78:
 Large Large
 Small Small
-==== Annotation Global ====+=== 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 (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>|[[File:GraphAnnotation_GlobalFALSE.jpg|{{/images/thumb/1/1b/GraphAnnotation_GlobalFALSE.jpg/400px-GraphAnnotation_GlobalFALSE.jpg?400x262}}]]|+|<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>|[[File:GraphAnnotation_GlobalTRUE.jpg|{{/images/thumb/c/c2/GraphAnnotation_GlobalTRUE.jpg/400px-GraphAnnotation_GlobalTRUE.jpg?400x268}}]]|+|<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]].
  
-[[File:GraphAnnotation_LocalGlobal.jpg|{{/images/thumb/6/6c/GraphAnnotation_LocalGlobal.jpg/700px-GraphAnnotation_LocalGlobal.jpg?700x164}}]]+{{: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>|[[File:GraphAnnotation_AverageFALSE.jpg|{{/images/thumb/e/ef/GraphAnnotation_AverageFALSE.jpg/400px-GraphAnnotation_AverageFALSE.jpg?400x262}}]]|+|<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>|[[File:GraphAnnotation_AverageTRUE.jpg|{{/images/thumb/9/99/GraphAnnotation_AverageTRUE.jpg/400px-GraphAnnotation_AverageTRUE.jpg?400x263}}]]|+|<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]].
  
-[[File:GraphAnnotation_AverageEvent.jpg|{{/images/thumb/2/24/GraphAnnotation_AverageEvent.jpg/700px-GraphAnnotation_AverageEvent.jpg?700x160}}]] +{{:GraphAnnotation_AverageEvent.jpg}}
  
-Retrieved from "" 
  
  
visual3d/documentation/pipeline/report_commands/add_graph_annotation.1718386171.txt.gz · Last modified: 2024/06/14 17:29 by sgranger