User Tools

Site Tools


visual3d:documentation:pipeline:report_commands:add_graph_annotation

Add Graph Annotation

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.

Add_Graph_Annotation
  /PAGE_NUMBER=
  /COLUMN_NUMBER=
  /ROW_NUMBER=
  /DRAW_ORDER=
  /ANNOTATION_EVENT=
! /ANNOTATION_STYLE=Ticks
! /ANNOTATION_COLOR=Red
! /ANNOTATION_SIZE=Normal
! /ANNOTATION_GLOBAL=False
! /ANNOTATION_AVERAGE_EVENT=False
;

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.

Draw Order

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 here.

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
;
graphannotation_draworder_1.jpg
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
;
graphannotation_draworder_2.jpg

Modifying the DRAW_ORDER is similar to using the “Set annotation local” radial box when manually adding an annotation.

graphannotation_localglobal.jpg

Annotation Event

The event times at which a symbol should be drawn. If Annotation_Average_Event is true, the edit box has two meanings:

  1. a number indicating the percent of the range
  2. an event label, such that the event labels in all graphs are added

Annotation_Style

The following options are available:

  1. TICKS
  2. Top TICKS
  3. Bottom TICKS
  4. Vertical Line
  5. Box
  6. Triangle
  7. Cross
  8. Up Arrow
  9. Down Arrow

Annotation_Color

The following options are available:

  1. Black
  2. Blue
  3. Cyan
  4. Green
  5. Purple
  6. Red
  7. Yellow

Annotation Size

The following options are available:

  1. Normal
  2. Large
  3. 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.

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
;
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.

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
;
graphannotation_globaltrue.jpg

Modifying the ANNOTATION_GLOBAL is similar to using the “Set annotation globally” radial box when manually adding an annotation.

graphannotation_localglobal.jpg

Annotation Average Event

When set to FALSE, all instances of the event will be displayed.

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
;
graphannotation_averagefalse.jpg

When set to TRUE, all instances of the event will be averaged, and only the average event will be displayed.

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
;
graphannotation_averagetrue.jpg

Modifying the ANNOTATION_AVERAGE_EVENT is similar to using the “All Graphs” or “Average Event or Numeric Value” radial box when manually adding an annotation.

graphannotation_averageevent.jpg

See Also

It is also possible to add free-form text annotations to reports. Or go back to the Report Commands Overview.

visual3d/documentation/pipeline/report_commands/add_graph_annotation.txt · Last modified: 2025/04/29 13:43 by wikisysop