NinjaScript > Language Reference > Drawing >

DrawRay()

Print this Topic Previous pageReturn to chapter overviewNext page

Definition
Draws a line which has an infinite end point in one direction.

 

Method Return Value

An IRay object that represents the draw object.

 

Syntax

DrawRay(string tag, int anchor1BarsAgo, double anchor1Y, int anchor2BarsAgo, double anchor2Y, Color color)
DrawRay(string tag, bool autoScale, int anchor1BarsAgo, double anchor1Y, int anchor2BarsAgo, double anchor2Y, Color color, DashStyle dashStyle, int width)

DrawRay(string tag, bool autoScale, DateTime anchor1Time, double anchor1Y, DateTime anchor2Time, double anchor2Y, Color color, DashStyle dashStyle, int width)
 

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. Default value is false.

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

color

The draw object color (reference)

dashStyle

DashStyle.Dash
DashStyle.DashDot
DashStyle.DashDotDot
DashStyle.Dot
DashStyle.Solid
(reference)

 

Note: Drawing objects with y values very far off the visible canvas can lead to performance hits. Fancier DashStyles like DashDotDot will also require more resources than simple DashStyles like Solid.

width

The width of the draw object

 

 

Examples

// Draws a lime green ray from 10 bars back through the current bar
DrawRay("tag1", 10, 1000, 0, 1001, Color.LimeGreen);