Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICalloutOptions

Callout Options

Hierarchy

  • ICalloutOptions

Index

Properties

ID

ID: string

The unique id of the callout.

Optional beakOrientation

beakOrientation: string

The orientation of the callout. The valid options are: topBottom (default) or leftRight

Optional boundingBox

boundingBox: Element

Optional content

content: string

The html to be displayed in the callout.

Optional contentElement

contentElement: Element

Element to be displayed in the callout.

Optional contentWidth

contentWidth: number

The width in pixels. Default - 350px

launchPoint

launchPoint: Element

The element to apply the callout to.

Optional openOptions

openOptions: ICalloutOpenOptions

Defines the callout opening behavior.

Optional title

title: string

The title of the callout.

Methods

Optional onClosedCallback

  • onClosedCallback(callout: ICallout): any
  • Event triggered after the callout is closed.

    Parameters

    Returns any

Optional onClosingCallback

  • onClosingCallback(callout: ICallout): any
  • Event triggered before the callout is closed.

    Parameters

    Returns any

Optional onOpenedCallback

  • onOpenedCallback(callout: ICallout): any
  • Event triggered after the callout is shown.

    Parameters

    Returns any

Optional onOpeningCallback

  • onOpeningCallback(callout: ICallout): any
  • Event triggered after the callout is rendered, but before it is positioned and shown.

    Parameters

    Returns any

Optional positionAlgorithm

  • positionAlgorithm(callout: ICallout): any
  • Sets the position of the callout during the opening event.

    Parameters

    Returns any

Generated using TypeDoc