1. Home
  2. Classes
  3. CalloutManager

new CalloutManager( container: ) → {CalloutManager}

Description
Creates a CalloutManager
Parameters
Name Type Description
container: HTMLDivElement div to be parent of the callout
Returns

Members

<nullable> onAutoRemove :onAutoRemoveCallback

Description
Callback function for when a callout is removed via manager

autoRemoveCallouts :Boolean

Description
Should the manager remove callouts itself

autoRemoveThresholdSimilarity :Number

Description
Threshold below which callouts will be removed

autoRemoveThresholdMargins :Object

Description
Thresholds for margins

<nullable> shouldAutoRemoveCallout :shouldAutoRemoveHandler

Description
If provided, determines if a callout should auto-remove

drawables :Array.<Drawable>

Description
All drawable objects contained in callouts

Methods

<package> release()

Description
Destroys listeners to allow for garbage collection

addCallout( definition: )

Description
Add a single callout by its definion
Parameters
Name Type Description
definition: CalloutDefinition Definition for callout to be added

removeCallout( definition )

Description
Removes a single callout definition
Parameters
Name Type Description
definition CalloutDefinition

replaceCallouts( calloutDefinitions: )

Description
Replaces all existing callout definitions with a new array
Parameters
Name Type Description
calloutDefinitions: Array.<CalloutDefinition> new callout definitions to use

removeAllCallouts()

Description
removes all callouts

getCalloutForDefinition( definition ) → {Callout}

Description
Returns an existing Callout for a given CalloutDefinition, if one exists.
Parameters
Name Type Description
definition CalloutDefinition describes an instance of a callout
Returns

<package> update( time )

Description
Update function for callout manager
Parameters
Name Type Description
time Number