eLabSDK2.Inventory

Hierarchy

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

NameType
TEvent

Parameters

NameType
eventNamestring
callback(e: T) => void
idstring

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

NameTypeDescription
storageLayerIDnumberstorageLayerID 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 the dom has been rendered

Parameters

NameTypeDescription
callbackFunction:Function
idstring-

Returns

void

Inherited from

eLabSDK2.onAfterPageLoad


onBeforePageExit

Static onBeforePageExit(callback, id): void

Triggers the callback prior to leaving the page. (soft or hard route)

Parameters

NameTypeDescription
callbackFunction:Function
idstring-

Returns

void

Inherited from

eLabSDK2.onBeforePageExit


onBeforePageLoad

Static onBeforePageLoad(callback, id): void

Triggers the callback prior to loading the data / DOM

Parameters

NameTypeDescription
callbackFunction:Function
idstring-

Returns

void

Inherited from

eLabSDK2.onBeforePageLoad


onTreeReady

Static onTreeReady(callback, id): void

Register a callback to be notified when the inventory tree is ready.

Parameters

NameTypeDescription
callbackanyThe function to be called when the tree is ready.
idany-

Returns

void

void


openHeatmap

Static openHeatmap(storageLayerID): void

Parameters

NameType
storageLayerIDnumber

Returns

void


pickLocation

Static pickLocation(options?): Promise<StorageLayer>

Select a storagelayer in the inventory browser.

Parameters

NameTypeDescription
optionsPickerModalOptionsSmalloptional, starting storageLayerID of location to start browsing

Returns

Promise<StorageLayer>


pickSamples

Static pickSamples(options?): Promise<number[]>

Select a storagelayer in the inventory browser.

Parameters

NameTypeDescription
optionsPickerModalOptionsSmalloptional - 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

NameTypeDefault valueDescription
startingStorageLayerIDnumber0optional, starting storageLayerID of location to start browsing

Returns

Promise<StorageLayer>


© 2023 eLabNext