BimCT SDK / WebGL2 Viewer
    Preparing search index...

    Class BimCTMessageBoxWindow

    Class representing a message box window.

    Hierarchy

    • BimCTModalWindow
      • BimCTMessageBoxWindow
    Index

    Constructors

    constructor

    Accessors

    windowResizedEvent windowStateChangedEvent windowElement index leafRowHeight zIndex active resetWindowStyle title footerText renderer

    Methods

    showMessage showMessageAsync showInputTextMessageAsync showInputNumberMessageAsync showInputUnitMessageAsync hide activateWindow setWindowLoading restoreWindow maximizeWindow isShowing resetToDefault moveHorizontally refreshUI setTempHide

    Constructors

    Accessors

    • get windowResizedEvent(): IEvent<number, number>

      Returns IEvent<number, number>

    • get windowElement(): HTMLElement

      Returns HTMLElement

    • get index(): number

      Returns number

    • set index(index: number): void

      Parameters

      • index: number

      Returns void

    • get leafRowHeight(): number

      Returns number

    • get zIndex(): number

      Returns number

    • set zIndex(zIndex: number): void

      Parameters

      • zIndex: number

      Returns void

    • get active(): boolean

      Returns boolean

    • set active(active: boolean): void

      Parameters

      • active: boolean

      Returns void

    • get resetWindowStyle(): string

      Returns string

    • set resetWindowStyle(val: string): void

      Parameters

      • val: string

      Returns void

    • get title(): string

      Returns string

    • set title(title: string): void

      Parameters

      • title: string

      Returns void

    • get footerText(): string

      Returns string

    • set footerText(footerText: string): void

      Parameters

      • footerText: string

      Returns void

    • get renderer(): BaseRenderer

      Gets the renderer associated with the window.

      Returns BaseRenderer

      The renderer.

    Methods

    • Shows a message box with the specified parameters.

      Parameters

      • message: string

        The message to display.

      • title: string = ...

        The title of the message box.

      • callback: BimCTMessageBoxWindowCallback

        The callback to execute when a button is clicked.

      • option: MessageOption = MessageOption.OKCANCEL

        The options to display in the message box.

      • icon: MessageIcon = MessageIcon.INFO

        The icon to display in the message box.

      Returns boolean

      True if the message box was shown, false otherwise.

    • Shows a message box asynchronously with the specified parameters.

      Parameters

      • message: string

        The message to display.

      • title: string = ...

        The title of the message box.

      • option: MessageOption = MessageOption.OKCANCEL

        The options to display in the message box.

      • icon: MessageIcon = MessageIcon.INFO

        The icon to display in the message box.

      Returns Promise<MessageResult>

      A promise that resolves to the result of the message box.

    • Shows a message box with a text input asynchronously.

      Parameters

      • message: string

        The message to display.

      • title: string = ...

        The title of the message box.

      • value: string = ''

        The initial value of the text input.

      • icon: MessageIcon = MessageIcon.INFO

        The icon to display in the message box.

      Returns Promise<string>

      A promise that resolves to the input text value.

    • Shows a message box with a number input asynchronously.

      Parameters

      • message: string

        The message to display.

      • title: string = ...

        The title of the message box.

      • value: number = undefined

        The initial value of the number input.

      • icon: MessageIcon = MessageIcon.INFO

        The icon to display in the message box.

      Returns Promise<number>

      A promise that resolves to the input number value.

    • Shows a message box with a unit input asynchronously.

      Parameters

      • message: string

        The message to display.

      • title: string = ...

        The title of the message box.

      • valueInMM: number = undefined

        The initial value of the number input.

      • icon: MessageIcon = MessageIcon.INFO

        The icon to display in the message box.

      Returns Promise<number>

      A promise that resolves to the input number value in millimeters

    • Hides the message box window.

      Returns boolean

      True if the message box was hidden, false otherwise.

    • Activates or deactivates the window.

      Parameters

      • activate: boolean

        Whether to activate the window.

      • Optionalrefresh: boolean = true

        Whether to refresh the UI.

      Returns void

    • Sets the loading state of the window.

      Parameters

      • on: boolean

        Whether to show the loading state.

      Returns void

    • Restores the window to its original size and position.

      Returns void

    • Maximizes the window to fill the screen.

      Returns void

    • Checks if the window is currently showing.

      Returns boolean

      True if the window is showing, otherwise false.

    • Resets the window to its default style.

      Parameters

      • force: boolean

        Whether to force the reset.

      Returns void

    • Moves the window horizontally by a specified number of pixels. Only if already moved one time

      Parameters

      • pixels: number

        The number of pixels to move the window.

      Returns void

    • Refreshes the UI of the modal window.

      Returns void

    • Temporarily hides or shows the modal window.

      Parameters

      • val: boolean

        Whether to hide the window.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods