Candlestick Patterns

Breakaway

Introduction

Create a new Breakaway candlestick pattern indicator to indicate the pattern's presence.

Create Manual Indicators

A candlestick pattern indicator requires manual creation and update with a TradeBar object. Manual indicators let you update their values with any data you choose. The following reference table describes the Breakaway constructor.

Breakaway()1/2

            Breakaway QuantConnect.Indicators.CandlestickPatterns.Breakaway (
     string  name
   )
        

Initializes a new instance of the Breakaway class using the specified name.

Breakaway()2/2

            Breakaway QuantConnect.Indicators.CandlestickPatterns.Breakaway (
   )
        

Initializes a new instance of the Breakaway class.

Update Manual Indicators

You can update the indicator automatically or manually.

Automatic Update

To register a manual indicator for automatic updates with the security data, call the RegisterIndicator method.

using QuantConnect.Indicators.CandlestickPatterns;

private Breakaway _breakaway;

// In Initialize()
_breakaway = new Breakaway(name);
_breakaway.Updated += IndicatorUpdateMethod;

RegisterIndicator(symbol, _breakaway, Resolution.Daily);

// In IndicatorUpdateMethod()
if (_breakaway.IsReady)
{
    var indicatorValue = _breakaway.Current.Value;
}
from QuantConnect.Indicators.CandlestickPatterns import Breakaway
    
# In Initialize()
self.breakaway = Breakaway(name)
self.breakaway.Updated += self.IndicatorUpdateMethod

self.RegisterIndicator(symbol, self.breakaway, Resolution.Daily)

# In IndicatorUpdateMethod()
if self.breakaway.IsReady:
    indicator_value = self.breakaway.Current.Value

To customize the data that automatically updates the indicator, see Custom Indicator Periods and Custom Indicator Values.

Manual Update

Updating your indicator manually enables you to control when the indicator is updated and what data you use to update it. To manually update the indicator, call the Update method with a TradeBar. The indicator will only be ready after you prime it with enough data.

using QuantConnect.Indicators.CandlestickPatterns;
    
private Breakaway _breakaway;
private Symbol symbol;

// In Initialize()
_breakaway = new Breakaway();
symbol = AddEquity("SPY").Symbol;

// In OnData()
if (data.Bars.ContainsKey(_symbol))
{
    _breakaway.Update(data.Bars[symbol]);
}
if (_breakaway.IsReady)
{
    var indicatorValue = _breakaway.Current.Value;
}
from QuantConnect.Indicators.CandlestickPatterns import Breakaway
    
# In Initialize()
self.breakaway = Breakaway()
self.symbol = self.AddEquity("SPY").Symbol

# In OnData()
if data.Bars.ContainsKey(self.symbol):
    self.breakaway.Update(data.Bars[self.symbol])
if self.breakaway.IsReady:
    indicator_value = self.breakaway.Current.Value

Get Indicator Values

To get the value of the indicator, use its Current.Value attribute.

private Breakaway _breakaway;

// In Initialize()
var symbol = AddEquity("SPY").Symbol;
_breakaway = Breakaway(symbol);

// In OnData()
if (_breakaway.IsReady)
{
    var current = _breakaway.Current.Value;
}
# In Initialize()
symbol = self.AddEquity("SPY").Symbol
self.breakaway = self.Breakaway(symbol)

# In OnData()
if self.breakaway.IsReady:
    current = self.breakaway.Current.Value

Visualization

To plot indicator values, in the OnData event handler, call the Plot method.

private Breakaway _breakaway;

// In Initialize()
var symbol = AddEquity("SPY").Symbol;
_breakaway = Breakaway(symbol);

// In OnData()
if (_breakaway.IsReady)
{
    Plot("My Indicators", "breakaway", _breakaway.Current);
}
# In Initialize()
symbol = self.AddEquity("SPY").Symbol
self.breakaway = self.Breakaway(symbol)

# In OnData()
if self.breakaway.IsReady:
    self.Plot("My Indicators", "breakaway", self.breakaway.Current)

The following image shows the plot values in a matplotlib plot. To load algorithm plot data into the Research Environment, see Charts.

For more information about plotting indicators, see Plotting Indicators.

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: