Class Callout

Index

Methods

Methods

public addAction(action: CalloutAction): any

Adds a link to the actions panel in the bottom part of the callout window

Parameters

Returns

any

public addEventCallback(eventName: string, callback: (callout: Callout) => void): any

Adds event handler to the callout.

Parameters

  • eventName: string

    one of the following: "opened", "opening", "closing", "closed"

  • callback: (callout: Callout) => void

Returns

any

public close(useAnimation: boolean): any

Hide the callout. Animation can be used only for IE9+

Parameters

  • useAnimation: boolean

Returns

any

public destroy()

Do not call this directly. Instead, use CalloutManager.remove

public getActionMenu(): CalloutActionMenu

Returns the callout actions menu

Returns

CalloutActionMenu

public getBeakOrientation(): string

Returns the beak orientation defined for the callout during its creation.

Returns

string

public getBoundingBox(): HTMLElement

Returns the bounding element defined for the callout during its creation.

Returns

HTMLElement

public getContent(): string

Returns the contents of the callout.

Returns

string

public getContentElement(): HTMLElement

Returns the content element of the callout.

Returns

HTMLElement

public getContentWidth(): number

Returns the content width defined for the callout during its creation.

Returns

number

public getID(): string

Returns the ID of the callout.

Returns

string

public getLaunchPoint(): HTMLElement

Returns the launch point element of the callout.

Returns

HTMLElement

public getOpenOptions(): CalloutOpenOptions

Returns the object that represents open behaivor defined for the callout during its creation.

Returns

CalloutOpenOptions

public getPositionAlgorithm(): any

Returns the position algorithm function defined for the callout during its creation.

Returns

any

public getTitle(): string

Returns the title of the callout.

Returns

string

public isClosed(): boolean

Specifies wherever callout is in "Closed" state

Returns

boolean

public isClosing(): boolean

Specifies wherever callout is in "Closing" state

Returns

boolean

public isOpen(): boolean

Specifies wherever callout is in "Opened" state

Returns

boolean

public isOpenOrOpening(): boolean

Specifies wherever callout is in "Opened" or "Opening" state

Returns

boolean

public isOpening(): boolean

Specifies wherever callout is in "Opening" state

Returns

boolean

public open(useAnimation: boolean): any

Display the callout. Animation can be used only for IE9+

Parameters

  • useAnimation: boolean

Returns

any

public refreshActions()

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

public set(options: CalloutOptions): any

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

Parameters

Returns

any

public toggle()

Display if hidden, hide if shown.