The `goog.ui.HoverCard` Class

goog.ui.HoverCard
> goog.ui.AdvancedTooltip
> goog.ui.Tooltip
> goog.ui.Popup
> goog.ui.PopupBase
> goog.events.EventTarget
> goog.Disposable

`goog.ui.HoverCard(isAnchor, opt_checkDescendants, opt_domHelper, opt_triggeringDocument)`

Create a hover card object. Hover cards extend tooltips in that they don't have to be manually attached to each element that can cause them to display. Instead, you can create a function that gets called when the mouse goes over any element on your page, and returns whether or not the hovercard should be shown for that element. Alternatively, you can define a map of tag names to the attribute name each tag should have for that tag to trigger the hover card. See example below. Hovercards can also be triggered manually by calling {@code triggerForElement}, shown without a delay by calling {@code showForElement}, or triggered over other elements by calling {@code attach}. For the latter two cases, the application is responsible for calling {@code detach} when finished. HoverCard objects fire a TRIGGER event when the mouse moves over an element that can trigger a hovercard, and BEFORE_SHOW when the hovercard is about to be shown. Clients can respond to these events and can prevent the hovercard from being triggered or shown.

isAnchor {Function|Object}: Function that returns true if a given element should trigger the hovercard. Alternatively, it can be a map of tag names to the attribute that the tag should have in order to trigger the hovercard, e.g., {A: 'href'} for all links. Tag names must be all upper case; attribute names are case insensitive.
opt_checkDescendants {boolean=}: Use false for a performance gain if you are sure that none of your triggering elements have child elements. Default is true.
opt_domHelper {goog.dom.DomHelper=}: Optional DOM helper to use for creating and rendering the hovercard element.
opt_triggeringDocument {Document=}: Optional document to use in place of the one included in the DomHelper for finding triggering elements. Defaults to the document included in the DomHelper.

The `goog.ui.HoverCard.EventType` Enum

Enum for event type fired by HoverCard. … more

The `goog.ui.HoverCard.TriggerEvent` Class

Create a trigger event for specified anchor and optional data. … more

`.addEventListener(type, handler, opt_capture, opt_handlerScope)`

Inherited from goog.events.EventTarget .

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched. Supported for legacy but use goog.events.listen(src, type, handler) instead.

type {string}: The type of the event to listen for.
handler {Function|Object}: The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.
opt_capture {boolean=}: In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope {Object=}: Object in whose scope to call the listener.

`.addOnDisposeCallback(callback, opt_scope)`

Inherited from goog.Disposable .

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.

callback {!Function}: The callback function.
opt_scope {Object=}: An optional scope to call the callback in.

`.attach(el)`

Inherited from goog.ui.Tooltip .

Attach to element. Tooltip will be displayed when the cursor is over the element or when the element has been active for a few milliseconds.

el {Element|string}: Element to display tooltip for, either element reference or string id.

`.cancelTrigger()`

Abort pending hovercard showing, if any.

`.className` {`string`}

Inherited from goog.ui.Tooltip .

CSS class name for tooltip.

`.creationStack` {`string`}

Inherited from goog.Disposable .

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

`.detach(opt_el)`

Inherited from goog.ui.Tooltip .

Detach from element(s).

opt_el {Element|string=}: Element to detach from, either element reference or string id. If no element is specified all are detached.

`.dispatchEvent(e)`

Inherited from goog.events.EventTarget .

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object. If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

