pltIViewControl Translation

Moves the axes up, down, left, or right based on the given string input.

Syntax

hwIViewControl_handle Translation str

Application

HyperWorks Tcl Modify

Description

This command moves the axes in the plot based upon the input string. The curve in the plot appears as though it is moving, but in reality, it is the axis that is moving, changing the view. This differs from Translate in that you input a string with a preset amount to move, rather than an input amount for the axis to move.

Inputs

str
The str, or string, is an input which tells the function in which direction it should move. Each string moves the axes one unit in each direction stated. The different string options include:
“up”
"down"
"left"
"right"
"upleft"
"upright"
"downleft"
"downright"

Example

hwi GetSessionHandle sess;
sess GetProjectHandle proj;
proj GetPageHandle p1 1;
p1 GetWindowHandle w1 1;
w1 GetViewControlHandle vc;
vc Translate "upright";
plot Draw;

Errors

If no string is input, an error message is displayed. If a string that is not one of the options is input, nothing happens. Otherwise, success (0) is returned and the plot changes.

Keywords

HyperWorks

XY plot

Tcl

Modify