Draw.Ray()

<< Click to Display Table of Contents >>

Navigation:  NinjaScript > Language Reference > Common > Drawing >

Draw.Ray()

Previous page Return to chapter overview Next page

Definition

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

 

Method Return Value

A Ray object that represents the draw object.

 

Syntax

Draw.Ray(NinjaScriptBase owner, string tag, int startBarsAgo, double startY, int endBarsAgo, double endY, Brush brush)
Draw.Ray(NinjaScriptBase owner, string tag, bool isAutoScale, int startBarsAgo, double startY, int endBarsAgo, double endY, Brush brush, DashStyleHelper dashStyle, int width)
Draw.Ray(NinjaScriptBase owner, string tag, DateTime startTime, double startY, DateTime endTime, double endY, Brush brush)
Draw.Ray(NinjaScriptBase owner, string tag, DateTime startTime, double startY, DateTime endTime, double endY, Brush brush, DashStyleHelper dashStyle, int width)
Draw.Ray(NinjaScriptBase owner, string tag, bool isAutoScale, int startBarsAgo, double startY, int endBarsAgo, double endY, Brush brush, DashStyleHelper dashStyle, int width, bool drawOnPricePanel)
Draw.Ray(NinjaScriptBase owner, string tag, DateTime startTime, double startY, DateTime endTime, double endY, Brush brush, DashStyleHelper dashStyle, int width, bool drawOnPricePanel)
Draw.Ray(NinjaScriptBase owner, string tag, int startBarsAgo, double startY, int endBarsAgo, double endY, bool isGlobal, string templateName)
Draw.Ray(NinjaScriptBase owner, string tag, DateTime startTime, double startY, DateTime endTime, double endY, bool isGlobal, string templateName)

 
 

Parameters

owner

The hosting NinjaScript object which is calling the draw method

 

Typically will be the object which is calling the draw method (e.g., "this")

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.

isAutoScale

Determines if the draw object will be included in the y-axis scale. Default value is false.

startBarsAgo

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

startTime

The time of the 1st anchor point

startY

The y value of the 1st anchor point

endBarsAgo

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

endTime

The time of the 2nd anchor point

endY

The y value of the 2nd anchor point

brush

The brush used to color draw object (reference)

dashStyle

DashStyleHelper.Dash
DashStyleHelper.DashDot
DashStyleHelper.DashDotDot
DashStyleHelper.Dot
DashStyleHelper.Solid

 

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

drawOnPricePanel

Determines if the draw-object should be on the price panel or a separate panel

isGlobal

Determines if the draw object will be global across all charts which match the instrument

templateName

The name of the drawing tool template the object will use to determine various visual properties (empty string could be used to just use the UI default visuals instead)

 

 

Examples

ns


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