Interface ICalloutManager

Callout Manager

Hierarchy

ICalloutManager

Index

Methods

Methods

closeAll

closeAll(): any

- Defined in @types/helper/sp.d.ts:202
Closes all callouts on the page.

Returns any

containsOneCalloutOpen

containsOneCalloutOpen(el: HTMLElement): any

- Defined in @types/helper/sp.d.ts:205
Returns true if the associated callout is open.

Parameters
- el: HTMLElement
Returns any

createAction

createAction(options: ICalloutActionOptions): ICalloutAction

- Defined in @types/helper/sp.d.ts:208
Creates an action menu entry.

Parameters
- options: ICalloutActionOptions
Returns ICalloutAction

createMenuEntries

createMenuEntries(options: Array<ICalloutActionMenuEntry>): Array<ICalloutActionMenu>

- Defined in @types/helper/sp.d.ts:211
Creates an action menu entries.

Parameters
- options: Array<ICalloutActionMenuEntry>
Returns Array<ICalloutActionMenu>

createNew

createNew(options: ICalloutOptions): any

- Defined in @types/helper/sp.d.ts:214
Creates a new callout.

Parameters
- options: ICalloutOptions
Returns any

createNewIfNecessary

createNewIfNecessary(options: ICalloutOptions): ICallout

- Defined in @types/helper/sp.d.ts:217
Checks if the callout id exists, before creating it.

Parameters
- options: ICalloutOptions
Returns ICallout

forEach

forEach(callback: (callout: ICallout) => void): any

- Defined in @types/helper/sp.d.ts:220
Performs an action on each callout on the page.

Parameters
- callback: (callout: ICallout) => void
  - - (callout: ICallout): void
    - Parameters
      - callout: ICallout
      Returns void
Returns any

getFromCalloutDescendant

getFromCalloutDescendant(descendant: HTMLElement): ICallout

- Defined in @types/helper/sp.d.ts:223
Finds the closest launch point and returns the callout associated with it.

Parameters
- descendant: HTMLElement
Returns ICallout

getFromLaunchPoint

getFromLaunchPoint(launchPoint: HTMLElement): ICallout

- Defined in @types/helper/sp.d.ts:226
Returns the callout from the specified launch point.

Parameters
- launchPoint: HTMLElement
Returns ICallout

getFromLaunchPointIfExists

getFromLaunchPointIfExists(launchPoint: HTMLElement): ICallout

- Defined in @types/helper/sp.d.ts:229
Returns the callout for the specified launch point, null if it doesn't exist.

Parameters
- launchPoint: HTMLElement
Returns ICallout

init

init(): PromiseLike<void>

- Defined in @types/helper/sp.d.ts:240
Method to ensure the core script is loaded.

Returns PromiseLike<void>

isAtLeastOneCalloutOn

isAtLeastOneCalloutOn(): boolean

- Defined in @types/helper/sp.d.ts:232
Returns true if at least one callout is defined on the page is opened or opening.

Returns boolean

isAtLeastOneCalloutOpen

isAtLeastOneCalloutOpen(): boolean

- Defined in @types/helper/sp.d.ts:235
Returns true if at least one callout is opened on the page.

Returns boolean

remove

remove(callout: ICallout): any

- Defined in @types/helper/sp.d.ts:243
Removes the callout and destroys it.

Parameters
- callout: ICallout
Returns any

Generated using TypeDoc