ReferencesCommonDrawing

Draw.RegionHighlightX()

View as Markdown

Definition

Draws a region highlight x on a chart.

Method Return Value

A RegionHighlightX object that represents the draw object.

Syntax

Draw.RegionHighlightX(NinjaScriptBase owner, string tag, DateTime startTime, DateTime endTime, Brush brush)

Draw.RegionHighlightX(NinjaScriptBase owner, string tag, int startBarsAgo, int endBarsAgo, Brush brush)

Draw.RegionHighlightX(NinjaScriptBase owner, string tag, DateTime startTime, DateTime endTime, Brush brush, Brush areaBrush, int areaOpacity)

Draw.RegionHighlightX(NinjaScriptBase owner, string tag, int startBarsAgo, int endBarsAgo, Brush brush, Brush areaBrush, int areaOpacity)

Draw.RegionHighlightX(NinjaScriptBase owner, string tag, DateTime startTime, DateTime endTime, bool isGlobal, string templateName)

Draw.RegionHighlightX(NinjaScriptBase owner, string tag, int startBarsAgo, int endBarsAgo, 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.
startBarsAgoThe starting bar (x axis co-ordinate) where the draw object will be drawn. For example, a value of 10 would paint the draw object 10 bars back.
startTimeThe starting time where the draw object will be drawn.
endBarsAgoThe end bar (x axis co-ordinate) where the draw object will terminate.
endTimeThe end time where the draw object will terminate.
brushThe brush used to color the outline of draw object (reference).
areaBrushThe brush used to color the fill area of the draw object (reference).
areaOpacitySets the level of transparency for the fill color. Valid values between 0 - 100. (0 = completely transparent, 100 = no opacity).
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).

Examples

1// Fills in the region between the startBar and endBar
2Draw.RegionHighlightX(this, "tag1", 10, 0, rushes.Blue);