Represents a set of records directly from a view or table. See RecordQueryResult for main documentation.
Do not instantiate. You can get instances of this class by calling
table.selectRecords
or view.selectRecords
.
Press shift + S to search API reference.
Represents a set of records directly from a view or table. See RecordQueryResult for main documentation.
Do not instantiate. You can get instances of this class by calling
table.selectRecords
or view.selectRecords
.
class TableOrViewQueryResult extends RecordQueryResult<TableOrViewQueryResultData>
readonly fields | Array<Field> | null The fields that were used to create this RecordQueryResult. Null if fields were not specified, which means the RecordQueryResult will load all fields in the table. |
readonly id | string The ID for this model. |
readonly isDataLoaded | boolean |
readonly isDeleted | boolean |
readonly recordIds | Array<string> The record IDs in this RecordQueryResult. Throws if data is not loaded yet. Can be watched. |
readonly records | Array<Record> The records in this RecordQueryResult. Throws if data is not loaded yet. Can be watched. |
getRecordById | Get a specific record in the query result, or throws if that record doesn't exist or is
filtered out. Throws if data is not loaded yet. Watch using |
getRecordByIdIfExists | Get a specific record in the query result, or null if that record doesn't exist or is
filtered out. Throws if data is not loaded yet. Watch using |
getRecordColor | Get the Color of a specific record in the query result. Returns null if the record
has no color in this query result. Throws if the record isn't in the RecordQueryResult. Watch
with the |
hasRecord | Check to see if a particular record or record id is present in this query result. Returns false if the record has been deleted or is filtered out. |
loadDataAsync | function () => Promise<void> |
toString | function () => string A string representation of the model for use in debugging. |
unloadData | function () => void |
unwatch | function (keys: WatchableRecordQueryResultKey | ReadonlyArray<WatchableRecordQueryResultKey>, callback: FlowAnyFunction, context?: FlowAnyObject | null) => Array<WatchableRecordQueryResultKey> |
watch | function (keys: WatchableRecordQueryResultKey | ReadonlyArray<WatchableRecordQueryResultKey>, callback: FlowAnyFunction, context?: FlowAnyObject | null) => Array<WatchableRecordQueryResultKey> |