service OverlayService view source

Service to display or hide an overlay which intercepts all mouse events. Overlay can be invisible or visible (grey)

members

disable(name : string)

Disable global overlay

Parameters

name string overlay identifier

enable(name : string, parentContainer : HTMLElement)

Enable global overlay

Parameters

name string overlay identifier used to create and manage an associated overlay element
parentContainer HTMLElement DOM element which contains overlay div. If none we add overlay directly under body

get(name : string) : (Object)

Get the overlay associated with provided name

Parameters

name string overlay identifier

Returns

(Object) return overlay object

setOpacity(name : string, visible : boolean)

Makes overlay non transparent by setting its opacity

Parameters

name string overlay identifier
visible boolean show/hide overlay by updating its transparency