Class Index | File Index

Classes


Class LABKEY.Query.FieldMetaData

Metadata about a single field.

Additional Documentation:


Defined in: Query.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
 
Whether this field's value is automatically assigned by the server, like a RowId whose value is determined by a database sequence
 
Whether this field is a calculated value such as something generated by a SQL expression, or a "real"/"physical" column in the database
 
The caption to be shown for this field, typically in a column header, which may differ from its name
 
description
The description for this field
 
The format string to be used for Excel exports
 
The format string that can be passed to Ext components.
 
A function that can be used to produce the formatted string for this field.
 
The format string to be used for generating HTML
 
A friendlier, more verbose description of the type, like "Text (String)" or "Date and Time"
 
Whether this value is intended to be hidden from the user, especially for grid views
 
Alternate names for this field that may appear in data when importing, whose values should be mapped to this field
 
The type of form input to be used when editing this field, such as select, text, textarea, checkbox, or file
 
The type of JSON object that will represent this field's value: string, boolean, date, int, or float
 
Whether this field is part of the row's primary key
 
Information about this field's lookup configuration
 
Whether this field supports missing value indicators instead of or addition to its standard value
 
name
The name of the field
 
Whether the field's value is allowed to be null
 
Whether the field's value can be modified
 
The caption for this field, without any prefix from potential parent lookups.
 
Whether this field is intended to be displayed in detail UIs
 
Whether this field is intended to be displayed in insert UIs
 
Whether this field is intended to be displayed in update UIs
 
The format string to be used for TSV exports
 
Whether this field is intended to be edited directly by the user, or managed by the system
 
Whether this field's value stores version information for the row
Class Detail
LABKEY.Query.FieldMetaData()
See:
LABKEY.Query.selectRows
LABKEY.Query.getQueryDetails
Field Detail
{boolean} autoIncrement
Whether this field's value is automatically assigned by the server, like a RowId whose value is determined by a database sequence

{boolean} calculated
Whether this field is a calculated value such as something generated by a SQL expression, or a "real"/"physical" column in the database

{String} caption
The caption to be shown for this field, typically in a column header, which may differ from its name

{String} description
The description for this field

{String} excelFormat
The format string to be used for Excel exports

{String} extFormat
The format string that can be passed to Ext components. This is currently only supported for dates.

{String} extFormatFn
A function that can be used to produce the formatted string for this field. This is currently supported for dates and numeric values. Note: this function is returned as a string, so you will need to evaluate it to convert it to a function. See example below.
var formatFn = eval(meta.extFormatFn);
var formattedValue = formatFn(data);

{String} format
The format string to be used for generating HTML

{String} friendlyType
A friendlier, more verbose description of the type, like "Text (String)" or "Date and Time"

{boolean} hidden
Whether this value is intended to be hidden from the user, especially for grid views

{String[]} importAliases
Alternate names for this field that may appear in data when importing, whose values should be mapped to this field

{boolean} inputType
The type of form input to be used when editing this field, such as select, text, textarea, checkbox, or file

{String} jsonType
The type of JSON object that will represent this field's value: string, boolean, date, int, or float

{boolean} keyField
Whether this field is part of the row's primary key

{LABKEY.Query.FieldMetaDataLookup} lookup
Information about this field's lookup configuration

{boolean} mvEnabled
Whether this field supports missing value indicators instead of or addition to its standard value

{String} name
The name of the field

{boolean} nullable
Whether the field's value is allowed to be null

{boolean} readOnly
Whether the field's value can be modified

{String} shortCaption
The caption for this field, without any prefix from potential parent lookups. In many cases this will be identical to the caption property.

{boolean} shownInDetailView
Whether this field is intended to be displayed in detail UIs

{boolean} shownInInsertView
Whether this field is intended to be displayed in insert UIs

{boolean} shownInUpdateView
Whether this field is intended to be displayed in update UIs

{String} tsvFormat
The format string to be used for TSV exports

{boolean} userEditable
Whether this field is intended to be edited directly by the user, or managed by the system

{boolean} versionField
Whether this field's value stores version information for the row

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