Class LABKEY.Assay.AssayDesign
Static class to describe the shape and fields of an assay. Each of the LABKEY.Assay 'get' methods passes its success callback function an array of AssayDesigns.
Additional Documentation:
Defined in: Assay.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Field Attributes | Field Name and Description |
---|---|
The path to the container in which this assay design is saved
|
|
Contains the assay description.
|
|
Map containing name/value pairs.
|
|
An mapped enumeration of domain types to domain names.
|
|
The unique ID of the assay.
|
|
The name of the action used for data import
|
|
The name of the controller used for data import
|
|
The name of the assay.
|
|
Contains the plate template name if the assay is plate-based.
|
|
Indicates whether this is a project-level assay.
|
|
The name of the assay type.
|
Field Detail
{String}
containerPath
The path to the container in which this assay design is saved
{String}
description
Contains the assay description.
{Object}
domains
Map containing name/value pairs. Typically contains three entries for three domains (batch, run and results).
Each domain is associated with an array of objects that each describe a domain field.
Each field object has the following properties:
- name: The name of the domain field. (string)
- typeName: The name of the type of the domain field. (Human readable.) (string)
- typeURI: The URI that uniquely identifies the domain field type. (Not human readable.) (string)
- label: The domain field label. (string)
- description: The domain field description. (string)
- formatString: The format string applied to the domain field. (string)
- required: Indicates whether a value is required for this domain field. (boolean)
- lookup.container: If this domain field is a lookup, lookup.container holds the String path to the lookup container or null if the lookup in the same container. Undefined otherwise.(string)
- lookup.schema: If this domain field object is a lookup, lookup.schema holds the String name of the lookup schema. Undefined otherwise.(string)
- lookup.table: If this domain field object is a lookup, lookup.table holds the String name of the lookup query. Undefined otherwise. (string)
- lookup.keyColumn: The primary key field in target table (string)
- lookup.displayColumn: The display column in target table (string)
{Object}
domainTypes
An mapped enumeration of domain types to domain names. Useful when attempting to find a domain by type.
The value is a domain name which can be used as a key lookup into the "domain" object.
{Integer}
id
The unique ID of the assay.
{String}
importAction
The name of the action used for data import
{String}
importController
The name of the controller used for data import
{String}
name
The name of the assay.
{String}
plateTemplate
Contains the plate template name if the assay is plate-based. Undefined otherwise.
{Boolean}
projectLevel
Indicates whether this is a project-level assay.
{String}
type
The name of the assay type. Example: "ELISpot"