Skip to main content

GetOptions

Description

Gets the list of options to show in a specific section of the search UI.

Syntax

// searchPane points to instance of ISearchPane
const result = await searchPane.GetOptions(SectionID, useShortList);

Parameters

NameTypeDescription
SectionIDstringThe ID of the section the items of which should be returned.
useShortListbooleanSpecifies if the list items should be returned in "short list" mode,
including only about five items.

Return type

TypeDescription
Promise < any >Receives an object with the properties "options" (array) and "more" (Boolean).
Each option object in the array has properties such as "name" (string) and "selected" (Boolean).