Class IFrameProvider

Wrapper over an iframe

viewportChange Event when the viewport of the element changes destroy Termination of the provider

Hierarchy

  • EventEmitter
    • IFrameProvider

Implements

Constructors

constructor

Methods

createElement destroy getElement getVisibleArea initialize resize subscribeVisibleAreaChange updateViewport

Constructors

constructor

  • new IFrameProvider(url, widget, id, reduceViewportChange?): IFrameProvider

  • Creating a new provider instance

    Parameters

    • url: string

      URL to load the iframe from

    • widget: Widget

      Widget object

    • id: string

      Unique widget identifier

    • Optional reduceViewportChange: Debounce

      Method to debounce viewport change tracking

    Returns IFrameProvider

Methods

createElement

destroy

getElement

  • getElement(): HTMLIFrameElement

  • Get the current iframe element

    Returns HTMLIFrameElement

getVisibleArea

initialize

  • initialize(): Promise<Promisify<EventEmitter<DefaultEventMap> & IFrameConsumerAPI>>

  • Initialization of the iframe provider

    Returns Promise<Promisify<EventEmitter<DefaultEventMap> & IFrameConsumerAPI>>

resize

subscribeVisibleAreaChange

  • subscribeVisibleAreaChange(callback): (() => void)

  • Subscription to changes in the visible area of the iframe

    Parameters

    Returns (() => void)

      • (): void

      • Returns void

updateViewport

Settings

Member Visibility

Theme

On This Page

constructorcreateElementdestroygetElementgetVisibleAreainitializeresizesubscribeVisibleAreaChangeupdateViewport

Generated using TypeDoc