"rulerTime"

Sets/Gets the ruler time of a trend area.

Synopsis

setValue(string shape, "rulerTime", int area, time position);

getValue(string shape, "rulerTime", int area, time position);

shape.rulerTime(int area, time position);

Parameters

Parameter Description
shape Name of the object
area Index of the trend area
position Ruler time

Description

Sets/Gets the ruler time of a trend area. Returns NULL time if the ruler is not visible and can only be set if the trend is stopped. If the ruler time is set to 0, the ruler is hidden (but the trend will not be started). Also setting the ruler time to another value does not start the trend.

The resulting time can be different to what is passed due to internal rounding since the ruler time position is a pixel position within the widget.

Example

main()
{
  time trendTime;
  //setValue("TREND1", "rulerTime", 0, 0);
  getValue("TREND1", "rulerTime", 0, trendTime);
  DebugN(trendTime);
}

Assignment

Trend