Class: RowList
dg.RowList
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)
Parameters
| Name | Type |
|---|---|
table | DataFrame |
dart | any |
Defined in
Properties
dart
• Readonly dart: any
Defined in
table
• Readonly table: DataFrame
Defined in
Accessors
filters
• get filters(): DartList<string>
List of textual descriptions of currently applied filters
Returns
DartList<string>
Defined in
mouseOverRowFunc
• get mouseOverRowFunc(): IndexPredicate
Returns
Defined in
Methods
[iterator]
▸ [iterator](): Generator<Row, void, unknown>
Iterates over all rows.
Returns
Generator<Row, void, unknown>
Defined in
_applyPredicate
▸ _applyPredicate(bitset, rowPredicate): void
Parameters
| Name | Type |
|---|---|
bitset | BitSet |
rowPredicate | RowPredicate |
Returns
void
Defined in
addFilterState
▸ addFilterState(state): void
Adds a filter state. This should be done in the onRowsFiltering handler. This is needed for filter synchronization.
Parameters
| Name | Type |
|---|---|
state | FilterState |
Returns
void
Defined in
addNew
▸ addNew(values?, notify?): Row
Appends a new row with the specified values
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
values | null | any[] | null | List of values (length and types should match columns) |
notify | boolean | true | Whether a change notification should be fired. |
Returns
Defined in
filter
▸ filter(rowPredicate): void
Filters rows by predicate. See filter Sample: https://public.datagrok.ai/js/samples/data-frame/row-matching/select-rows
Parameters
| Name | Type |
|---|---|
rowPredicate | RowPredicate |
Returns
void
Defined in
get
▸ get(i): Row
Gets i-th row. DO NOT USE IN PERFORMANCE-CRITICAL CODE!
Parameters
| Name | Type |
|---|---|
i | number |
Returns
Defined in
highlight
▸ highlight(indexPredicate): void
Highlights the corresponding rows.
Parameters
| Name | Type |
|---|---|
indexPredicate | null | IndexPredicate |
Returns
void
Defined in
insertAt
▸ insertAt(idx, count?, notify?): void
Inserts empty rows at the specified position
Parameters
| Name | 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
Defined in
match
▸ match(query): RowMatcher
Creates a query matcher. Sample: https://public.datagrok.ai/js/samples/data-frame/row-matching/patterns
Parameters
| Name | Type |
|---|---|
query | string | object |
Returns
Defined in
removeAt
▸ removeAt(idx, count?, notify?): void
Removes specified rows
Parameters
| Name | 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
Defined in
removeWhere
▸ removeWhere(rowPredicate): void
Removes specified rows
Parameters
| Name | Type |
|---|---|
rowPredicate | RowPredicate |
Returns
void
Defined in
removeWhereIdx
▸ removeWhereIdx(indexPredicate): void
Removes specified rows
Parameters
| Name | Type |
|---|---|
indexPredicate | IndexPredicate |
Returns
void
Defined in
requestFilter
▸ requestFilter(): void
Viewers that filter rows should subscribe to DataFrame.onRowsFiltering event. When filtering conditions are changed, viewers should call requestFilter().
Returns
void
Defined in
select
▸ select(rowPredicate): void
Selects rows by predicate. See selection Sample: https://public.datagrok.ai/js/samples/data-frame/row-matching/select-rows
Parameters
| Name | Type |
|---|---|
rowPredicate | RowPredicate |
Returns
void
Defined in
setValues
▸ setValues(idx, values, notify?): void
Sets values for the specified row.
Parameters
| Name | 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
Defined in
toString
▸ toString(): string
Returns
string
Defined in
where
▸ where(indexPredicate): Iterable<any>
Parameters
| Name | Type |
|---|---|
indexPredicate | IndexPredicate |
Returns
Iterable<any>