Differences

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

--- visual3d:documentation:pipeline:report_commands:modify_all_graphs [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:report_commands:modify_all_graphs [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{this command was implemented in visual3d v5.02.25.
+====== Modify All Graphs ======
-===== command =====
+This command was implemented in Visual3D v5.02.25.
-|<code>\\ modify_all_graphs\\ ! /page_no=\\ ! /y_modify_range=true\\ ! /y_use_auto_range=true\\ ! /y_min_buffer=\\ ! /y_max_buffer=\\ ! /y_min=\\ ! /y_max=\\ ! /y_scale_increment=\\ ! /y_axis_label=\\ ! /x_axis_label=\\ ;\\ </code>  |  modify_all_graphs.png|
+==== Command ====
+|<code>\\ Modify_All_Graphs\\ ! /PAGE_NO=\\ ! /Y_MODIFY_RANGE=TRUE\\ ! /Y_USE_AUTO_RANGE=TRUE\\ ! /Y_MIN_BUFFER=\\ ! /Y_MAX_BUFFER=\\ ! /Y_MIN=\\ ! /Y_MAX=\\ ! /Y_SCALE_INCREMENT=\\ ! /Y_AXIS_LABEL=\\ ! /X_AXIS_LABEL=\\ ;\\ </code>  |  {{:Modify_All_Graphs.png}}|
 \\
@@ Line 13: / Line 15: @@
-===== command parameters =====
+==== Command Parameters ====
-==== page_no ====
+=== PAGE_NO ===
-if the page_no parameter is blank, the command will run on all pages.
+If the PAGE_NO parameter is blank, the command will run on all pages.
-if page_no is set to **2+3+4**, only pages 2, 3 & 4 will be modified.
+If PAGE_NO is set to **2+3+4**, only pages 2, 3 & 4 will be modified.
-==== modify range ====
+=== Modify Range ===
-**y_modify_range**
+**Y_MODIFY_RANGE**
-if this parameter is set to false, the range will not be modified, regardless of the specified parameters.
+If this parameter is set to FALSE, the range will not be modified, regardless of the specified parameters.
-when this parameter is set to true, the other parameters to modify the y range may be used.
+When this parameter is set to TRUE, the other parameters to modify the Y range may be used.
-**modify range parameters:** (click to expand)
+**Modify Range Parameters:** (click to expand)
-**y_use_auto_range**
+**Y_USE_AUTO_RANGE**
-if this parameter is set to true, the range will automatically be set using the signal max/min values.
+If this parameter is set to TRUE, the range will automatically be set using the signal max/min values.
-this parameter can be used with the y_scale_increment parameter.
+This parameter can be used with the Y_SCALE_INCREMENT parameter.
-when **y_use_auto_range** is set to **false**, you can use either **y_min_buffer&y_max_buffer** or **y_min&y_max**.
+When **Y_USE_AUTO_RANGE** is set to **FALSE**, you can use either **Y_MIN_BUFFER&Y_MAX_BUFFER** OR **Y_MIN&Y_MAX**.
 ----
-**y_min_buffer&y_max_buffer**
+**Y_MIN_BUFFER&Y_MAX_BUFFER**
-the auto range parameter will set the graph max/min to be the signal max/min. however, if you want the graph max/min to be +/- some value above the signal max/min, use the buffer values.
+The auto range parameter will set the graph max/min to be the signal max/min. However, if you want the graph max/min to be +/- some value above the signal max/min, use the buffer values.
-for example, if you want the graph max to be 10 units greater than the signal max and the graph min to be 15 units less than the signal min, you would:
+For example, if you want the graph max to be 10 units greater than the signal max and the graph min to be 15 units less than the signal min, you would:
 <code>
 ...
- /y_modify_range=true
+ /Y_MODIFY_RANGE=TRUE
- /y_use_auto_range=false
+ /Y_USE_AUTO_RANGE=FALSE
- /y_min_buffer= 15
+ /Y_MIN_BUFFER= 15
- /y_max_buffer= 10
+ /Y_MAX_BUFFER= 10
-! /y_min=
+! /Y_MIN=
-! /y_max=
+! /Y_MAX=
 ...
 </code>
-**note:** the min buffer does not use a negative sign.
+**NOTE:** The min buffer does not use a negative sign.
-this parameter can be used with the y_scale_increment parameter.
+This parameter can be used with the Y_SCALE_INCREMENT parameter.
 ----
-**y_min&y_max**
+**Y_MIN&Y_MAX**
-you can explicitly set the graph max/min.
+You can explicitly set the graph max/min.
-if you want to explicitly specify the graph max/min (max 25, min -25), you would:
+If you want to explicitly specify the graph max/min (max 25, min -25), you would:
 <code>
 ...
- /y_modify_range=true
+ /Y_MODIFY_RANGE=TRUE
- /y_use_auto_range=false
+ /Y_USE_AUTO_RANGE=FALSE
-! /y_min_buffer=
+! /Y_MIN_BUFFER=
-! /y_max_buffer=
+! /Y_MAX_BUFFER=
- /y_min= 25
+ /Y_MIN= 25
- /y_max= -25
+ /Y_MAX= -25
 ...
 </code>
 \\
-this parameter can be used with the y_scale_increment parameter.
+This parameter can be used with the Y_SCALE_INCREMENT parameter.
 ----
-**y_scale_increment**
+**Y_SCALE_INCREMENT**
+This parameter sets the max/min value to the nearest value. Example, if the parameter is set to 1, the graph max/min will be set to the highest whole number. If the parameter is set to 5, the graph max/min will be set to the highest five value.
-this parameter sets the max/min value to the nearest value. example, if the parameter is set to 1, the graph max/min will be set to the highest whole number. if the parameter is set to 5, the graph max/min will be set to the highest five value.
+=== Modify Axes Labels ===
-==== modify axes labels ====
+If you set either AXIS_LABEL equal to REMOVE_LABEL, the label will be removed.
-if you set either axis_label equal to remove_label, the label will be removed.
+If the parameter is set to blank (is empty), the label will not be updated.
-if the parameter is set to blank (is empty), the label will not be updated.
-}}