Class Index | File Index

Classes


Class LABKEY.Query.SelectRowsResults

SelectRowsResults class to describe the first 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.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
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.
 
the name of the resultset's source query.
 
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 a property per column.
 
the name of the resultset's source schema.
Class Detail
LABKEY.Query.SelectRowsResults()
See:
LABKEY.Query.selectRows
Field Detail
{Object[]} 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.

{LABKEY.Query.FieldMetaData[]} metaData.fields
Array of field information.

{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.

{String} queryName
the name of the resultset's source query. In some cases, such as an 'executeSql' call with 'saveInSession' set to true, the query name may refer to temporary query that can be used to re-retrieve data for the duration of the user's session.

{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 that 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 a property per column.

{String} schemaName
the name of the resultset's source schema.

Documentation generated by JsDoc Toolkit 2.3.2 on Thu Jun 11 2020 17:30:57 GMT-0000 (UTC)