i2 Notebook SDK
Search results for

    Show/hide table of contents

    Home > @i2analyze/notebook-sdk > app

    app namespace

    The members of the app namespace enable handling for events that take place during the lifetime of the i2 Notebook application, and provide access to top-level data such as user and locale information.

    Signature:

    export declare namespace app 
    

    Introduced: version 1.0

    Interfaces

    Interface Description
    ApplicationEventMap A mapping of application event types to their listener types.
    ApplicationEventOptionsMap A mapping of application event types to their listener options types.
    IApplication The top-level i2 Notebook application.
    IApplicationContents The contents of the i2 Notebook application.
    IApplicationEvents A collection of methods that set up listeners to run in response to events.
    ICancelation A collection of methods and properties for handling the situation when a user cancels an operation.
    IChangeSource The source of a change that takes place in the i2 Notebook application.
    IChartEntityRecordData A set of data for creating an entity record.
    IChartLinkRecordData A set of data for creating a link record.
    IChartRecordBaseData A set of data that is common to creating records of all types.
    IDetailedReport A report on the result of a set of mutations that were not entirely successful. The report is typically displayed through a 'dialog'-style notification.
    IEdgeEditor A set of methods for modifying the appearance of an edge.
    IEdgeSummaryEditor A set of methods for modifying the appearance of an edge summary.
    IElementEditorBase A set of methods for modifying the appearance of an element.
    IElementsAndRecords A collection of elements and records that together represent a selection on the chart surface.
    ILocale A set of locale information.
    IMutationCommitBase A set of information that is common to requests to commit mutations of all types.
    IMutationResult A result from a mutation.
    IMutationRollback A set of information that accompanies a request to roll back a set of mutations.
    IMutationsBase A set of methods for performing tracked or untracked mutations, organized by what they affect.
    INodeEditor A set of methods for modifying the appearance of a node.
    IPendingRecord A record that has been created in a transaction handler, but has not yet been added to a chart.
    IRecordEditor A set of methods for modifying the contents of a record.
    ISelectionEditor A set of methods that can change the chart selection.
    IServerComponents A collection of properties that describe how the application server is configured.
    IStatus A set of methods for changing a status display while an asynchronous mutation is running.
    ISubscriptionOptions A set of options that can influence the execution of an event listener.
    ISuccessReport A report on the result of an entirely successful set of mutations. The report is typically displayed through a transient, 'toast'-style notification.
    ITheme A theme for the i2 Notebook user interface.
    ITrackedMutationCommit A set of information that accompanies a request to commit a set of tracked mutations.
    ITrackedMutations A set of methods for performing tracked mutations, which require an entry in the undo stack.
    ITransactionOptions A set of options that enable control over a callback function during execution.
    IUntrackedMutationCommit A set of information that accompanies a request to commit a set of untracked mutations.
    IUntrackedMutations A set of methods for performing untracked mutations, which do not require an entry in the undo stack.
    IUserAndPermissions An i2 Notebook user.
    IValueFactory A set of utility functions for creating property and other values that can be reused across records.
    IViewEditor A set of methods that change the chart view.

    Type Aliases

    Type Alias Description
    AnalyzeRecordGroupId The identifier of a record group.
    EdgeSpecifier A common specifier for an edge, for use in mutation APIs.
    EdgeSummarySpecifier A common specifier for an edge summary, for use in mutation APIs.
    EditRecordPropertiesSpecifier A common specifier for record properties that are to be edited, for use in mutation APIs.
    ElementSpecifier A common specifier for an element, for use in mutation APIs.
    IMutationReport A report on the result of one or more mutations.
    ITrackedMutationInfo A response from a tracked mutation handler, which indicates whether the mutation should be committed or rolled back.
    IUntrackedMutationInfo A response from an untracked mutation handler, which indicates whether the mutation should be committed or rolled back.
    MutationResponseHandler A function that receives the results of a mutation.
    NodeSpecifier A common specifier for a node, for use in mutation APIs.
    NoteSpecifier A common specifier for a note, for use in mutation APIs.
    RecordPropertiesSpecifier A common specifier for the properties of new records, for use in mutation APIs.
    RecordSpecifier A common specifier for a record, for use in mutation APIs.
    SelectionOption The effect on chart selection of adding a record group to the chart.
    SourceReferenceSpecifier A common specifier for a source reference, for use in mutation APIs.
    ThemeName The names of themes for the i2 Notebook user interface.
    TrackedMutationHandler A function that performs tracked mutations.
    TransactionHandler A callback function that performs read-only work on the application or its contents.
    UntrackedMutationHandler A function that performs untracked mutations.
    In this article
    Back to top © N. Harris Computer Corporation