Module developer’s API guide¶

Introduction

Model API¶

• Runtime environment of a module

  • The module context
  • The modeling session

• Model services

  • access and explore model
    • basic navigation
    • advanced navigation
    • commented examples
  • transactions
  • create/modify/delete model elements
  • react to model changes (model listener)
• Metamodel services
  • Metamodel API
  • meta-navigation

Application API¶

• Modelio context service – Get information about Modelio
• Project context service – Get information about the project
• Module service – Access to the ‘peer’ services of the modules in the project
  • List the modules of the project
  • Call the services provided by a module
  • Manage a module’s configuration (parameters)
• Model components service – Manage the model components in the project
  • List the model components of the project
  • Deploy a model component in the project
  • Remove a model component from the project
  • Package a model component defined in the project
• Audit services – Use the Modelio Audit services
  • Audit of a model element
  • Check a model element
• Log services – Write messages in the Modelio log
  • log a message
• Script services – Evaluate Jython scripts or expressions in Modelio
  • get a Python interpreter to execute a Python script

GUI API¶

• Diagram services – manipulating diagrams
  • Concepts
  • API Model
  • Masking unmasking
  • Changing the diagram symbols appearance
  • Layouting the diagram
  • Jython code example
• Navigation services – manage the current selection in Modelio
  • Fire navigation events
  • React to changes
• Image services – get an icon for a model element
  • get a model element’s image
• Picking services – graphic completion mecanism
  • be a picking client
  • be a picking provider
• Edition services – open a simple text editor
  • open a text editor
  • react to the editor save and close events

Annexes¶

• Diagram style properties – All available style properties for diagram elements.