ptPanCurrentPen() function

The ptPanCurrentPen() function can be used in a script to scroll a 16-Pen Trend’s pen upward or downward on the vertical value axis. Vertical scrolling is determined by the number of major and minor trend units specified as argument values.

Category

Pen trend

Syntax

ptPanCurrentPen(TrendName,MajorUnits, MinorUnits);

Arguments

TrendName

The name of the trend object. TrendName must be either a string constant or message tag.

MajorUnits

Multiplier to scroll by the number of units defined by the major division lines. A negative number indicates a downward scroll of the vertical axis.

MinorUnits

Multiplier for additional scrolling by number of units defined by the minor division lines. A negative number indicates a downward scroll of the vertical axis.

Examples

This example scrolls the pen upward one major division line.

ptPanCurrentPen("TrendName", 1, 0);

This example scrolls the pen upward half a minor trend division.

ptPanCurrentPen("TrendName", 0, 0.5);

This example scrolls the pen downward by 2 major division lines and half of a minor division line.

ptPanCurrentPen("TrendName", -2, -0.5);

This example scrolls one major division line up 1 and downward by 2 minor division lines.

ptPanCurrentPen("TrendName", 1, -2);