NinjaScript > Language Reference > Drawing >

DrawRuler()

Print this Topic Previous pageReturn to chapter overviewNext page

Definition
Draws a ruler.

 

Method Return Value

An IRuler object that represents the draw object.

 

Syntax

DrawRuler(string tag, bool autoScale, IDataSeries series, int anchor1BarsAgo, double anchor1Y, int anchor2BarsAgo, double anchor2Y, int anchor3BarsAgo, double anchor3Y)

DrawRuler(string tag, bool autoScale, IDataSeries series, DateTime anchor1Time, double anchor1Y, DateTime anchor2Time, double anchor2Y, DateTime anchor3Time, double anchor3Y)
 

Parameters

tag

A user defined unique id used to reference the draw object. For example, if you pass in a value of "myTag", each time this tag is used, the same draw object is modified. If unique tags are used each time, a new draw object will be created each time.

autoScale

Determines if the draw object will be included in the y-axis scale

series

The series the ruler will measure

anchor1BarsAgo

The number of bars ago (x value) of the 1st anchor point

anchor1Time

The time of the 1st anchor point

anchor1Y

The y value of the 1st anchor point

anchor2BarsAgo

The number of bars ago (x value) of the 2nd anchor point

anchor2Time

The time of the 2nd anchor point

anchor2Y

The y value of the 2nd anchor point

anchor3BarsAgo

The number of bars ago (x value) of the 3rd anchor point

anchor3Time

The time of the 3rd anchor point

anchor3Y

The y value of the 3rd anchor point

 

 

Examples

// Draws a ruler measuring the primary bar series

DrawRuler("tag1", true, BarsArray[0], 4, Low[4], 3, High[3], 1, Low[1]);