Class Data

Hierarchy (View Summary)

Constructors

constructor

Methods

addListener emit get getBuffer getCandleInfo getIdentifierByIndex getIdentifiers getIndexByIdentifier getIntervalStartIndices getOffsetByIndex isEmpty isUpdating listeners on once removeAllListeners removeListener setMaxListeners zoomSpan guard listenerCount setDefaultMaxListeners

Constructors

constructor

  • new Data(): BG.charts.Data

  • The Data object manages and controls multiple BG.charts.Buffer objects.

    It also offers additional features such as calculating indicators (using BG.charts.Indicator) on arbitrary buffers.

    Returns BG.charts.Data

Methods

addListener

  • addListener<Type extends "update", Callback extends (update: TUpdate) => void>(
        type: Type,
        listener: Callback,
    ): this

  • Type Parameters

    • Type extends "update"
    • Callback extends (update: TUpdate) => void

    Parameters

    Returns this

    Description

    adds a listener to the end of the listeners array for the specified event.

emit

  • emit<Type extends "update", Callback extends (update: TUpdate) => void>(
        type: Type,
        ...params: Parameters<Callback>,
    ): boolean

  • Type Parameters

    • Type extends "update"
    • Callback extends (update: TUpdate) => void

    Parameters

    Returns boolean

    Description

    execute each of the listeners in order with the supplied parameters.

get

  • get(v: "firstIndex" | "lastIndex" | "startIndex" | "endIndex"): number

  • returns value of requested config option

    firstIndex first index for which there are values in at least one buffer lastIndex last index for which there are values in at least one buffer startIndex first index in the current range. can be smaller than firstIndex endIndex last index in the current range. can be larger than lastIndex

    Parameters

    • v: "firstIndex" | "lastIndex" | "startIndex" | "endIndex"

    Returns number

getBuffer

  • getBuffer(handle: number): null | Buffer

  • returns the Buffer object with the specified handle

    Parameters

    • handle: number

      the handle of the requested buffer

    Returns null | Buffer

getCandleInfo

getIdentifierByIndex

  • getIdentifierByIndex(index: number): number

  • returns the identifier for the specified index

    Parameters

    • index: number

    Returns number

getIdentifiers

  • getIdentifiers(): number[]

  • returns an array containing all identifiers

    Returns number[]

getIndexByIdentifier

  • getIndexByIdentifier(identifier: number): number

  • returns the index for the specified identifier

    if there are multiple occurences of the requested identifier, returns the first exact match if there is no exact match, returns the index of the last identifier that is smaller than the requested one

    Parameters

    • identifier: number

    Returns number

getIntervalStartIndices

  • getIntervalStartIndices(interval: ESpans): number[]

  • returns a list of candles that begin at the start of the intervals of size as dictate by the tickT function

    Parameters

    • interval: ESpans

      the size of the interval in milliseconds

    Returns number[]

getOffsetByIndex

  • getOffsetByIndex(index: number): number

  • returns the numeric offset for the specified index will only be non-zero if the timestamp at the specified index is not distinct

    offset should be used in combination with the return value of getIdentifierByIndex

    Parameters

    • index: number

      an index

    Returns number

    numeric offset

isEmpty

  • isEmpty(): boolean

  • checks if data is empty

    Returns boolean

isUpdating

  • isUpdating(): boolean

  • checks if a update is currently active

    Returns boolean

listeners

on

once

  • once<Type extends "update", Callback extends (update: TUpdate) => void>(
        type: Type,
        listener: Callback,
    ): this

  • Type Parameters

    • Type extends "update"
    • Callback extends (update: TUpdate) => void

    Parameters

    Returns this

    Description

    adds a one time listener for the event. This listener is invoked only the next time the event is fired, after which it is removed.

removeAllListeners

  • removeAllListeners<Type extends "update">(type?: Type): this

  • Type Parameters

    • Type extends "update"

    Parameters

    Returns this

    Description

    removes all listeners, or those of the specified event.

removeListener

  • removeListener<
        Type extends "update",
        Callback extends (update: TUpdate) => void,
    >(
        type: Type,
        listener: Callback,
    ): this

  • Type Parameters

    • Type extends "update"
    • Callback extends (update: TUpdate) => void

    Parameters

    Returns this

    Description

    remove a listener from the listener array for the specified event.

setMaxListeners

  • setMaxListeners(maxListeners: number): this

  • Parameters

    • maxListeners: number

    Returns this

    Description

    by default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default which helps finding memory leaks. Obviously not all Emitters should be limited to 10. This function allows that limit to be increased. Set to zero for unlimited.

zoomSpan

  • zoomSpan(startIndex: number, endIndex: number): boolean

  • zooms in/out to the specified span

    Parameters

    • startIndex: number

      first index of the new span

    • endIndex: number

      last index of the new span

    Returns boolean

Staticguard

  • guard(cb: Function): void

  • Parameters

    • cb: Function

    Returns void

    Description

    set custom error handler for event listeners

StaticlistenerCount

StaticsetDefaultMaxListeners

  • setDefaultMaxListeners(maxListeners: number): void

  • Parameters

    • maxListeners: number

    Returns void

    Description

    set default amount for limit warning

Settings

Member Visibility

On This Page

Constructors
Methods