i2 Notebook SDK
Search results for

    Show/hide table of contents

    Home > @i2analyze/notebook-sdk > getToolViewApi

    getToolViewApi() function

    Retrieves the plug-in tool view API.

    Signature:

    export declare function getToolViewApi(): Promise<toolview.IToolViewApi>;
    

    Returns:

    Promise<toolview.IToolViewApi>

    A promise that resolves to the tool view API.

    Introduced: version 1.0

    Exceptions

    Error (through the promise) if the version of the SDK was incompatible with the deployed version of i2 Notebook.

    In this article
    • getToolViewApi() function
    • Exceptions
    Back to top © N. Harris Computer Corporation