Altair EEvision 2025.1 APIs
    Preparing search index...

    Type Alias Plugin

    Functions that must / can be provided by a plugin and that are called from the EEvision GUI.

    type Plugin = {
        onConfigChange?: ConfigChangeHandler;
        onHistoryRequest?: HistoryRequestHandler;
        onHistoryRestore?: HistoryRestoreHandler;
        onPageChange?: PageChangeHandler;
        onSchematicChange?: SchematicChangeHandler;
        onSelection?: SelectionHandler;
        load(): void | Promise<void>;
        unload(): void | Promise<void>;
    }
    Index

    Properties

    onConfigChange? onHistoryRequest? onHistoryRestore? onPageChange? onSchematicChange? onSelection?

    Methods

    load unload

    Properties

    onConfigChange?: ConfigChangeHandler

    This function is called whenever the configuration of EEvision changes (because PluginAPI.ChangeConfig has been called).

    onHistoryRequest?: HistoryRequestHandler

    This function is called whenever the browser's history state is updated or a new entry on the history stack is created.

    onHistoryRestore?: HistoryRestoreHandler

    This function is called whenever EEvision needs to store an old history state.

    onPageChange?: PageChangeHandler

    This function is called when the current page has changed.

    onSchematicChange?: SchematicChangeHandler

    This function is called whenever the contents of the schematic changes (e.g., after calling PluginAPI.LoadObj or interactively extending the schematic).

    onSelection?: SelectionHandler

    This function is called when the selection in EEvision changes.

    Methods

    • This function is called whenever the plugin is activated in EEvision.

      Returns void | Promise<void>

    • This function is called whenever the plugin is removed from EEvision.

      Returns void | Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods