Overlay description in Help manual

[zacharydw00]

Definition
If true, any indicator plot(s) are drawn on the chart panel over top of price.

Property Value
This property returns true if any indicator plot(s) are drawn on the chart panel; otherwise, false. Default set to true.


FYI - The statement in red is incorrect. Printing Overlay to the Output window always returns False.

[NinjaTrader_Bertrand]

Zac, I don't follow you - from where are you printing it? It would entirely depend on what you've set it to in the Initialize().

[zacharydw00]

Not that it matters, but I was trying to use this in a custom Stochastic ind.

In Initialize() Overlay is not set.

In OnStartUp() i have
Print("Overlay = "+ Overlay);

In the Indicator Window:
If I set the ind. to plot on panel 2(not data series panel), Overlay returns False, which agrees with Help manual

If I set the ind. to plot on the data series panel, Overlay returns False, which disagrees with Help manual

The Help manual says "This property returns true if any indicator plot(s) are drawn on the chart panel"

[NinjaTrader_Bertrand]

I could reproduce but I'm not sure if that's in the supported usage boundaries - I'll clarify with our developers.

[NinjaTrader_Bertrand]

The outcome you get here is unfortunately expected, to check which panel you're on you could work with the unsupported Panel / PanelUI properties.

Panel = your first panel is 0, second would be 1 and so on...
PanelUI = your first panel is 1, second would be 2 and so on...

[zacharydw00]

Thanks for looking into this. Please note that the purpose of my post is to notify NT that the Help manual is incorrect as written. I suggest it be updated with the clarity it needs.

Have a good one.

[NinjaTrader_Bertrand]

You're welcome - the help manual is correctly written - if you set Overlay as needed / documented in Initialize()