Class CalloutOptions

Index

Properties

Properties

public ID: string

Some unique id for the callout.

public beakOrientation: string

One of the following: "topBottom" (default) or "leftRight".

public boundingBox: HTMLElement

If defined, callout will be inscribed into the bounding element.

public content: string

String (HTML allowed) that represents contents of the callout window.

public contentElement: HTMLElement

HTML element that represents contents of the callout window.

public contentWidth: number

Content element's width in pixels. By default = 350.

public launchPoint: HTMLElement

Element on that the callout is shown.

public onClosedCallback: (callout: Callout) => void

Fires right after the callout is closed

public onClosingCallback: (callout: Callout) => void

Fires right before the callout is closed

public onOpenedCallback: (callout: Callout) => void

Fires right after the callout is shown

public onOpeningCallback: (callout: Callout) => void

Fires after the callout is rendered but before it is positioned and shown

public openOptions: CalloutOpenOptions

Defines opening behavior

public positionAlgorithm: (callout: Callout) => void

Sets the position of the callout during its opening phase. For an example of a position algorithm function, please explore defaultPositionAlgorithm function from the callout.debug.js file

public title: string

Title for the callout