API Docs for: 1.0.0
Show:

eLabSDK.Experiment.Section.Sample Class

Extends eLabSDK.Experiment.Section
Module: eLabSDK

Class that extends the Experiment.Section class for adding sample sections

Constructor

eLabSDK.Experiment.Section.Sample

(
  • object
)

Parameters:

  • object Object
    • sectionID Int
    • type eLabSDK.Experiment.Section.SECTIONTYPE

      (SAMPLESIN or SAMPLESOUT)

Methods

addSamples

(
  • sampleIDs
)

Add Samples to the section

Parameters:

  • sampleIDs Array

addSection

(
  • configObject
  • onCreated
)

Inherited from eLabSDK.Experiment:

Adds a section to this experiment

Parameters:

  • configObject Obj
    • header String
      • Section Header Text
    • type eLabSDK.Experiment.Section.SECTIONTYPE
      • Section Type
  • onCreated Function

getExperimentID

() Int

Inherited from eLabSDK.Experiment:

Returns:

Int: experimentID

getMeta

()

Inherited from eLabSDK.Experiment.Section:

Returns:

metadata of section

getSection

(
  • sectionID
)
eLabSDK.Experiment.Section

Inherited from eLabSDK.Experiment:

Gets the section object by ID

Parameters:

  • sectionID Type

Returns:

eLabSDK.Experiment.Section: section or null of it doest not exist

getStudyID

() Int

Inherited from eLabSDK.Experiment:

Returns:

Int: studyID

Properties

object.type

eLabSDK.Experiment.Section.SECTIONTYPE

Inherited from eLabSDK.Experiment.Section:

sections

Array

Inherited from eLabSDK.Experiment:

Array of eLabSDK.Experiment.Section Sections of experiment

Events

onCreated

Inherited from eLabSDK.Experiment:

Use this to access class

Example:

  var ev = experimentObject.onCreated(function () { 
                          alert('Experiment created'); 
                      });

onLoaded

Inherited from eLabSDK.Experiment:

Use this to access class

Example:

  var ev = experimentObject.onLoaded(function () { 
                          alert('Experiment onLoaded'); 
                      });

onSampleAdded

Event Payload:

  • object eLabSDK.Experiment.ContentUpdater.Sample

Example:

 var sampleSection = experiment.sections[0];
                     sampleSection.onSampleAdded(function(){
                         alert('samples are added!');
                     });
                     sampleSection.addSamples([1234]);