Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICallout

Callout

Hierarchy

  • ICallout

Index

Methods

Methods

addAction

  • Adds a link to the actions panel of the callout window.

    Parameters

    Returns any

addEventCallback

  • addEventCallback(eventName: string, callback: (callout: ICallout) => void): any

  • Adds an event handler to the callout. Examples - opened, opening, closed and closing

    Parameters

    • eventName: string
    • callback: (callout: ICallout) => void

    Returns any

close

  • close(useAnimation: boolean): any

  • Closes the callout.

    Parameters

    • useAnimation: boolean

    Returns any

destroy

  • destroy(): any

  • Do not call this method, use the CalloutManager to remove the callout.

    Returns any

getActionMenu

  • Returns the action menu of the callout.

    Returns ICalloutActionMenu

getBeakOrientation

  • getBeakOrientation(): string

  • Returns the beak orientation of the callout.

    Returns string

getBoundingBox

  • getBoundingBox(): HTMLElement

  • Returns the bounding box element of the callout.

    Returns HTMLElement

getContent

  • getContent(): string

  • Returns the html of the content.

    Returns string

getContentElement

  • getContentElement(): HTMLElement

  • Returns the content element.

    Returns HTMLElement

getContentWidth

  • getContentWidth(): number

  • Returns the content width of the callout.

    Returns number

getID

  • getID(): string

  • Returns the unique id of the callout.

    Returns string

getLaunchPoint

  • getLaunchPoint(): HTMLElement

  • Returns the launch point element of the callout.

    Returns HTMLElement

getOpenOptions

  • Returns the open options of the callout.

    Returns ICalloutOpenOptions

getPositionAlgorithm

  • getPositionAlgorithm(): any

  • Gets the position of the callout.

    Returns any

getTitle

  • getTitle(): string

  • Returns the title of the callout.

    Returns string

isClosed

  • isClosed(): boolean

  • Returns true if the callout is closed.

    Returns boolean

isClosing

  • isClosing(): boolean

  • Returns true if the callout is closing.

    Returns boolean

isOpen

  • isOpen(): boolean

  • Returns true if the callout is opened.

    Returns boolean

isOpenOrOpening

  • isOpenOrOpening(): boolean

  • Returns true if the callout is opening or opened.

    Returns boolean

isOpening

  • isOpening(): boolean

  • Returns true if the callout is in the "Opening" state.

    Returns boolean

open

  • open(useAnimation?: boolean): any

  • Displays the callout.

    Parameters

    • Optional useAnimation: boolean

    Returns any

refreshActions

  • refreshActions(): any

  • Re-renders the actions menu. Call after the actions menu is changed.

    Returns any

set

  • Sets options for the callout. Note - Not all options can be changed for the callout after its creation.

    Parameters

    Returns any

toggle

  • toggle(): any

  • Displays the callout if it's hidden, hides it otherwise.

    Returns any

Generated using TypeDoc