Class IndicatorAPI

The IndicatorAPI class serves as an abstraction layer between the concrete indicator implementations and the Data and Buffer objects. It allows indicators to manage their result buffers or use other indicators for their own calculation

Index

Constructors

Methods

createBuffer getBegin getBufferMeta getCandleInfo getEnd getIdentifiers getInputIndex getInputs getSize getValues releaseBuffer requireBuffer requireMinDataPoints requireWarmUpPoints setError setValues tickT v

Constructors

constructor

new IndicatorAPI(data: Data): IndicatorAPI
Parameters
- data: Data
Returns IndicatorAPI

Methods

createBuffer

createBuffer(name?: string, displacement?: number): number
Parameters
- Optionalname: string
- Optionaldisplacement: number
Returns number

getBegin

getBegin(id: number | "O" | "H" | "C" | "L" | "V", inputIndex?: number): number
Parameters
- id: number | "O" | "H" | "C" | "L" | "V"
- OptionalinputIndex: number
Returns number

getBufferMeta

getBufferMeta(
id: number | "O" | "H" | "C" | "L" | "V",
inputIndex?: number,
): { [key: string]: any } | null
Parameters
- id: number | "O" | "H" | "C" | "L" | "V"
- OptionalinputIndex: number
Returns { [key: string]: any } | null

getCandleInfo

getCandleInfo(): DataTMetaData
Returns DataTMetaData

getEnd

getEnd(id: number | "O" | "H" | "C" | "L" | "V", inputIndex?: number): number
Parameters
- id: number | "O" | "H" | "C" | "L" | "V"
- OptionalinputIndex: number
Returns number

getIdentifiers

getIdentifiers(): number[]
Returns number[]

getInputIndex

getInputIndex(number?: number): number
Parameters
- Optionalnumber: number
Returns number

getInputs

getInputs(): DataTOHLCSet[] | undefined
Returns DataTOHLCSet[] | undefined

getSize

getSize(id: number | "O" | "H" | "C" | "L" | "V", inputIndex?: number): number
Parameters
- id: number | "O" | "H" | "C" | "L" | "V"
- OptionalinputIndex: number
Returns number

getValues

getValues(
id: number | "O" | "H" | "C" | "L" | "V",
inputIndex?: number,
): Float64Array
Parameters
- id: number | "O" | "H" | "C" | "L" | "V"
- OptionalinputIndex: number
Returns Float64Array

releaseBuffer

releaseBuffer(bufferHandle: number): boolean
Parameters
- bufferHandle: number
Returns boolean

requireBuffer

requireBuffer(
id: number | "O" | "H" | "C" | "L" | "V",
inputIndex?: number,
): boolean
Parameters
- id: number | "O" | "H" | "C" | "L" | "V"
- OptionalinputIndex: number
Returns boolean

requireMinDataPoints

requireMinDataPoints(length: number): void
Parameters
- length: number
Returns void

requireWarmUpPoints

requireWarmUpPoints(length: number): void
Parameters
- length: number
Returns void

setError

setError(error: string): void
Parameters
- error: string
Returns void

setValues

setValues(
    bufferHandle: number,
    beginIndex: number,
    values: number[] | Float64Array<ArrayBufferLike>,
): void
Parameters
- bufferHandle: number
  a buffer handle
- beginIndex: number
  offset of the first value
- values: number[] | Float64Array<ArrayBufferLike>
  an array of value numbers
Returns void

tickT

tickT(t: number, i: number, inputIndex?: number): number
Parameters
- t: number
- i: number
- OptionalinputIndex: number
Returns number

v

v(
    value:
        | "open"
        | "high"
        | "low"
        | "close"
        | "hl2"
        | "hlc3"
        | "ohlc4"
        | "hlcc4",
    inputIndex?: number,
): (t: number) => number
Parameters
- value: "open" | "high" | "low" | "close" | "hl2" | "hlc3" | "ohlc4" | "hlcc4"
- OptionalinputIndex: number
Returns (t: number) => number