DataFrameBuilder
Defined in: packages/model-dataset/src/frame/data-frame-builder.ts:31
Fills a frame in row by row, and lets a row already written be rewritten.
This is the incremental path: a live view knows the schema before the first
observation arrives, appends a placeholder row when one starts, and
overwrites it as better answers come in. A partially-filled frame renders as
readily as a complete one — the unwritten cells are simply null.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DataFrameBuilder(
fields,meta_?):DataFrameBuilder
Defined in: packages/model-dataset/src/frame/data-frame-builder.ts:37
Parameters
Section titled “Parameters”fields
Section titled “fields”readonly FieldDescriptor[]
meta_?
Section titled “meta_?”Returns
Section titled “Returns”DataFrameBuilder
Accessors
Section titled “Accessors”rowCount
Section titled “rowCount”Get Signature
Section titled “Get Signature”get rowCount():
number
Defined in: packages/model-dataset/src/frame/data-frame-builder.ts:48
Returns
Section titled “Returns”number
Methods
Section titled “Methods”appendRow()
Section titled “appendRow()”appendRow(
row?):number
Defined in: packages/model-dataset/src/frame/data-frame-builder.ts:57
Appends a row, padding missing trailing cells with null.
Parameters
Section titled “Parameters”readonly Value[]
Returns
Section titled “Returns”number
The new row’s index, for a later setCell.
build()
Section titled “build()”build():
DataFrame
Defined in: packages/model-dataset/src/frame/data-frame-builder.ts:98
Snapshots the rows written so far. O(r × f).
Complete numeric columns are packed into a Float64Array; anything with a
gap or a non-numeric cell stays boxed. The result shares no storage with
the builder, so building again after more rows is safe.
Returns
Section titled “Returns”setCell()
Section titled “setCell()”setCell(
rowIndex,fieldName,value):void
Defined in: packages/model-dataset/src/frame/data-frame-builder.ts:78
Parameters
Section titled “Parameters”rowIndex
Section titled “rowIndex”number
fieldName
Section titled “fieldName”string
Returns
Section titled “Returns”void
Throws
Section titled “Throws”When no field carries that name.
setMeta()
Section titled “setMeta()”setMeta(
meta):void
Defined in: packages/model-dataset/src/frame/data-frame-builder.ts:87
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
setRow()
Section titled “setRow()”setRow(
rowIndex,row):void
Defined in: packages/model-dataset/src/frame/data-frame-builder.ts:70
Overwrites a row already appended. Rows between the last one and rowIndex
are created empty.
Parameters
Section titled “Parameters”rowIndex
Section titled “rowIndex”number
readonly Value[]
Returns
Section titled “Returns”void