Class LABKEY.Query.SelectRowsOptions
SelectRowsOptions class to describe the third object passed to the successCallback function by LABKEY.Query.selectRows. This object's properties are useful for matching requests to responses, as HTTP requests are typically processed asynchronously.
Additional Documentation:
Defined in: Query.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Field Attributes | Field Name and Description |
---|---|
An object whose properties are filter specifications, one for each filter you supplied.
|
|
Maximum number of rows to return
|
|
Row number at which results should begin.
|
|
Contains the same queryName the client passed
to the calling function.
|
|
Contains the same schemaName the client passed to the
calling function.
|
|
Sort specification.
|
|
Name of a valid custom view for the chosen queryName.
|
Field Detail
{Object}
filters
An object whose properties are filter specifications, one for each filter you supplied.
All filters are combined using AND logic. Each one is of type LABKEY.Filter.FilterDefinition.
The list of valid operators:
- eq = equals
- neq = not equals
- gt = greater-than
- gte = greater-than or equal-to
- lt = less-than
- lte = less-than or equal-to
- dateeq = date equal
- dateneq = date not equal
- neqornull = not equal or null
- isblank = is null
- isnonblank = is not null
- contains = contains
- doesnotcontain = does not contain
- startswith = starts with
- doesnotstartwith = does not start with
- in = equals one of
{Integer}
maxRows
Maximum number of rows to return
{Integer}
query.offset
Row number at which results should begin.
Use this with maxRows to get pages of results.
{String}
query.queryName
Contains the same queryName the client passed
to the calling function. See
How To Find schemaName, queryName & viewName.
{String}
query.schemaName
Contains the same schemaName the client passed to the
calling function. See
How To Find schemaName, queryName & viewName.
{String}
query.sort
Sort specification. This can be a comma-delimited list of
column names, where each column may have an optional dash (-) before the name
to indicate a descending sort.
{String}
query.viewName
Name of a valid custom view for the chosen queryName. See
How To Find schemaName, queryName & viewName.