Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IBoardDialogBuilder

A class to build a board dialog.

api-version

1

system

Hierarchy

  • IBoardDialogBuilder

Index

Methods

  • Sets whether this dialog is canceled when touched outside the dialog's bounds. If user close a dialog via touched outside the dialog's bounds, then OnCancelListener will be called.

    api-version

    1

    user

    Parameters

    • cancelable: boolean

      Whether the dialog should be canceled when touched outside the dialog's bounds.

    Returns IBoardDialogBuilder

  • Sets a close button in the dialog. The button is shown at top right corner in the dialog. If user close a dialog via this button, then OnCancelListener will be called.

    api-version

    1

    user

    Parameters

    • enabled: boolean

      Set whether the close button is enabled or not.

    Returns IBoardDialogBuilder

  • setDraggable(draggable: boolean, defaultPosition?: { x?: number; y?: number }): IBoardDialogBuilder
  • Sets whether this dialog is draggable. It a dialog is set as draggable, then setAnchor, setAlignment and setCancelable will be ignored.

    api-version

    1

    system

    Parameters

    • draggable: boolean

      Whether the dialog is draggable.

    • Optional defaultPosition: { x?: number; y?: number }

      The [x, y] position at which the popup screen will be displayed. If is not set, then the dialog will be positioned at center.

      • Optional x?: number
      • Optional y?: number

    Returns IBoardDialogBuilder

Generated using TypeDoc