Differences

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

--- visual3d:documentation:pipeline:report_commands:report_commands_overview [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:report_commands:report_commands_overview [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-===== report format =====
+====== Report Commands Overview ======
-=== open_report_template ===
+==== Report Format ====
-load a report template in the current workspace.
+== Open_Report_Template ==
-=== append_report_template ===
-append the current report template with another one.
+Load a report template in the current workspace.
-=== set_report_options ===
+== Append_Report_Template ==
-set report page layout to either portrait or landscape.
+Append the current report template with another one.
-=== set_report_page_title ===
+== Set_Report_Options ==
-set/modify a report page title.
+Set report page layout to either portrait or landscape.
-=== delete_report_page ===
+== Set_Report_Page_title ==
-delete a report page
+Set/Modify a report page title.
+== Delete_Report_Page ==
+Delete a Report Page
 \\
-===== report graph format =====
+==== Report Graph Format ====
-=== interactive_remove_graph_signals ===
+== Interactive_Remove_Graph_Signals ==
-=== interactive_graph_signals ===
+== Interactive_Graph_Signals ==
-=== add_graph_annotation ===
+== Add_Graph_Annotation ==
-add an annotation symbol to a report graph.
+Add an annotation symbol to a report graph.
-=== make_text_annotation ===
+== Make_Text_Annotation ==
-add a box to the report page containing text.
+Add a box to the report page containing text.
-=== delete_report_item ===
+== Delete_Report_Item ==
-delete a report item
+Delete a Report Item
-=== make_image_item ===
+== Make_Image_Item ==
-add/modify a report image (.jpg, .bmp, ,.gif, ,.png)
+Add/Modify a Report Image (.jpg, .bmp, ,.gif, ,.png)
-=== make_line_graph ===
+== Make_Line_Graph ==
-add a report graph.
+Add a Report Graph.
-=== modify_line_graph ===
+== Modify_Line_Graph ==
-modify a report graph.
+Modify a Report Graph.
-=== modify_all_graphs ===
+== Modify_All_Graphs ==
-modify all graphs in a report.
+Modify all graphs in a report.
-=== add_graph_annotation ===
+== Add_Graph_Annotation ==
-add/modify report graph annotation.
+Add/Modify Report graph annotation.
-=== make_text_annotation ===
+== Make_Text_Annotation ==
-add/modify report text annotation.
+Add/Modify Report text annotation.
-=== search_and_replace_tags ===
+== Search_and_Replace_Tags ==
-replace tags in a page or entire report.
+Replace tags in a page or entire report.
 \\
-===== export data =====
+==== Export Data ====
-=== print_report ===
+== Print_Report ==
-print the current report.
+Print the current report.
-=== export_graph ===
+== Export_Graph ==
-export a graph from the report.
+Export a graph from the report.
-=== export_metric_table_to_odt ===
+== Export_Metric_Table_To_ODT ==
-merge metrics to a table of an odt document.
+Merge metrics to a table of an ODT document.
-=== export_signals_to_odt_graph ===
+== Export_Signals_To_ODT_Graph ==
-merge a graph of signals into an odt document.
+Merge a graph of signals into an ODT document.
-=== export_metric_table ===
+== Export_Metric_Table ==
-export a metric table from the report to a text file.
+Export a metric table from the report to a text file.