pltIViewControl Translate

Syntax

pltIViewControl_handle Translate x, y

Application

Tcl Modify

Description

This command moves the x-axis left or right based on the input x increment, and moves the y-axis up or down based on the input y increments. This differs from Translation in that you input a certain amount for the axis to move, rather than a string with a preset amount to move.

Inputs

x

A chosen value that sets the increment and direction that the x-axis. A negative value moves the axis to the right and a positive value moves the axis to the left. The increment then decides by how much the axis moves. An x value of 0 indicates that the x-axis will not move.

y

A chosen value that sets the increment and direction that the y-axis moves. A negative value moves the y-axis up and a positive value moves the y-axis down. The increment then decides by how much the axis will move. A y value of 0 indicates that the y-axis will not move.

Example

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

Errors

If either the x value, y value, or both are not present, an error message is displayed. Otherwise, success (0) is returned.

Keywords

XY plot

Tcl

Modify