eLabSDK2.Inventory.StorageUnit.StorageUnitDetail

Hierarchy

StorageUnit

↳ StorageUnitDetail

Methods

addSection

Static addSection(section): void

Add a custom section to a storage unit detail page. This is rendered in the 'overview'
tab of a storage unit.

Parameters

Name	Type	Description
`section`	`CustomSection`	: { id: string, isVisible: (id :number) => boolean onRendered: Function, position: CustomSectionPosition, contents: string, header: CustomSectionHeader }

Returns

void

addTab

Static addTab(tab): void

Add a custom tab to a storage unit detail page.
If type is set to 'table', pass a SDKTableConfig object as contents
to render contents in predefined table layout.

Parameters

Name	Type	Description
`tab`	`CustomSection`	: { id: string, title: string, type: 'table'\|'custom', content: string\|Function\|SDKTableConfig, isVisible: (id :number) => boolean isLoading: (id :number) => boolean onRendered: Function, }

Returns

void

getStorageUnitDetail

Static getStorageUnitDetail(): StorageDetailStoreInterface

Get storage unit detail.

Returns

StorageDetailStoreInterface

An object containing the details of the active storage unit.

getStorageUnitID

Static getStorageUnitID(): number

Retrieve the sampleID of the sample currently loaded in the
detail view of the inventory browser (if any).

Returns

number

sampleID :Number or null if not present

onReady

Static onReady(callback, id): void

Register a callback function to be executed when a Storage Unit detail page is 'ready'.
The callback is called passing in the storageUnitID as detail in the event parameter.

Parameters

Name	Type
`callback`	(`event`: `CustomEvent`<`number`>) => `void`
`id`	`string`

Returns

void

onSectionReady

Static onSectionReady(callback, id): void

Parameters

Name	Type
`callback`	(`event`: `Event`) => `void`
`id`	`string`

Returns

void

registerAction

Static registerAction(action): void

Parameters

Name	Type	Description
`action`	`Action`	the action to register

Returns

void

void