Class Buffer

Index

Constructors

Methods

get getMeta getSize getValues

Constructors

constructor

new Buffer(id: string, handle: number, displacement?: number): Buffer
The Buffer object represents a series of scalar data values
Parameters
- id: string
- handle: number
- Optionaldisplacement: number
Returns Buffer

Methods

get

get(value: "id"): string
Parameters
- value: "id"
Returns string
get(
value: "handle" | "firstIndex" | "lastIndex" | "startIndex" | "endIndex",
): number
Parameters
- value: "handle" | "firstIndex" | "lastIndex" | "startIndex" | "endIndex"
Returns number
get(value: "empty" | "visible" | "leqz"): boolean
Parameters
- value: "empty" | "visible" | "leqz"
Returns boolean

getMeta

getMeta(): { [key: string]: any }
retrieves optional object containing meta data about the buffer. for example, this is used for point and figure buffers.

Returns { [key: string]: any }

getSize

getSize(): number
returns the size of the buffer

Returns number

getValues

getValues(): Float64Array
returns an array containing all values of the buffer.

data must not be modified directly; use methods of parent BG.charts.Data instance instead.

Returns Float64Array