i2 Notebook SDK
Search results for

    Show/hide table of contents

    Home > @i2analyze/notebook-sdk > IEntryPointApi

    IEntryPointApi interface

    The core API that the i2 Notebook application makes available to plug-in entry points.

    Signature:

    export interface IEntryPointApi extends app.IApplication 
    

    Extends: app.IApplication

    Introduced: version 1.0

    Properties

    Property Modifiers Type Description
    allTimeZones readonly data.IKeyedReadOnlyCollection<data.TimeZoneId, data.ITimeZone>

    Gets a list of all the valid time zones, in the same order as they appear in the application.

    (Inherited from IApplication)

    commands readonly commands.ICommandApi Gets the core API for custom commands.
    formatter readonly data.IFormatter Gets an object that can be used to perform locale-sensitive string-formatting operations.
    locale readonly ILocale

    Gets the locale in which the application is operating.

    (Inherited from IApplication)

    logger readonly ILogger Gets an object that can be used to perform plug-in logging operations.
    metadataTimeZone readonly data.ITimeZone

    Gets the time zone that the application assumes date and time values in metadata to have.

    (Inherited from IApplication)

    serverComponents readonly IServerComponents

    Gets information about the i2 Analyze components that are deployed on the application server.

    (Inherited from IApplication)

    systemActions readonly dialog.ISystemDialogActions

    Gets the identifiers of the system dialog actions.

    (Inherited from IApplication)

    theme readonly ITheme

    Gets the current theme of the application.

    (Inherited from IApplication)

    user readonly IUserAndPermissions

    Gets the logged-in user of the application.

    (Inherited from IApplication)

    Methods

    Method Description
    addEventListener(type, listener, options)

    Adds an event listener. See app.ApplicationEventMap for the available events.

    (Inherited from IApplicationEvents)

    createToolView(name, path) Creates and returns a tool view with the specified name and content.
    createToolView(config) Creates and returns a tool view with the specified configuration.
    initializationComplete() Allows plug-ins to indicate when their registrations are complete, so that the i2 Notebook user interface can start.
    removeEventListener(type, listener)

    Removes an event listener. See app.ApplicationEventMap for the available events.

    (Inherited from IApplicationEvents)

    runTrackedMutations(mutationHandler, responseHandler, options)

    Queues a function that performs tracked mutations on the application contents at the next available opportunity, and can respond to the changes that the mutations cause.

    (Inherited from IApplication)

    runTrackedMutations(mutationHandler, options)

    Queues a function that performs tracked mutations on the application contents at the next available opportunity.

    (Inherited from IApplication)

    runTransaction(handler, options)

    Queues a function that performs read-only work on the application contents at the next available opportunity.

    (Inherited from IApplication)

    runUntrackedMutations(mutationHandler, responseHandler, options)

    Queues a function that performs untracked mutations on the application contents at the next available opportunity, and can respond to the changes that the mutations cause.

    (Inherited from IApplication)

    runUntrackedMutations(mutationHandler, options)

    Queues a function that performs untracked mutations on the application contents at the next available opportunity.

    (Inherited from IApplication)

    showDialog(config) Creates and displays a modal dialog with the specified configuration.
    In this article
    Back to top © N. Harris Computer Corporation