Skip to main content

MultiSelectLookup

Multi-value lookup datatype.

NameDescriptionType
valuesItems.Lookup[]

Helper Methods and Properties

⚠️ Note

These helper methods and properties are available when using the npm package @m-filescorporation/uix-vault-messages. Install it in your project to use these helpers. For more information, see Overview/VaultMessages/.

Factory Methods

MethodDescriptionParametersReturns
CreateCreate a new MultiSelectLookup object from an array of Lookup objects or numeric item IDs. If a number is provided, it will be converted to a Lookup with that item ID.value: Array<Lookup | number>MultiSelectLookup

Instance Methods

MethodDescriptionParametersReturns
AddAdds a new value to the MultiSelectLookup.value: Lookup | numberMultiSelectLookup
ToStringReturns a string representation of the MultiSelectLookup.string | null

Creating Objects

// Create a new MultiSelectLookup object from an array of Lookup objects or numeric item IDs. If a number is provided, it will be converted to a Lookup with that item ID.
const result = MultiSelectLookup.Create([]);

Working with Objects

// Extension helpers for MultiSelectLookup instances
// Adds a new value to the MultiSelectLookup.
const result = multiselectlookupInstance.Add(new Lookup());

// Returns a string representation of the MultiSelectLookup.
const result = multiselectlookupInstance.ToString();

Example

{
"values": [] /* Array of Lookup */
}