Constructors Methodscreate Buffer createBuffer ( name ?: string , displacement ?: number ) : number Parameters Optional
name : string Optional
displacement : number Returns number get Begin getBegin ( id : number | "O" | "H" | "L" | "C" | "V" , inputIndex ?: number ) : number Parameters id : number | "O" | "H" | "L" | "C" | "V" Optional
inputIndex : number Returns number get Buffer Meta getBufferMeta ( id : number | "O" | "H" | "L" | "C" | "V" , inputIndex ?: number , ) : null | { [ key : string ]: any } Parameters id : number | "O" | "H" | "L" | "C" | "V" Optional
inputIndex : number Returns null | { [ key : string ]: any } get End getEnd ( id : number | "O" | "H" | "L" | "C" | "V" , inputIndex ?: number ) : number Parameters id : number | "O" | "H" | "L" | "C" | "V" Optional
inputIndex : number Returns number get Identifiers getIdentifiers () : number [] Returns number [] get Input Index getInputIndex ( number ?: number ) : number Returns number get Size getSize ( id : number | "O" | "H" | "L" | "C" | "V" , inputIndex ?: number ) : number Parameters id : number | "O" | "H" | "L" | "C" | "V" Optional
inputIndex : number Returns number get Values getValues ( id : number | "O" | "H" | "L" | "C" | "V" , inputIndex ?: number , ) : Float64Array Parameters id : number | "O" | "H" | "L" | "C" | "V" Optional
inputIndex : number Returns Float64Array release Buffer releaseBuffer ( bufferHandle : number ) : boolean Returns boolean require Buffer requireBuffer ( id : number | "O" | "H" | "L" | "C" | "V" , inputIndex ?: number , ) : boolean Parameters id : number | "O" | "H" | "L" | "C" | "V" Optional
inputIndex : number Returns boolean require Min Data Points requireMinDataPoints ( length : number ) : void Returns void require Warm Up Points requireWarmUpPoints ( length : number ) : void Returns void set Error setError ( error : string ) : void Returns void set Values setValues ( bufferHandle : number , beginIndex : number , values : number [] ) : void Parameters bufferHandle : number beginIndex : number values : number [] Returns void tickT tickT ( t : number , i : number , inputIndex ?: number ) : number Parameters t : number i : number Optional
inputIndex : 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" Optional
inputIndex : number Returns ( t : number ) => number
The IndicatorAPI class serves as an abstraction layer between the concrete indicator implementations and the BG.charts.Data and BG.charts.Buffer objects. It allows indicators to manage their result buffers or use other indicators for their own calculation