Share via

Shell.UI.Balloon.js

  • Article

 

Applies To: Windows Azure Pack

Creates a popup balloon at a specific location on the page.

Widgets

None.

Enums

None.

Properties

None.

Methods

Name

Description

Returns

Parameters

Shell.UI.Balloon.create

Creates a balloon with a template and options.

Object

templateKey (String): Template key to use; you can use: validation, help, business.

options (Object): Options to pass to the balloon. Options are:

  • position - "top", "left", "right" or "bottom"

  • content - The content of the balloon

  • title - Title for help balloons

  • targetFocusElement - Business balloon only. DOM element, or valid jQuery selector. When element gets focus business balloon will expand from just icon to show icon and text.

noBalloonTrack (Boolean): Don't track the balloon in currentBalloons.

Shell.UI.Balloon.destroy

Destroys the balloon.

Nothing

handle (Object): Balloon handle.

Shell.UI.Balloon.getBoundaries

Gets the boundaries of a specific object.

Object

selector (String): DOM element, or valid jQuery selector.

Shell.UI.Balloon.hide

Hides the balloon.

Nothing

handle (Object): Balloon handle.

Shell.UI.Balloon.hideBalloons

Hides all balloons.

Nothing

None

Shell.UI.Balloon.show

Shows the balloon.

Nothing

handle (Object): Balloon handle.

box (Object): Box where the balloon should show. Must include the keys: left, top, width, height

See Also

Windows Azure Pack Extension Shell Library Reference