e {string|Object|goog.events.Event}: Event object.
returns {boolean}: If anyone called preventDefault on the event object (or if any of the handlers returns false this will also return false.

`.dispose()`

Inherited from goog.Disposable .

Disposes of the object. If the object hasn't already been disposed of, calls {@link #disposeInternal}. Classes that extend {@code goog.Disposable} should override {@link #disposeInternal} in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.

returns {void}: Nothing.

`.disposeInternal()`

`.getActiveElement()`

Inherited from goog.ui.Tooltip .

returns {Element}: Active element reference.

`.getAnchorElement()`

Gets the DOM element that triggered the current hovercard. Note that in the TRIGGER or CANCEL_TRIGGER events, the current hovercard's anchor may not be the one that caused the event, so use the event's anchor property instead.

returns {Element}: Object that caused the currently displayed hovercard (or pending hovercard if none is displayed) to be triggered.

The goog.ui.HoverCard Class

goog.ui.HoverCard(isAnchor, opt_checkDescendants, opt_domHelper, opt_triggeringDocument)

The goog.ui.HoverCard.EventType Enum

The goog.ui.HoverCard.TriggerEvent Class

.addEventListener(type, handler, opt_capture, opt_handlerScope)

.addOnDisposeCallback(callback, opt_scope)

.anchor [protected] {Element|undefined}

.attach(el)

.cancelTrigger()

.className {string}

.clearHideTimer() [protected]

.clearShowTimer() [protected]

.creationStack {string}

.detach(opt_el)

.dispatchEvent(e)

.dispose()

.disposeInternal()

.getActiveElement()

.getAnchorElement()

.getAnchorFromElement(el) [protected]

.getAutoHide()

.getAutoHideRegion()

.getChildTooltip() [protected]

.getCursorTracking()

.getCursorTrackingHideDelayMs()

.getDisposed [deprecated]

.getDomHelper()

.getElement()

.getElements() [protected]

.getEnableCrossIframeDismissal()

.getHideDelayMs()

.getHideOnEscape()

.getHotSpotPadding()

.getHtml()

.getLastHideTime()

.getLastShowTime()

.getMargin()

.getParentEventTarget()

.getPinnedCorner()

.getPosition()

.getPositioningStrategy(activationType) [protected]

.getShowDelayMs()

.getState()

.getText()

.getType()

.handleFocus(event) [protected]

.handleMouseMove(event) [protected]

.handleMouseOutAndBlur(event)

.handleMouseOver(event)

.handleTooltipMouseOut(event) [protected]

.handleTooltipMouseOver(event) [protected]

.hasActiveChild() [protected]

.hideTimer [protected] {number|undefined}

.isCoordinateInTooltip(coord)

.isDisposed()

.isMouseInTooltip()

.isOrWasRecentlyVisible()

.isVisible()

.maybeHide(el)

.maybeShow(el, opt_pos)

.onBeforeHide_(opt_target) [protected]

.onBeforeShow() [protected]

.onCancelTrigger() [protected]

.onHide_() [protected]

.onShow_() [protected]

.onTrigger(triggerEvent) [protected]

.registerDisposable(disposable)

.removeEventListener(type, handler, opt_capture, opt_handlerScope)

.reposition()

.resetHotSpot [deprecated]

.setActiveElement(activeEl) [protected]

.setAutoHide(autoHide)

.setAutoHideRegion(element)

.setCursorTracking(b)

.setCursorTrackingHideDelayMs(delay)

.setElement(el)

.setEnableCrossIframeDismissal(enable)

.setHideDelayMs(delay)

.setHideOnEscape(hideOnEscape)

.setHotSpotPadding(opt_box)

The `goog.ui.HoverCard` Class

`goog.ui.HoverCard(isAnchor, opt_checkDescendants, opt_domHelper, opt_triggeringDocument)`

The `goog.ui.HoverCard.EventType` Enum

The `goog.ui.HoverCard.TriggerEvent` Class

`.addEventListener(type, handler, opt_capture, opt_handlerScope)`

`.addOnDisposeCallback(callback, opt_scope)`

`.anchor` [protected] {`Element`|`undefined`}

`.attach(el)`

`.cancelTrigger()`

`.className` {`string`}

`.clearHideTimer()` [protected]

`.clearShowTimer()` [protected]

`.creationStack` {`string`}

`.detach(opt_el)`

`.dispatchEvent(e)`

`.dispose()`

`.disposeInternal()`

`.getActiveElement()`

`.getAnchorElement()`

`.getAnchorFromElement(el)` [protected]

`.getAutoHide()`

`.getAutoHideRegion()`

`.getChildTooltip()` [protected]

`.getCursorTracking()`

`.getCursorTrackingHideDelayMs()`

`.getDisposed` [deprecated]

`.getDomHelper()`

`.getElement()`

`.getElements()` [protected]

`.getEnableCrossIframeDismissal()`

`.getHideDelayMs()`

`.getHideOnEscape()`

`.getHotSpotPadding()`

`.getHtml()`

`.getLastHideTime()`

`.getLastShowTime()`

`.getMargin()`

`.getParentEventTarget()`

`.getPinnedCorner()`

`.getPosition()`

`.getPositioningStrategy(activationType)` [protected]

`.getShowDelayMs()`

`.getState()`

`.getText()`

`.getType()`

`.handleFocus(event)` [protected]

`.handleMouseMove(event)` [protected]

`.handleMouseOutAndBlur(event)`

`.handleMouseOver(event)`

`.handleTooltipMouseOut(event)` [protected]

`.handleTooltipMouseOver(event)` [protected]

`.hasActiveChild()` [protected]

`.hideTimer` [protected] {`number`|`undefined`}

`.isCoordinateInTooltip(coord)`

`.isDisposed()`

`.isMouseInTooltip()`

`.isOrWasRecentlyVisible()`

`.isVisible()`

`.maybeHide(el)`

`.maybeShow(el, opt_pos)`

`.onBeforeHide_(opt_target)` [protected]

`.onBeforeShow()` [protected]

`.onCancelTrigger()` [protected]

`.onHide_()` [protected]

`.onShow_()` [protected]

`.onTrigger(triggerEvent)` [protected]

`.registerDisposable(disposable)`

`.removeEventListener(type, handler, opt_capture, opt_handlerScope)`

`.reposition()`

`.resetHotSpot` [deprecated]

`.setActiveElement(activeEl)` [protected]

`.setAutoHide(autoHide)`

`.setAutoHideRegion(element)`

`.setCursorTracking(b)`

`.setCursorTrackingHideDelayMs(delay)`

`.setElement(el)`

`.setEnableCrossIframeDismissal(enable)`

`.setHideDelayMs(delay)`

`.setHideOnEscape(hideOnEscape)`

`.setHotSpotPadding(opt_box)`