Options
Menu

Namespace IxTooltips

Index

Interfaces

Functions

Functions

close

  • close(key: string): Promise<{}> | boolean

  • Closes a tooltip by key.

    example
    ix.tooltip.close("tt-key01");

    Parameters

    • key: string

      Tooltip key/id

    Returns Promise<{}> | boolean

closeTooltipByHtml

  • closeTooltipByHtml(tooltip: HTMLElement): boolean

  • Closes a tooltip by HTML.

    example
    ix.tooltip.closeTooltipByHtml(ix.util.getHtml("<ELEMENT-GUID>"));

    Parameters

    • tooltip: HTMLElement

      Element to close

    Returns boolean

closest

  • closest(element: HTMLElement | JQuery): undefined | UpTip | UpTipWin | ContainerTooltipLike

  • Searchs and gives the nearbiest tooltip in the container.

    example
    ix.tooltip.closest(ix.util.getHtml(ix.util.getHtml("<GUID>"));

    Parameters

    • element: HTMLElement | JQuery

      Search near element

    Returns undefined | UpTip | UpTipWin | ContainerTooltipLike

getByKey

  • getByKey(key: string): undefined | UpTip | UpTipWin | ContainerTooltipLike

  • Get tooltip as HTML element.

    example
    ix.tooltip.getByKey("tt-key01");

    Parameters

    • key: string

      Tooltip key/id

    Returns undefined | UpTip | UpTipWin | ContainerTooltipLike

refresh

  • refresh(key: string): boolean

  • Re-positions a tooltip.

    example
    ix.tooltip.refresh("tt-key01");

    Parameters

    • key: string

      Tooltip key/id

    Returns boolean

show

  • Opens a tooltip which is positioned at element, mouse or window.

    example
    ix.tooltip.show({
    position: "modal",
    height: 200,
    width: 200,
    modal: true,
    title: "Lorem ipsum",
    key: "tt-key01"
});

    Parameters

    Returns Promise<UpTip | UpTipWin>