Interface PopoutOptions

Represents options that specifies where and how a pop out dialog shall be shown.

interface PopoutOptions {
    alignment?:
        | "Left"
        | "Right"
        | "Top"
        | "Bottom";
    autoClose: boolean;
    x: number;
    y: number;
    onChange(event: PopoutComponentEvent): void;
    onClosed?(): void;
}

Properties

alignment? autoClose x y

Methods

onChange onClosed?

Properties

Optionalalignment

alignment?:
    | "Left"
    | "Right"
    | "Top"
    | "Bottom"

Specifies how to position of the popout in relation to the anchor point specified by x and y.

The alignment value specifies which edge of the pop out that shall be closest to the anchor point. For example, to show the pop out below the anchor point, specify Top.

autoClose

autoClose: boolean

Specifies whether to automatically close the popout when one of the components in it is clicked.

x

x: number

Specifies the horizontal pixel coordinate of the anchor point of the pop out dialog.

The coordinate is specified relative to an origin in the top left corner of the Mod viewport.

y

y: number

Specifies the vertical pixel coordinate of the anchor point of the pop out dialog.

The coordinate is specified relative to an origin in the top left corner of the Mod viewport.

Methods

onChange

  • onChange(event): void

  • Specifies the callback to invoke when a component in the pop out dialog is changed.

    Parameters

    Returns void

OptionalonClosed

  • onClosed(): void

  • Specifies the callback to invoke when the pop out dialog has been closed. This callback is optional and can be left unassigned.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods