eLabSDK2.Inventory
Hierarchy
-
default
↳
Inventory
↳↳
Equipment
↳↳
Quantity
↳↳
Sample
↳↳
SampleType
↳↳
StorageLayer
↳↳
StorageUnit
Methods
addEventListener
Static
addEventListener<T
>(eventName
, callback
, id
): void
Register event listener, eventName should be one of the available SDK events
Will not re-register when function is already linked to specified event.
Type parameters
Name | Type |
---|---|
T | Event |
Parameters
Name | Type |
---|---|
eventName | string |
callback | (e : T ) => void |
id | string |
Returns
void
Inherited from
eLabSDK2.addEventListener
goToAllSamplesPage
Static
goToAllSamplesPage(): void
Navigates to the all samples page.
Returns
void
goToCompartment
Static
goToCompartment(storageLayerID
): void
go to a compartment in the inventory browser.
Parameters
Name | Type | Description |
---|---|---|
storageLayerID | number | storageLayerID of compartment to go to |
Returns
void
inventoryBrowserActive
Static
inventoryBrowserActive(): boolean
Returns true if inventory rebuild is currently displayed.
Returns
boolean
onAfterPageLoad
Static
onAfterPageLoad(callback
, id
): void
Triggers the callback after loading the Inventory application
Example:
eLabSDK2.Inventory.onAfterPageLoad(() => {console.log('Inventory loaded');}, id: 'my-unique-id'})
Parameters
Name | Type | Description |
---|---|---|
callback | Function | :Function callback function to trigger |
id | string | :string unique id for this callback |
Returns
void
Overrides
eLabSDK2.onAfterPageLoad
onBeforePageExit
Static
onBeforePageExit(callback
, id
): void
Triggers the callback prior to leaving the page. (soft or hard route)
Parameters
Name | Type | Description |
---|---|---|
callback | Function | :Function |
id | string | - |
Returns
void
Inherited from
eLabSDK2.onBeforePageExit
onBeforePageLoad
Static
onBeforePageLoad(callback
, id
): void
Triggers the callback prior to loading the Inventory application
Parameters
Name | Type | Description |
---|---|---|
callback | Function | :Function callback function to trigger |
id | string | :string unique id for this callback @example: eLabSDK2.Inventory.onBeforePageLoad(() => {console.log('Prior to Inventory loading');}, id: 'my-unique-id'}) |
Returns
void
Overrides
eLabSDK2.onBeforePageLoad
onTreeReady
Static
onTreeReady(callback
, id
): void
Register a callback to be notified when the inventory tree is ready.
Parameters
Name | Type | Description |
---|---|---|
callback | any | The function to be called when the tree is ready. |
id | any | - |
Returns
void
void
openExportSettingsModal
Static
openExportSettingsModal(config
): void
Display the export settings modal.
Parameters
Name | Type | Description |
---|---|---|
config | ExportSettingsDialogConfig | a ExportSettingsDialogConfig object in which you can specify fileType with the default export fileType ('CSV', 'XLSX', 'PDF'). |
Returns
void
a promise with exportsettings
openHeatmap
Static
openHeatmap(storageLayerID
): void
Parameters
Name | Type |
---|---|
storageLayerID | number |
Returns
void
pickEquipment
Static
pickEquipment(config
): Promise
<StorageUnit
[]>
Select equipment in the inventory browser.
Parameters
Name | Type |
---|---|
config | PickEquipmentConfig |
Returns
Promise
<StorageUnit
[]>
- list of equipment
pickLocation
Static
pickLocation(options?
): Promise
<StorageLayer
>
Select a storagelayer in the inventory browser.
Parameters
Name | Type | Description |
---|---|---|
options | PickerModalOptionsSmall | optional, starting storageLayerID of location to start browsing |
Returns
Promise
<StorageLayer
>
pickSamples
Static
pickSamples(options?
): Promise
<number
[]>
Select a storagelayer in the inventory browser.
Parameters
Name | Type | Description |
---|---|---|
options | PickerModalOptionsSmall | optional - this is where the settings of the modal can be set |
Returns
Promise
<number
[]>
- list of sampleIds
selectStorageLayer
Static
selectStorageLayer(startingStorageLayerID?
): Promise
<StorageLayer
>
DEPRECATED: Select a storagelayer in the inventory browser.
USE: pickLocation()
Parameters
Name | Type | Default value | Description |
---|---|---|---|
startingStorageLayerID | number | 0 | optional, starting storageLayerID of location to start browsing |
Returns
Promise
<StorageLayer
>
© 2023 eLabNext
Updated about 1 month ago