HTFCandlesLib

Oct 21

Library "HTFCandlesLib"
Library to get detailed higher timeframe candle information

method tostring(this, delimeter)
  Returns OHLC values, BarIndex of higher and lower timeframe candles in string format
  Namespace types: Candle
  Parameters:
    this (Candle): Current Candle object
    delimeter (string): delimeter to join the string components of the candle
  Returns: String representation of the Candle

method draw(this, bullishColor, bearishColor, printDescription)
  Draws the current candle using boxes and lines for body and wicks
  Namespace types: Candle
  Parameters:
    this (Candle): Current Candle object
    bullishColor (color): color for bullish representation
    bearishColor (color): color for bearish representation
    printDescription (bool): if set to true prints the description
  Returns: Current candle object

getCurrentCandle(ltfCandles)
  Gets the current candle along with reassigned ltf components. To be used with request.security to capture higher timeframe candle data
  Parameters:
    ltfCandles (array<Candle>): Lower timeframe Candles array
  Returns: Candle object with embedded lower timeframe key candles in them

Candle
  Candle represents the data related to a candle
  Fields:
    o (series float): Open price of the candle
    h (series float): High price of the candle
    l (series float): Low price of the candle
    c (series float): Close price of the candle
    lo (Candle): Lower timeframe candle that records the open price of the current candle.
    lh (Candle): Lower timeframe candle that records the high price of the current candle.
    ll (Candle): Lower timeframe candle that records the low price of the current candle.
    lc (Candle): Lower timeframe candle that records the close price of the current candle.
    barindex (series int): Bar Index of the candle
    bartime (series int): Bar time of the candle
    last (Candle): Link to last candle of the series if any

3 days ago

Release Notes

v2

Added:
getOHLC(offset)
  Returns higher timeframe OHLC options with given offset. To be used within request.security
  Parameters:
    offset (int): Offset to current bar index
  Returns: [open, high, low, close, bar_index, time, time_close] for given timeframe in security call

getCandleFromOhlc(o, h, l, c, b, t, isChartTimeframe)
  Gets the current candle along with reassigned ltf components. To be used with request.security to capture higher timeframe candle data
  Parameters:
    o (float): Open price of the candle
    h (float): High price of the candle
    l (float): Low price of the candle
    c (float): Close price of the candle
    b (int): Bar Index of the candle
    t (int): Bar time of the candle
    isChartTimeframe (bool): true if using current chart timeframe, false otherwise
  Returns: Candle object with embedded lower timeframe key candles in them

LTFCandle
  LTFCandle type. Replica of Candle. Created to avoid issues with respect to runtime errors
  Fields:
    o (series float): Open price of the candle
    h (series float): High price of the candle
    l (series float): Low price of the candle
    c (series float): Close price of the candle
    barindex (series int): Bar Index of the candle
    bartime (series int): Bar time of the candle
    bartimeclose (series int): Bar time of the candle

Updated:
Candle
  Candle represents the data related to a candle
  Fields:
    o (series float): Open price of the candle
    h (series float): High price of the candle
    l (series float): Low price of the candle
    c (series float): Close price of the candle
    barindex (series int): Bar Index of the candle
    bartime (series int): Bar time of the candle
    lo (LTFCandle): Lower timeframe candle that records the open price of the current candle.
    lh (LTFCandle): Lower timeframe candle that records the high price of the current candle.
    ll (LTFCandle): Lower timeframe candle that records the low price of the current candle.
    lc (LTFCandle): Lower timeframe candle that records the close price of the current candle.
    last (Candle): Link to last candle of the series if any
    direction (series float): Direction of the candle with respect to last Candle

Removed:
getCurrentCandle(ltfCandles)
  Gets the current candle along with reassigned ltf components. To be used with request.security to capture higher timeframe candle data