eLabSDK.Inventory.Sample
Functions
| Name | Description |
|---|---|
| initialize - innitialises the Sample class and loads a sample if during the init config data was passed through(sampleIDs, fnWhenReady) | |
initialize - innitialises the Sample class and loads a sample if during the init config data was passed through(sampleIDs, fnWhenReady)
Kind: global function
| Param | Type |
|---|---|
| sampleIDs | string |
| fnWhenReady | function |
getPropertyByName - returns the value of the passed in propertyname(propertyname)
Use eLabSDK2.Inventory.Sample. instead. SDK1 is in maintenance-only mode.*
Kind: global function
| Param | Type |
|---|---|
| propertyname | string |
getPropertyBySampleTypeMetaID - returns the property object[] (key/value) by sampleTypeMetaID(sampleTypeMetaID)
Use eLabSDK2.Inventory.Sample. instead. SDK1 is in maintenance-only mode.*
Kind: global function
| Param | Type |
|---|---|
| sampleTypeMetaID | int |
getPropertyBySampleMetaID - returns the property object[] (key/value) by sampleMetaID(sampleTypeMetaID)
Use eLabSDK2.Inventory.Sample. instead. SDK1 is in maintenance-only mode.*
Kind: global function
| Param | Type |
|---|---|
| sampleTypeMetaID | int |
getMeta - returns the meta value of the current sample()
Use eLabSDK2.Inventory.Sample. instead. SDK1 is in maintenance-only mode.*
Kind: global function
getName - returns the name value of the current sample()
Use eLabSDK2.Inventory.Sample. instead. SDK1 is in maintenance-only mode.*
Kind: global function
getDescription - returns the description value of the current sample()
Use eLabSDK2.Inventory.Sample. instead. SDK1 is in maintenance-only mode.*
Kind: global function
getNotes - returns the notes value of the current sample()
Use eLabSDK2.Inventory.Sample. instead. SDK1 is in maintenance-only mode.*
Kind: global function
getBarcode - returns the barcode value of the current sample()
Use eLabSDK2.Inventory.Sample. instead. SDK1 is in maintenance-only mode.*
Kind: global function
remove - removes the current sample(fnWhenReady)
Use eLabSDK2.Inventory.Sample. instead. SDK1 is in maintenance-only mode.*
Kind: global function
| Param | Type |
|---|---|
| fnWhenReady | function |
setMeta - sets the meta key/value for the current sample(sampleMetaData)
Use eLabSDK2.Inventory.Sample. instead. SDK1 is in maintenance-only mode.*
Kind: global function
| Param | Type |
|---|---|
| sampleMetaData | object |
setName - sets the name string for the current sample(name)
Use eLabSDK2.Inventory.Sample. instead. SDK1 is in maintenance-only mode.*
Kind: global function
| Param | Type |
|---|---|
| name | string |
setDescription - sets the description string for the current sample(description)
Use eLabSDK2.Inventory.Sample. instead. SDK1 is in maintenance-only mode.*
Kind: global function
| Param | Type |
|---|---|
| description | string |
setNotes - sets the note string for the current sample(note)
Use eLabSDK2.Inventory.Sample. instead. SDK1 is in maintenance-only mode.*
Kind: global function
| Param | Type |
|---|---|
| note | string |
save - saves the sample(fnWhenReady)
Use eLabSDK2.Inventory.Sample. instead. SDK1 is in maintenance-only mode.*
Kind: global function
| Param | Type |
|---|---|
| fnWhenReady | function |
[getPropertyBySampleMetaID - returns the property object[] (key/value) by sampleMetaID(sampleTypeMetaID)]:#getpropertybysamplemetaid---returns-the-property-object-keyvalue-by-samplemetaidsampletypemetaid
[getMeta - returns the meta value of the current sample()]:#getmeta---returns-the-meta-value-of-the-current-sample
[getName - returns the name value of the current sample()]:#getname---returns-the-name-value-of-the-current-sample
[getDescription - returns the description value of the current sample()]:#getdescription---returns-the-description-value-of-the-current-sample
[getNotes - returns the notes value of the current sample()]:#getnotes---returns-the-notes-value-of-the-current-sample
[getBarcode - returns the barcode value of the current sample()]:#getbarcode---returns-the-barcode-value-of-the-current-sample
[remove - removes the current sample(fnWhenReady)]:#remove---removes-the-current-samplefnwhenready
[setMeta - sets the meta key/value for the current sample(sampleMetaData)]:#setmeta---sets-the-meta-keyvalue-for-the-current-samplesamplemetadata
[setName - sets the name string for the current sample(name)]:#setname---sets-the-name-string-for-the-current-samplename
[setDescription - sets the description string for the current sample(description)]:#setdescription---sets-the-description-string-for-the-current-sampledescription
[setNotes - sets the note string for the current sample(note)]:#setnotes---sets-the-note-string-for-the-current-samplenote
[save - saves the sample(fnWhenReady)]:#save---saves-the-samplefnwhenready
© 2026 eLabNext
Updated 9 days ago