eLabSDK2.Inventory.Quantity

Hierarchy

Inventory

↳ Quantity

Methods

getSampleQuantityUnits

Static getSampleQuantityUnits(): QuantityTypeInterface[]

Get all available quantity units for samples.

This retrieves a list of all configured quantity unit types that can be used for samples in the system (e.g., liters, milliliters, grams, milligrams, pieces, etc.). Each quantity type includes the unit name, abbreviation, and other metadata. Use this to populate quantity unit dropdowns, validate quantity inputs, or display quantity options when creating or editing samples.

Returns

QuantityTypeInterface[]

An array of QuantityTypeInterface objects, each containing unit information like name, abbreviation, and type.

Example

// Get all quantity units
const units = eLabSDK2.Inventory.Quantity.getSampleQuantityUnits();
units.forEach(unit => {
  console.log(`${unit.name} (${unit.abbreviation})`);
});
// Output: "Liters (L)", "Milliliters (mL)", "Grams (g)", etc.

Example

// Populate a quantity unit selector
const units = eLabSDK2.Inventory.Quantity.getSampleQuantityUnits();
const unitOptions = units.map(unit => ({
  value: unit.quantityTypeID,
  label: `${unit.name} (${unit.abbreviation})`
}));
populateDropdown(quantitySelector, unitOptions);

Example

// Find a specific unit by abbreviation
const units = eLabSDK2.Inventory.Quantity.getSampleQuantityUnits();
const milliliters = units.find(unit => unit.abbreviation === 'mL');
if (milliliters) {
  console.log(`Found unit: ${milliliters.name}`);
}

Example

// Filter units by type (volume, mass, etc.)
const units = eLabSDK2.Inventory.Quantity.getSampleQuantityUnits();
const volumeUnits = units.filter(unit => unit.type === 'volume');
const massUnits = units.filter(unit => unit.type === 'mass');