ptPanTime() function

The ptPanTime() function can be used in a script to scroll a 16-Pen Trend’s pen left or right on the horizontal time axis based on the number of specified major or minor trend units.

Category

Pen trend

Syntax

ptPanTime(TrendName, MajorUnits, MinorUnits);

Arguments

TrendName

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

MajorUnits

Multiplier for scrolling by the number of horizontal major division lines. A negative number indicates panning left on the trend.

MinorUnits

Multiplier for additional scrolling by number of units defined by the minor division lines. A negative number indicates panning left on the trend.

Remarks

The settings for Major Division and Minor Division specified in the PenTrend Control dialog box during development are the basis from which the amount to scroll by is calculated. A trend with a time span of 120 seconds, a major division value of 10 and a minor division value of 2, results in a trend with a major division line every 12 seconds and a minor division line every 6 seconds. The function ptPanTime("TrendName",1,0.5) scrolls the time axis by 1*12 + 0.5*6 = 15 seconds.

Examples

This example scrolls the pen 1 major division to the right on the horizontal trend axis.

ptPanTime("TrendName", 1, 0);

This example scrolls the pen to the right on the horizontal axis of the trend by 0.5 minor division.

ptPanTime("TrendName", 0, 0.5);

This example scrolls the pen 2.5 major divisions to the left on the horizontal axis of the trend.

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

This example scrolls the pen 1 major division to the right and 2 minor divisions to the left.

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