RowList
Defined in: js-api/src/dataframe/row.ts:200
Represents rows of the [DataFrame].
Refrain from accessing data via [RowList] and [Row] in performance-critical scenarios. To maximize performance, get values via [DataFrame.columns], instead.
Constructors
Constructor
new RowList(
table,dart):RowList
Defined in: js-api/src/dataframe/row.ts:204
Parameters
| Parameter | Type |
|---|---|
table | DataFrame |
dart | any |
Returns
RowList
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
dart | readonly | any | js-api/src/dataframe/row.ts:201 |
table | readonly | DataFrame | js-api/src/dataframe/row.ts:202 |
Accessors
filters
Get Signature
get filters():
DartList<string>
Defined in: js-api/src/dataframe/row.ts:214
List of textual descriptions of currently applied filters
Returns
DartList<string>
mouseOverRowFunc
Get Signature
get mouseOverRowFunc():
IndexPredicate
Defined in: js-api/src/dataframe/row.ts:217
Predicate that tells whether a row index is the mouse-over row.
Returns
Methods
_applyPredicate()
_applyPredicate(
bitset,rowPredicate):void
Defined in: js-api/src/dataframe/row.ts:285
Parameters
| Parameter | Type |
|---|---|
bitset | BitSet |
rowPredicate | RowPredicate |
Returns
void
[iterator]()
[iterator]():
Generator<Row,void,unknown>
Defined in: js-api/src/dataframe/row.ts:263
Iterates over all rows.
Returns
Generator<Row, void, unknown>
addFilterState()
addFilterState(
state):void
Defined in: js-api/src/dataframe/row.ts:320
Adds a filter state. This should be done in the onRowsFiltering handler. This is needed for filter synchronization.
Parameters
| Parameter | Type |
|---|---|
state | FilterState |
Returns
void
addNew()
addNew(
values?,notify?):Row
Defined in: js-api/src/dataframe/row.ts:258
Appends a new row with the specified values
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
values | any[] | null | null | List of values (length and types should match columns) |
notify | boolean | true | Whether a change notification should be fired. |
Returns
filter()
filter(
rowPredicate):void
Defined in: js-api/src/dataframe/row.ts:302
Filters rows by predicate. See DataFrame.filter Sample: https://public.datagrok.ai/js/samples/data-frame/row-matching/select-rows
Parameters
| Parameter | Type |
|---|---|
rowPredicate | RowPredicate |
Returns
void
get()
get(
i):Row
Defined in: js-api/src/dataframe/row.ts:211
Gets i-th row. DO NOT USE IN PERFORMANCE-CRITICAL CODE!
Parameters
| Parameter | Type |
|---|---|
i | number |
Returns
highlight()
highlight(
indexPredicate):void
Defined in: js-api/src/dataframe/row.ts:308
Highlights the corresponding rows.
Parameters
| Parameter | Type |
|---|---|
indexPredicate | IndexPredicate | null |
Returns
void
indexes()
indexes(
options?):WuIterable<number>
Defined in: js-api/src/dataframe/row.ts:227
Row indexes, optionally restricted to the filtered or selected rows.
Parameters
| Parameter | Type |
|---|---|
options? | { onlyFiltered?: boolean; onlySelected?: boolean; } |
options.onlyFiltered? | boolean |
options.onlySelected? | boolean |
Returns
WuIterable<number>
insertAt()
insertAt(
idx,count?,notify?):void
Defined in: js-api/src/dataframe/row.ts:251
Inserts empty rows at the specified position
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
idx | number | undefined | - |
count? | number | 1 | Number of rows to insert. |
notify? | boolean | true | Whether a change notification should be fired. |
Returns
void
match()
match(
query):RowMatcher
Defined in: js-api/src/dataframe/row.ts:279
Creates a query matcher. Sample: https://public.datagrok.ai/js/samples/data-frame/row-matching/patterns
Parameters
| Parameter | Type |
|---|---|
query | string | object |
Returns
removeAt()
removeAt(
idx,count?,notify?):void
Defined in: js-api/src/dataframe/row.ts:234
Removes specified rows
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
idx | number | undefined | - |
count? | number | 1 | Number of rows to remove. |
notify? | boolean | true | Whether a change notification should be fired. |
Returns
void
removeWhere()
removeWhere(
rowPredicate):void
Defined in: js-api/src/dataframe/row.ts:239
Removes specified rows
Parameters
| Parameter | Type |
|---|---|
rowPredicate | RowPredicate |
Returns
void
removeWhereIdx()
removeWhereIdx(
indexPredicate):void
Defined in: js-api/src/dataframe/row.ts:244
Removes specified rows
Parameters
| Parameter | Type |
|---|---|
indexPredicate | IndexPredicate |
Returns
void
requestFilter()
requestFilter():
void
Defined in: js-api/src/dataframe/row.ts:314
Viewers that filter rows should subscribe to DataFrame.onRowsFiltering event. When filtering conditions are changed, viewers should call requestFilter().
Returns
void
select()
select(
rowPredicate):void
Defined in: js-api/src/dataframe/row.ts:294
Selects rows by predicate. See DataFrame.selection Sample: https://public.datagrok.ai/js/samples/data-frame/row-matching/select-rows
Parameters
| Parameter | Type |
|---|---|
rowPredicate | RowPredicate |
Returns
void
setValues()
setValues(
idx,values,notify?):void
Defined in: js-api/src/dataframe/row.ts:272
Sets values for the specified row.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
idx | number | undefined | Row index. |
values | any[] | undefined | List of values (length and types should match columns) |
notify | boolean | true | Raise onDataChanged event |
Returns
void
toString()
toString():
string
Defined in: js-api/src/dataframe/row.ts:325
Returns
string
where()
where(
indexPredicate):WuIterable<number>
Defined in: js-api/src/dataframe/row.ts:222
Indexes of the rows that satisfy [indexPredicate].
Parameters
| Parameter | Type |
|---|---|
indexPredicate | IndexPredicate |
Returns
WuIterable<number>