ReferencesCommonDrawing

Draw.TextFixed()

View as Markdown

Definition

Draws text in one of 5 available pre-defined fixed locations on panel 1 (price panel) of a chart. Please note the Z-Order is internally set for the method to always be drawn on top.

Method Return Value

A TextFixed object that represents the draw object.

Syntax

Draw.TextFixed(NinjaScriptBase owner, string tag, string text, TextPosition textPosition, Brush textBrush, SimpleFont font, Brush outlineBrush, Brush areaBrush, int areaOpacity)

Draw.TextFixed(NinjaScriptBase owner, string tag, string text, TextPosition textPosition)

Draw.TextFixed(NinjaScriptBase owner, string tag, string text, TextPosition textPosition, 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.
  • text
  • The text you wish to draw.
  • TextPosition
  • TextPosition.BottomLeft
  • TextPosition.BottomRight
  • TextPosition.Center
TextPosition.TopLeftTextPosition.TopRight
textBrushThe brush used to color the text of the draw object (reference).
fontA SimpleFont object.
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 in the upper right corner of panel 1
2Draw.TextFixed(this, "tag1", "Text to draw", TextPosition.TopRight);

Tip: In some cases, it may be useful to pass in the ChartControl.Properties TextFont brush as well as the LabelFontSimpleFont 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.TextFixed(this, "myTextFixed", "Hello world!", TextPosition.BottomRight, ChartControl.Properties.ChartText, ChartControl.Properties.LabelFont, Brushes.Blue, Brushes.Transparent, 0);