Selection Box V2 Widget

Important

The Selection Box V2 widget is available in software versions from AIMMS 4.82 onwards. Selection Box V2 is available only for Grid Layout pages. When adding the widget it will appear as selectionbox in the list of widgets.

The Selection Box V2 widget allows the user to select an element in a set or a subset of elements in a set by using an element parameter or a 1-dimensional parameter.

Selection Box V2 is identical to the Selection Box widget in terms of functionality and result, but has a few enhancements, namely:

  1. It is built with new technology.

  2. Users can scroll the complete list of elements. The list of elements does not load at once and is loaded only when the user scrolls. This improves the performance of the widget.

  3. When searching for items from the list of elements by using the search box, the search process is executed on the server instead of in the browser. This brings performance benefits, regardless of the number of elements in the list. Please do note that this search is of type “text contains” a given sub-string. However, a search based on regular expressions (of type “regex”) is not (yet) supported.

Specifying an Element Parameter

It is possible to specify an element parameter as a data identifier in the Contents tab of the widget’s options editor by opening the Identifier Selector by clicking the icon next to the contents field.

_images/SelectionBoxV2_AddContent.png

In our example, we have selected the element parameter ep_Alllocations ranged over the set AllLocations.

_images/SelectionBoxV2_ElementParameter.png

_images/SelectionBoxV2_AddContent.png

_images/SelectionBoxV2_EP_Result.png

Specifying a 1-dimensional Parameter

It is also possible to specify a 1-dimensional parameter as a data identifier in the Contents tab of the widget’s options editor.

_images/SelectionBoxV2_OneDimParameter.png

In our example, the parameter DemandAllLocations(l) is declared with the index domain of the set AllLocations.

_images/SelectionBoxV2_Parameter_Result.png

Identifier Settings

In the Identifier Settings tab of the widget’s options editor, one can apply a Display Domain in the “Set display domain” section, which works in the same way as for other widgets.

In the case of a specifying a 1-dimensional binary parameter, in the “Set slicing per index” section it is possible to slice the underlying index to another index of a subset.

Miscellaneous options

In the Miscellaneous tab of the widget’s options editor you can set the Visibility option for the widget.