ReferencesCommonDrawing

Draw.RiskReward()

View as Markdown

Definition

Draws a risk/reward on a chart.

Method Return Value

A RiskReward object that represents the draw object.

Syntax

Draw.RiskReward(NinjaScriptBase owner, string tag, bool isAutoScale, DateTime entryTime, double entryY, DateTime endTime, double endY, double ratio, bool isStop)

Draw.RiskReward(NinjaScriptBase owner, string tag, bool isAutoScale, int entryBarsAgo, double entryY, int endBarsAgo, double endY, double ratio, bool isStop)

Draw.RiskReward(NinjaScriptBase owner, string tag, bool isAutoScale, DateTime entryTime, double entryY, DateTime endTime, double endY, double ratio, bool isStop, bool isGlobal, string templateName)

Draw.RiskReward(NinjaScriptBase owner, string tag, bool isAutoScale, int entryBarsAgo, double entryY, int endBarsAgo, double endY, double ratio, bool isStop, 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.
isAutoScaleDetermines if the draw object will be included in the y-axis scale. Default value is false.
entryTimeThe time where the draw object’s entry will be drawn.
entryBarsAgoThe starting bar (x axis co-ordinate) where the draw object’s entry will be drawn. For example, a value of 10 would paint the draw object 10 bars back.
entryYThe y value co-ordinate where the draw object’s entry price 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.
endYThe starting y value co-ordinate where the draw object will be drawn.
ratioA double value determining the calculated ratio between the risk and reward based on the entry point. Example: reward : risk is ratio of 1.0.
isStopA bool value, when true will use the endTime / endBarsAgo and endY to set the stop and will automatically calculate the target based off the ratio value. When false, will set the target and will automatically calculate the stop based off the ratio value.
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// draw a risk/reward tool starting from the current bar to 10 bars ago
2// with calculate a ratio of 2 based on stop level
3Draw.RiskReward(this, "tag1", false, 0, High[0], 10, Low[0], 2, true);