Example Assay JavaScript Objects: /Documentation

Example Assay JavaScript Objects

The JavaScript objects for assays described in this topic are automatically injected into the rendered page (example page: result.html), to save developers from needing to make a separate JavaScript client API request via AJAX to separately fetch them from the server.

LABKEY.page.assay
LABKEY.page.batch
LABKEY.page.run
LABKEY.page.result

LABKEY.page.assay:

The assay definition is available as LABKEY.page.assay for all of the html views. It is a JavaScript object, which is of type Assay Design:

LABKEY.page.assay = {
  "id": 4,
  "projectLevel": true,
  "description": null,
  "name": <assay name>,
  // domains objects: one for batch, run, and result.
  "domains": {
    // array of domain property objects for the batch domain
    "<assay name> Batch Fields": [
      {
        "typeName": "String",
        "formatString": null,
        "description": null,
        "name": "ParticipantVisitResolver",
        "label": "Participant Visit Resolver",
        "required": true,
        "typeURI": "http://www.w3.org/2001/XMLSchema#string"
      },
      {
        "typeName": "String",
        "formatString": null,
        "lookupQuery": "Study",
        "lookupContainer": null,
        "description": null,
        "name": "TargetStudy",
        "label": "Target Study",
        "required": false,
        "lookupSchema": "study",
        "typeURI": "http://www.w3.org/2001/XMLSchema#string"
      }
    ],
    // array of domain property objects for the run domain
    "<assay name> Run Fields": [{
      "typeName": "Double",
      "formatString": null,
      "description": null,
      "name": "DoubleRun",
      "label": null,
      "required": false,
      "typeURI": "http://www.w3.org/2001/XMLSchema#double"
    }],
    // array of domain property objects for the result domain
    "<assay name> Result Fields": [
      {
        "typeName": "String",
        "formatString": null,
        "description": "The Sample Id",
        "name": "SampleId",
        "label": "Sample Id",
        "required": true,
        "typeURI": "http://www.w3.org/2001/XMLSchema#string"
      },
      {
        "typeName": "DateTime",
        "formatString": null,
        "description": null,
        "name": "TimePoint",
        "label": null,
        "required": true,
        "typeURI": "http://www.w3.org/2001/XMLSchema#dateTime"
      },
      {
        "typeName": "Double",
        "formatString": null,
        "description": null,
        "name": "DoubleData",
        "label": null,
        "required": false,
        "typeURI": "http://www.w3.org/2001/XMLSchema#double"
      }
    ]
  },
  "type": "Simple"
};

LABKEY.page.batch:

The batch object is available as LABKEY.page.batch on the upload.html and batch.html pages. The JavaScript object is an instance of Run Group and is shaped like:

LABKEY.page.batch = new LABKEY.Exp.RunGroup({
  "id": 8,
  "createdBy": <user name>,
  "created": "8 Apr 2009 12:53:46 -0700",
  "modifiedBy": <user name>,
  "name": <name of the batch object>,
  "runs": [
    // array of LABKEY.Exp.Run objects in the batch. See next section.
  ],
  // map of batch properties
  "properties": {
    "ParticipantVisitResolver": null,
    "TargetStudy": null
  },
  "comment": null,
  "modified": "8 Apr 2009 12:53:46 -0700",
  "lsid": "urn:lsid:labkey.com:Experiment.Folder-5:2009-04-08+batch+2"
});

LABKEY.page.run:

The run detail object is available as LABKEY.page.run on the run.html pages. The JavaScript object is an instance of LABKEY.Exp.Run and is shaped like:

LABKEY.page.run = new LABKEY.Exp.Run({
    "id": 4,
    // array of LABKEY.Exp.Data objects added to the run
    "dataInputs": [{
        "id": 4,
        "created": "8 Apr 2009 12:53:46 -0700",
        "name": "run01.tsv",
        "dataFileURL": "file:/C:/Temp/assaydata/run01.tsv",
        "modified": null,
        "lsid": <filled in by the server>
    }],
    // array of objects, one for each row in the result domain
    "dataRows": [
      {
        "DoubleData": 3.2,
        "SampleId": "Monkey 1",
        "TimePoint": "1 Nov 2008 11:22:33 -0700"
      },
      {
        "DoubleData": 2.2,
        "SampleId": "Monkey 2",
        "TimePoint": "1 Nov 2008 14:00:01 -0700"
      },
      {
        "DoubleData": 1.2,
        "SampleId": "Monkey 3",
        "TimePoint": "1 Nov 2008 14:00:01 -0700"
      },
      {
        "DoubleData": 1.2,
        "SampleId": "Monkey 4",
        "TimePoint": "1 Nov 2008 00:00:00 -0700"
      }
    ],
    "createdBy": <user name>,
    "created": "8 Apr 2009 12:53:47 -0700",
    "modifiedBy": <user name>,
    "name": <name of the run>,
    // map of run properties
    "properties": {"DoubleRun": null},
    "comment": null,
    "modified": "8 Apr 2009 12:53:47 -0700",
    "lsid": "urn:lsid:labkey.com:SimpleRun.Folder-5:cf1fea1d-06a3-102c-8680-2dc22b3b435f"
  });

LABKEY.page.result:

The result detail object is available as LABKEY.page.result on the result.html page. The JavaScript object is a map for a single row and is shaped like:

LABKEY.page.result = {
  "DoubleData": 3.2,
  "SampleId": "Monkey 1",
  "TimePoint": "1 Nov 2008 11:22:33 -0700"
};

LabKey Support

LabKey Support