Class Index | File Index

Classes


Class LABKEY.Query.Row

LABKEY.Query.Row The class used to wrap each row object returned from the server during a GetData, executeSql, or selectRows request. Most users will not instantiate these themselves. Instead they will interact with them during the success handler of the API they are using.
Defined in: Query.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
get(columnName)
Gets the requested column from the row.
 
getLink(linkType)
Gets a specific link type for a row (details, update, etc.
 
Gets all of the links for a row (details, update, etc.
 
getValue(columnName)
Gets the simple value for the requested column.
Class Detail
LABKEY.Query.Row(row)
Parameters:
row
The raw row from a GetData or executeSQL, selectRows (version 13.2 and above) request.
See:
LABKEY.Query.Response
Method Detail
{Object} get(columnName)
Gets the requested column from the row. Includes extended values such as display value, URL, etc. When requested version is >16.2, multi-value columns will return an array of objects containing "value" and other properties. In the "17.1" format, "formattedValue" may be included in the response as the column display value formatted with the display column's format or folder format settings.
Parameters:
{String} columnName
The column name requested. Used to do a case-insensitive match to find the column.
Returns:
{Object} For the given columnName, returns an object in the common case or an array of objects for multi-value columns. 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").

{Object} getLink(linkType)
Gets a specific link type for a row (details, update, etc.).
Parameters:
linkType
Required. The name of the link type to be returned.
Returns:
{Object} Returns an object with the display text and link value.

{Object} getLinks()
Gets all of the links for a row (details, update, etc.).
Returns:
{Object} Returns an object with all of the links types (details, update, etc.) for a row.

{*} getValue(columnName)
Gets the simple value for the requested column. Equivalent of doing Row.get(columnName).value. For multi-value columns, the result is an array of values.
Parameters:
{String} columnName
The column name requested. Used to do a case-insensitive match to find the column.
Returns:
{*} Returns the simple value for the given column.

Documentation generated by JsDoc Toolkit 2.3.2 on Thu Mar 14 2019 22:39:27 GMT-0000 (UTC)