papi-dts
    Preparing search index...

    Interface PopoverRequest

    Request payload for IOverlayService.showPopover. Describes where to anchor the popover, what content to display, and behavioral options.

    interface PopoverRequest {
        anchor: { height?: number; width?: number; x: number; y: number };
        content: PopoverContent;
        dismissAfterMs?: number;
        dismissOnClickOutside?: boolean;
        maxWidth?: number;
        showArrow?: boolean;
        side?: "left" | "top" | "bottom" | "right";
    }
    Index

    Properties

    anchor content dismissAfterMs? dismissOnClickOutside? maxWidth? showArrow? side?

    Properties

    anchor: { height?: number; width?: number; x: number; y: number }

    Anchor rectangle in pixels relative to the requesting WebView's iframe origin. The popover is positioned adjacent to this rectangle on the specified side. If width/height are provided, the popover aligns to the full rectangle; otherwise it anchors to the point (x, y).

    content

    content: PopoverContent

    The content to display inside the popover. Can be updated later via updatePopover.

    dismissAfterMs?: number

    Automatically dismiss the popover after this many milliseconds. Useful for transient notifications. If omitted, the popover stays open until explicitly dismissed. Must be positive.

    dismissOnClickOutside?: boolean

    Whether clicking outside the popover dismisses it. Defaults to true.

    maxWidth?: number

    Maximum width of the popover in pixels. If omitted, uses a default max width.

    showArrow?: boolean

    Whether to display an arrow pointing from the popover toward the anchor. Defaults to true.

    side?: "left" | "top" | "bottom" | "right"

    Preferred side of the anchor to place the popover. Defaults to 'bottom'.

    Settings

    Member Visibility

    On This Page

    Properties