Adams Basic Package > Adams View > View Command Language > interface > interface page modify

interface page modify

Allows modifying an existing page.
The page can be created without opening the Adams postprocessor. The page is used to display plots to show the results, or to display the model in animation mode. The page properties and layout can be set by using this command.

Format:

 
interface page modify
page_name =
an existing page
layout_type =
layout_type
expanded =
boolean
header_left_text =
string
header_center_text =
string
header_right_text =
string
footer_left_text =
string
footer_center_text =
string
footer_right_text =
string
header_left_image_file =
string
header_left_image_file =
string
header_center_image_file =
string
header_right_image_file =
string
footer_left_image_file =
string
footer_center_image_file =
string
footer_right_image_file =
string
display =
boolean
color =
an existing color
set_contents =
boolean
page_type =
plot_page

Example:

interface page modify &
page_name =
page_5 &
layout_type =
page2x1 &
expanded =
yes &
header_left_text =
header_left &
header_center_text =
header_center &
header_right_text =
header_right &
footer_left_text =
footer_left &
footer_center_text =
footer_center &
footer_right_text =
footer_right &
header_left_image_file =
"C:/lefthead.bmp" &
header_center_image_file =
"C:/centerhead.bmp" &
header_right_image_file =
"C:/righthead.bmp" &
footer_left_image_file =
"C:/leftfoot.bmp" &
footer_center_image_file =
"C:/centerfoot.bmp" &
footer_right_image_file =
"C:/rightfoot.bmp" &
display =
yes &
color =
.colors.BLUE &
set_contents =
no &
page_type =
plot_page

Description:

 
Parameter
Value Type
Description
page_name
An Existing Page
Specifies the name of an existing page
layout_type
Layout_type
Specifies the layout of the plot page
expanded
Boolean
Specifies the page display parameters
header_left_text
String
Specifies the header text to be displayed
header_center_text
String
Specifies the header text to be displayed
header_right_text
String
Specifies the header text to be displayed
footer_left_text
String
Specifies the footer text to be displayed
footer_center_text
String
Specifies the footer text to be displayed
footer_right_text
String
Specifies the footer text to be displayed
header_left_image_file
String
Specifies the image to be displayed at the header space
header_left_image_file
String
Specifies the image to be displayed at the header space
header_center_image_file
String
Specifies the image to be displayed at the header space
header_right_image_file
String
Specifies the image to be displayed at the header space
footer_left_image_file
String
Specifies the image to be displayed at the footer space
footer_center_image_file
String
Specifies the image to be displayed at the footer space
footer_right_image_file
String
Specifies the image to be displayed at the footer space
display
Boolean
Specifies the page display parameter
color
An Existng Color
Specifies the color of the plot page
set_contents
Boolean
Specifies the contents of the plot page
page_type
Plot_page
Specifies the page type
adjoined
yes_no
Specifies whether the plots on a page are to be separated by margins or otherwise. The default value is no (spacing exists between the plots). Applicable to page1x2, page1x3, page1x4 and page1x5 layouts only
relative_widths
REAL numbers
Specify the relative widths (as percentages) for each plot of a 1xn configuration. Partial values are supported. In that case, the rest of the plots will be equally distributed over the remaining width.

For example for a page1x4 layout, if the relative_widths parameter is specified as 15, 25 then the first column will occupy 15% of the page width, the second 25% and the rest of the two will occupy 30% each.
sync_axis
[none, vertical, horizontal]
Specifies the axis to sync the zoom on, for all plots on a page. The pre-requisite to this functionality to work is that there should be only one axis in the specified direction for all plots on the page and that the units must be identical.

The default is none (no zoom syncing)
sync_legends
yes_no
Sync the legend heights across all plot legends on the specified page. The parameter is applicable only to page1x2, page1x3, page1x4 and page1x5 layouts and when all legends have the placement specified as 'plot'.

Extended Definition:

1. The ‘page’ is a plot window where either a result plot or a model can be displayed. The properties of the page can be initially set by this command. A blank plot or model page with specified properties will be displayed with this command.
2. The layout type allows one to display multiple plot windows on the same page where more than one results can be displayed simultaneously. For example, PAGE 2X1 will display two horizontal plots, one above the other. On the other hand PAGE 1X2 will display the two plots side by side on the same page.
3. Any one of the plots on a page can be expanded fully as the need arises by parameter ‘expanded’. If the ‘expanded’ is set to ‘yes’ one of the multiple plots will occupy full page.
4. The header and footer text can be displayed at left, center or right to add information to the plot by selecting appropriate ‘header_text’ or ‘footer_text’. Alternatively, an image may be displayed at left, center or right location of the header or footer to make the plot page self-explanatory. If both the image and text is specified the image may hide the header of footer text specified. Address of any remote image file with proper extension should be entered in the parameters ‘header_image_file’ and ‘footer_image_file’ for left, right or center location.
5. The plot will be displayed in the page in the post-processor if the parameter ‘display’ is set to ‘yes’.
6. The background ‘color’ of the page can be chosen from the ‘EXISTING COLORS’.
7. The ‘set_contents’ places empty plots in the views if in plotting mode or empty ‘model_space’ in animation mode.
8. The ‘page type’ is by default ‘plot_page’.