API Docs for: 1.0.0
Show:

eLabSDK.CustomSectionType Class

Extends eLabSDK.Experiment.Section
Module: eLabSDK

Class that allows the creation of a custom section type. The class registers the custom section type in the sdk

Constructor

eLabSDK.CustomSectionType

(
  • category
  • type
  • label
  • getContent
)
async

Parameters:

  • category String
    • category for the custom type [data / text / inventory / files / ... ]
  • type String

    custom type classifier

  • label String

    display name for the custom type

  • getContent Function
    • return html string to display in the section

Example:

Example usage in plugin: var my_root_var = {}; (function (context) { context = new eLabSDK.Experiment.CustomSectionType({ category: 'mycategory [data / text / inventory / files / ... ]', type: 'MyCustomSectionType', // the classifier of the custom type label: 'My label', // display name getContent: (data) => ('

return html to display
') }); })(my_root_var);

Methods

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'); 
                      });