Integrating your XGEE editor model

After the creation of an XGEE editor model, the editor must be packaged as a jsApplication plugin, which includes the editor model and any required resources like icons, shapes or additional code. The plugin then must register the editor and xgee.models XGEE extension point.

Assuming you have created the ExampleEditor.editorModel your init function of your plugin should look like this:

export async function init(pluginAPI) {
     //Implementation of XGEE's xgee.models extension point
     pluginAPI.implement('xgee.models',{
         modelPath: "./ExampleEditor.editorModel",
     })
 };

The previous code registers your model with XGEE, so that your editor becomes available in your application. The supplied modelPath is relative to your plugin’s directory. XGEE will load and parse the XMI resource and the Edit option becomes available in the context menu for the applicable model objects. In the meta information of the plugin we can provide information on the version, author other required jsApplication plugins.

export var meta={
    "id":"ExampleEditor",
    "description":"Example Editor from the XGEE tutorial",
    "author":"Your Name",
    "version":"1.0.0",
    "requires":["xgee"]
};

Of course, your plugin can implement additional extension points and include further code to customize your editor beyond the options available in XGEE’s model definition. To load the plugin at start up, you must add an entry to the jsApplication plugin config in the index.html of your XGEE application.

'ExampleEditor' : {enabled: true}