API/libsapojs/SAPO/Component/Tooltip

[Elements] are optional

Class SAPO.Component.Tooltip

class SAPO.Component.Tooltip

requires SAPO.Utility.Dimensions

requires SAPO.Dom.Event

requires SAPO.Dom.Element

Defined in Component/Tooltip/1.1/lib.js

Inclusion link: http://js.sapo.pt/SAPO/Component/Tooltip/1.1/

Sample: http://js.sapo.pt/SAPO/Component/Tooltip/sample/

Constructor Summary
Tooltip (string|Array element, Object options)
Renders a tooltip over a given element

Function Summary
activate (string|Array element, Object options)
Activates a tooltip over a given set of elements. Remains public for compatibility purposes.

Constructor Details

constructor Tooltip

Tooltip(string|Array element, Object options)
Renders a tooltip over a given element
Parameters:
element - Element id or an array of id's
options - Options for the tooltip
  • DOMElement|string template - An element which will be used as a template for the tooltip
  • [ string where ] - where to show the tooltip: mousemove, left or right
  • [ Number zindex ] - the zindex of the tooltip
  • [ boolean hasText ] - if the tooltip has any text
  • [ string contentAttr ] - the attribute on the target element which holds the content for the tooltip
  • [ string contentText ] - the content for the tooltip
  • [ DOMElement|string contentElm ] - the element which holds the content
  • [ Number leftElm ] - left offset of the tooltip box from the mouse position
  • [ Number topElm ] - top offset of the tooltip box from the mouse position
  • [ Number delay ] - delay for the rendering of the tooltip
  • [ boolean hasIframe ] - defines if the iframe hack should be used

Function Details

function activate

activate(string|Array element, Object options)
Activates a tooltip over a given set of elements. Remains public for compatibility purposes.
Parameters:
element - Element id or an array of id's
options - Options for the tooltip (same as the constructor)