xplain.ux.widget.selection.Panel
An
xselectionPanel
is a panel that depicts an selection. You may integrate this panel into your UI.
xselectionPanel
extends Ext.panel.Panel. Thus, anxselectionPanel
can be resized, has a height and width, etc.
Config Parameters
- selections = null
An instance of
Xplain.Db.Selections
orXplain.Db.Selection
or an array of instances ofXplain.Db.Selection
that this panel should depict. Alternatively you may also pass a JSON Array as returned by the backend. If you skip this parameter, the selections currently defined via the selectionSet parameter will be depicted by this panel. Defaults tonull
.
- selectionSet = undefined
The set of selections that will be shown in this panel. If not set, the
selections
parameter has to be used to pass the selections used.
- selectMode = select
Defines what should be done if the user adds a selection using this dialog. If this parameter is set to
select
, a regular selection will be sent to the backend. If this parameter is set tocausalDiscConfig
, asetCausalDiscoveryConfig
will be sent to the backend instead.
- selectionSetColors: {background: '#ffc65b', color: '#000000', inlineColor
An object that defines all colors used to depict this panel and its states.
- hasCloseButton = true
If set to
true
this panel will consist of a close button to close the panel. Defaults totrue
.
- hasPinButton = true
If set to
true
each object part has a pin button which fires anxplainUXUserPinsSelection
event when the user clicks it. Defaults totrue
.
- maxStateNameLength = 35
Maximum number of characters available for a state. When this number is reached, the state name is abbreviated.
- showHidden = false
If set to
false
selections which belong to hidden attributes, will NOT be shown. Otherwise, they will be depicted.
- autoCloseCombobox = true
If set to
true
the combobox used for selecting new states / attributes closes after each selection. Otherwise it will stay opened thus allowing the user to select multiple states / attributes.
- enableObjects = null
A set of Xplain.Db.Object instances. When editing a selection, the user may add attributes from these objects. If not set, all attributes from all objects are allowed.