ReferencesCommonDrawing

Draw.VerticalLine()

View as Markdown

Definition

Draws a vertical line.

Method Return Value

A VerticalLine object that represents the draw object.

Syntax

Draw.VerticalLine(NinjaScriptBase owner, string tag, DateTime time, Brush brush)

Draw.VerticalLine(NinjaScriptBase owner, string tag, DateTime time, Brush brush, DashStyleHelper dashStyle, int width, bool drawOnPricePanel)

Draw.VerticalLine(NinjaScriptBase owner, string tag, int barsAgo, Brush brush)

Draw.VerticalLine(NinjaScriptBase owner, string tag, int barsAgo, Brush brush, DashStyleHelper dashStyle, int width, bool drawOnPricePanel)

Draw.VerticalLine(NinjaScriptBase owner, string tag, int barsAgo, bool isGlobal, string templateName)

Draw.VerticalLine(NinjaScriptBase owner, string tag, DateTime time, bool isGlobal, string templateName)

Parameters

ParameterDescription
ownerThe hosting NinjaScript object which is calling the draw method. Typically will be the object which is calling the draw method (e.g., “this”).
tagA 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.
barsAgoThe bar the object will be drawn at. A value of 10 would be 10 bars ago.
timeThe time the object will be drawn at.
brushThe brush used to color draw object (reference).
dashStylePossible values include:
DashStyleHelper.Dash,
DashStyleHelper.DashDot,
DashStyleHelper.DashDotDot,
DashStyleHelper.Dot,
DashStyleHelper.Solid.
widthThe width of the draw object.
drawOnPricePanelDetermines if the draw-object should be on the price panel or a separate panel.
isGlobalDetermines if the draw object will be global across all charts which match the instrument.
templateNameThe 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).

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.

Examples

1// Draws a vertical line  
2Draw.VerticalLine(this, "tag1", 10, Brushes.Black);