DiviArea.showOverlay()
Darkens the background and prevents the user from scrolling the document.
Use DiviArea.hideOverlay()
to undo all the effects of this function.
Params
- no Params
Returns
The function does not return anything.
Examples
// Hide the overlay.
DiviArea.showOverlay();
Notes
When the user clicks on the overlay, and a Popup-Area is visible, the top-most Popup will be hidden. In this case, the overlay will be also hidden, unless there is another visible Popup.
However, when no Popup is visible, clicking the overlay will have no effect.
The overlay is positioned behind all Popup Areas and in front of any other Area type.