RectangleSetBegin BN

From MultiCharts
Jump to navigation Jump to search

Modifies the starting point location of a rectangle with the specified ID number; returns a value of 0 if the starting point location was successfully modified, and a value of -2 if the specified rectangle ID number is invalid.
Between the two end points of a rectangle, the point with the earlier date and time is always considered to be the starting point; if the rectangle is vertical, the point with the lower price value is considered to be the starting point.
Instead of separate Date and Time values or a single DateTime value, bar number is used.

Usage

RectangleSetBegin_BN (ID, BarNumber, Price);
Parameters
ID - a numerical expression specifying the rectangle ID number.
BarNumber - a numerical expression specifying the rectangle starting point bar number.
Price - a numerical expression specifying the rectangle starting point price value (vertical position, corresponding to a value on the price scale of a chart).

Notes

A rectangle-specific ID number is returned by RectangleNew when the rectangle is created.

Example

Set the beginning point of rectangle with ID = 1 to close price of current bar

Value1=RectangleSetBegin_BN(1,currentbar[100],Close[100]);