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

Both sides previous revisionPrevious revision
Next revision
Previous revision
visual3d:documentation:pipeline:report_commands:add_graph_annotation [2024/07/16 19:31] – created sgrangervisual3d:documentation:pipeline:report_commands:add_graph_annotation [2024/07/17 15:46] (current) – created sgranger
Line 1: Line 1:
-====== Add_Graph_Annotation ======+====== Add Graph Annotation ======
  
 ==== Manual Annotations ==== ==== Manual Annotations ====
Line 29: 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>|{{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 ===
Line 82: Line 82:
 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>|{{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 ===
Line 96: Line 96:
 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}}
  
  
  
visual3d/documentation/pipeline/report_commands/add_graph_annotation.1721158283.txt.gz · Last modified: 2024/07/16 19:31 by sgranger