i2 Notebook SDK
Search results for

    Show/hide table of contents

    Home > @i2analyze/notebook-sdk > IEntryPointApi > showDialog

    IEntryPointApi.showDialog() method

    Creates and displays a modal dialog with the specified configuration.

    Signature:

    showDialog<TResult, TInitialize>(config: dialog.IDialogConfig<TInitialize>): Promise<TResult>;
    

    Introduced: version 1.4

    Type Parameters

    Parameter Type Description
    TResult any The type of the data that the dialog returns when it's submitted.
    TInitialize any The type of the data that's used to populate the dialog when it's displayed.

    Parameters

    Parameter Type Description
    config dialog.IDialogConfig<TInitialize> The information for creating the dialog, including its size and its buttons.

    Returns:

    Promise<TResult>

    The value submitted from the dialog.

    In this article
    Back to top © N. Harris Computer Corporation