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

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

Type declaration

  • OptionalonConfigChange?: ConfigChangeHandler

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

  • OptionalonHistoryRequest?: HistoryRequestHandler

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

  • OptionalonHistoryRestore?: HistoryRestoreHandler

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

  • OptionalonPageChange?: PageChangeHandler

    This function is called when the current page has changed.

  • OptionalonSchematicChange?: SchematicChangeHandler

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

  • OptionalonSelection?: SelectionHandler

    This function is called when the selection in EEvision changes.

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

      Returns void | Promise<void>

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

      Returns void | Promise<void>