eLabSDK.Page.Experiment

Functions

Name	Description
registerEvent(eventType, function)	Listen to an Experiment based event, currently only the event 'finalSignature' is supported
registerEvent(eventType)	Listen to an Experiment based event, currently only the event 'finalSignature' is supported
addBulkSampleAction(actionTitle, callback)	Allows the creation of bulk sample actions in the sample list or experiment sample sections
getExperimentObject()	Should only be called after onReady of experiment. Otherwise use new eLabSDK.Experiment() directly
registerAction(menuConfig)	Registers a new menu item in a section

registerEvent(eventType, function)

Listen to an Experiment based event, currently only the event 'finalSignature' is supported

Kind: global function
Returns: object with details about the event, including the experimentID

Param	Type	Description
eventType	`string`
function	`function`	function to execute on this event

registerEvent(eventType)

Listen to an Experiment based event, currently only the event 'finalSignature' is supported

Kind: global function
Returns: object with details about the event, including the experimentID

Param	Type	Description
eventType	`string`
config.label	`string`	Displayed text about this meta field

addBulkSampleAction(actionTitle, callback)

Allows the creation of bulk sample actions in the sample list or experiment sample sections

Kind: global function
Response: in callback{json}
{
sampleIDs: [],
seriesIDs: [],
sampleIDsIncludingSeriesClicked: [],
sampleCount: 0,
archivedSamples: 0
}

Param	Type	Description
actionTitle	`string`	: name of the action displayed in the selector
callback	`function`	: function to execute when the action is selected. Provide information on the chosen samples.

getExperimentObject()

Should only be called after onReady of experiment. Otherwise use new eLabSDK.Experiment() directly

Kind: global function

registerAction(menuConfig)

Registers a new menu item in a section

Kind: global function

Param	Type	Description
menuConfig	`object`
menuConfig.showOnSigned	`bool`	Show this menu item when the experiment is signed (default = true)
menuConfig.showOnNotSigned	`bool`	Show this menu item when the experiment is not signed (default = true)
menuConfig.label	`string`	Label to be displayed next to the icon