Class LABKEY.Query.ExtendedSelectRowsResults
ExtendedSelectRowsResults class to describe the first object passed to the successCallback function by LABKEY.Query.selectRows if config.requiredVersion is set to "9.1".
Additional Documentation:
Defined in: Query.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Field Attributes | Field Name and Description |
---|---|
Contains information about how one may interact
with the columns within a user interface.
|
|
Contains type and lookup information about the columns in the resultset.
|
|
Array of field information.
|
|
Name of the primary key column.
|
|
Name of the property containing rows ("rows").
|
|
Sort specification in Ext grid terms.
|
|
Name of the top-level property
containing the row count ("rowCount") in our case.
|
|
Indicates the number of total rows that could be
returned by the query, which may be more than the number of objects
in the rows array if the client supplied a value for the query.maxRows
or query.offset parameters.
|
|
An array of rows, each of which is a
sub-element/object containing an object per column.
|
Field Detail
{String}
columnModel
Contains information about how one may interact
with the columns within a user interface. This format is generated
to match the requirements of the Ext grid component. See
Ext.grid.ColumnModel for further information.
{Object}
metaData
Contains type and lookup information about the columns in the resultset.
{Object[]}
metaData.fields
Array of field information.
Each field has the following properties:
- name -- The name of the field
- type -- JavaScript type name of the field
- shownInInsertView -- whether this field is intended to be shown in insert views
- shownInUpdateView -- whether this field is intended to be shown in update views
- shownInDetailsView -- whether this field is intended to be shown in details views
- measure -- whether this field is a measure. Measures are fields that contain data subject to charting and other analysis.
- dimension -- whether this field is a dimension. Data dimensions define logical groupings of measures.
- hidden -- whether this field is hidden and not normally shown in grid views
- lookup -- If the field is a lookup, there will be four sub-properties listed under this property: schema, table, displayColumn, and keyColumn, which describe the schema, table, and display column, and key column of the lookup table (query).
{String}
metaData.id
Name of the primary key column.
{String}
metaData.root
Name of the property containing rows ("rows"). This is mainly for the Ext grid component.
{Object}
metaData.sortInfo
Sort specification in Ext grid terms.
This contains two sub-properties, field and direction, which indicate
the sort field and direction ("ASC" or "DESC") respectively.
{String}
metaData.totalProperty
Name of the top-level property
containing the row count ("rowCount") in our case. This is mainly
for the Ext grid component.
{Integer}
rowCount
Indicates the number of total rows that could be
returned by the query, which may be more than the number of objects
in the rows array if the client supplied a value for the query.maxRows
or query.offset parameters. This value is useful for clients who wish
to display paging UI, such as the Ext grid.
{Object[]}
rows
An array of rows, each of which is a
sub-element/object containing an object per column. The
object will always contain a property named "value" that is the
column's value, but it may also contain other properties about
that column's value. For example, if the column was setup to track
missing value information, it will also contain a property named mvValue (which
is the raw value that is considered suspect), and a property named
mvIndicator, which will be the string MV indicator (e.g., "Q").