ReferencesCommonDrawing

Draw.Text()

View as Markdown

Definition

Draws text.

Method Return Value

A Text object that represents the draw object.

Syntax

Draw.Text(NinjaScriptBase owner, string tag, string text, int barsAgo, double y)

Draw.Text(NinjaScriptBase owner, string tag, string text, int barsAgo, double y, Brush textBrush)

Draw.Text(NinjaScriptBase owner, string tag, string text, int barsAgo, double y, bool isGlobal, string templateName)

Draw.Text(NinjaScriptBase owner, string tag, bool isAutoScale, string text, int barsAgo, double y, int yPixelOffset, Brush textBrush, SimpleFont font, TextAlignment alignment, Brush outlineBrush, Brush areaBrush, int areaOpacity)

Draw.Text(NinjaScriptBase owner, string tag, bool isAutoScale, string text, DateTime time, double y, int yPixelOffset, Brush textBrush, SimpleFont font, TextAlignment alignment, Brush outlineBrush, Brush areaBrush, int areaOpacity)

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.
textThe text you wish to draw.
barsAgoThe 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.
timeThe time where the draw object will be drawn.
yThe y co-ordinate location the object will be drawn.
yPixelOffsetThe offset value in pixels from within the text box area.
textBrushThe brush used to color the text of the draw object (reference).
fontA Simple Font object.
alignmentTextAlignment.Center, TextAlignment.Left, TextAlignment.Right, TextAlignment.Justify (reference).
outlineBrushThe brush used to color the text box outline (reference).
areaBrushThe brush used to color the text box fill area (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// Draws text
2Draw.Text(this, "tag1", "Text to draw", 10, 1000, Brushes.Black);

Tip: In some cases, it may be useful to pass in the ChartControl.Properties TextFont brush as well as the LabelFont SimpleFont object to render your custom text. This will help ensure that the text will be visible and match what a user has configured for their chart label display settings.

1// match the text brush to what the user has configured on their chart
2Draw.Text(this, "tag1", "Text to draw", 10, 1000, ChartControl.Properties.ChartText);