HTZoomOut() Function

The HTZoomOut() function calculates a new chart width and start time. The new chart width is the old chart width multiplied by two. The new start time is calculated based on the value of the LockString argument .

Category

Historical

Syntax

HTZoomOut(Hist_Tag,LockString);

Arguments

Hist_Tag

HistTrend tag assigned the name of the trend.

LockString

String representing the type of zoom:

StartTime = Keep start time equal to before zoom

Center = Keep center time equal to before zoom

EndTime = Keep end time equal to before zoom

Remarks

The current scooter positions have no effect on HTZoomOut(). After the function zoom finishes, the new scooter positions are set to .ScooterPosLeft=0.0 and .ScooterPosRight=1.0.

Example

The following statement zooms out the trend time by a factor of two and maintains the same center time for the Volume trend. If the start time before zooming was 2:15:00 PM and the chart width was 30 seconds, the start time after zooming is now 2:14:45. The chart width is 60 seconds and the center of the trend remains at 2:15:15.

HTZoomOut("Volume","Center");