The Id of the message that should be hidden, which was returned by the associated showLoadMask call
Function for assigning a callback to checkbox value changes
true: only execute the callback if the checkbox gets selected
true: only execute the callback if the checkbox gets deselected
If onlyOnSelected
and onlyOnDeselected
are true or false simultaniously, the callback
will be executed for both states.
Function for assigning a callback to combobox value changes
Function for assigning a callback to dataview value changes
If not given, the callback is called for each interactive visual on the graphic view
Function for assigning a callback to radiobutton value changes
true: only execute the callback if the radiobutton gets selected
true: only execute the callback if the radiobutton gets deselected
If onlyOnSelected
and onlyOnDeselected
are true or false simultaniously, the callback
will be executed for both states.
Function for assigning a callback to slider value changes.
It can be configured whether the callback should be executed on each change or just when the final slider position is
reached.
Furthermore a throttling time can be configured, so that the amount of callback executions will be limited.
true: execute callback on each change, false: execute callback when slider movement is finished
Makes sure that the callback function is not executed multiple times within this time,
only takes effect if onSliding
is true.
- 0
: no throttling
- > 0
: throttling with the defined time in milliseconds
- undefined
: use default throttling time from slider control
Function for assigning a callback to textbox value changes.
The function can distinguish between different trigger modes, so that the user can decide if the callback should be
executed on each character input, when pressing enter, when leaving the textbox or on a combination of these trigger
events.
Furthermore the function can be debounced to minimize the amount of callback executions.
If neither the trigger
parameter, nor the debounceMS
parameter is set, the function behaves exactly as the
"Value Changed" signal of the textbox control.
Decide on which trigger the value change callback should be executed, see
Cbn.CJS.TextboxValueChangeTrigger for detailed information about the options.
If the trigger input is left undefined, on typing and enter submit triggers will be used.
Defers the call until the value changed event hasn't been triggered for this amount of time,
only takes effect for Cbn.CJS.TextboxValueChangeTrigger.OnTyping trigger.
- 0
: no debouncing
- > 0
: debouncing with the defined time in milliseconds
- undefined
: use default debouncing time from textbox control
Can be used to force hiding the load mask completly and clear the load mask queue for a specific control
Name of control for which the load mask queue should be cleared. Viewport is used if not given.
Defines if the load mask queue should priorize newer or older entries, see Cbn.CJS.LoadMaskQueueMode for further details.
Show load mask on the viewport or the given control.
Additionally the messages get queued within this function, so if a visible message gets hidden,
the next one in the queue gets shown automatically.
Queues exist for each individual control.
The behaviour of the queues (FIFO, FILO) can be defined globally by using the setLoadMaskQueueMode function.
If the load mask should be shown on the viewport and there is already an error dialog visible, the call to
showLoadMask
will be ignored.
Also active load masks on the viewport are automatically hidden, when an error dialog is shown.
Message to display on the loading mask. 'Loading...' is shown if not given.
Name of control on which the load mask should be shown. Viewport is used if not given.
Class(es) which should be set for the loadmask, multiple classes can be assigend by seperating them
with spaces (eg: class1 class2 class3
)
true: shows message immediatly, even if it would have lower priority according to the queue mode
Id of the message created by this function.
Can be used to hide this specific message again using hideLoadMask
Generated using TypeDoc
Removes the message from the load mask queue of the specific control and hides the message if it is currently visible.
Automatically shows load mask with the next message in the queue again if available.