Utility Functions : List of Utility Functions : stm_plot_with_headerline

stm_plot_with_headerline

Function type: Integer

Description
Prints a sequence diagram with the names of lifelines on every page.
Syntax
stm_plot_with_headerline (id, plot_file, width, height, with_labels, with_names, with_notes, with_hyperlink, plot_type, date_position, title_position, title, do_rotate, with_file_header, actual_height, with_breakpages, pages_in_x, pages_in_y, page_index_in_x, page_index_in_y, with_hyperlink_exp, with_headerline, headerline_y,)
 
Arguments
 
Input/Output
Statmate element
The name of the file destination to which the plot is written. The operating system path name conventions are followed. You can specify a full path name to any directory for which you have write access.
If you specify a simple file name, the plot is written to your workarea. If you do not specify a value (“), the plot is included as part of the output segment file.
If you specify a plot size (width and height parameters) that is larger than the paper size defined for the specific printer, the plot simply uses the maximum allowable height and width defined for that printer.
Specifies whether to generate hyperlinks for lifelines and referenced sequence diagrams (TRUE).
Specifies the plot type. This can be a supported formatting language if the plot is to be handled by a formatting processing system that has its own graphics language.
To configure a new plotter or printer, select Utilities > Output Devices from the main Statemate window.
This is a string that indicates where to place the plot date. The possible values are as follows:
stm_plt_none—The date is not included.
stm_plt_top—The date is placed at the top of the plot.
stm_plt_bottom—The date is placed at the bottom of the plot.
This is a string that indicates where to place the plot title. The possible values are as follows:
stm_plt_none—The title is not included.
stm_plt_top—The title is placed at the top of the plot.
stm_plt_bottom—The title is placed at the bottom of the plot.
Determines whether the orientation of the plot is landscape (TRUE) or portrait (FALSE).
Indicates whether a header is added to the file (TRUE). Use this option if you do not want the plot as part of the document (FALSE).
Note that if pages_in_x==0 and pages_in_y==0, the tool calculates a break pages scheme and assigns these variables so they can be read by the user after the call.
Plots the ith page in the x-axis.
Plots the ith page in the y-axis.

 

Status Codes