Page tree

Have questions? Stuck? Please check our FAQ for some common questions and answers.

Skip to end of metadata
Go to start of metadata

UI Service - VeilService

VeilService is an Angular Factory in the Layer module with the name veil.js. It allows you to show and hide the "Veil" – a GUI overlay that lets the user know the websocket connection was dropped. To use these functions, see the documentation on injecting Angular services.

What is the Veil?

Below is a screenshot of the Veil when the websocket connection goes down on the Topology View.

NameSummary
initInitialize the VeilService.
showShow the Veil.
hideHide the Veil.

Function Descriptions

init

Initialize the VeilService. This is already called, so you probably won't have to initialize it yourself.

Example UsageArgumentsReturn Value
vs.init();nonenone

show

Show the Veil.

Example UsageArgumentsReturn Value
vs.show(msg);msg - an array of strings, each array member is a paragraphnone, but shows the Veil and disables key bindings

hide

Hide the Veil.

Example UsageArgumentsReturn Value
vs.hide();nonenone, but hides the Veil and enables key bindings
  • No labels