Skip to main content

About the API of Next Design

Description

Describes the APIs that can be used to develop Next Design extensions by functional area.

Preview API specification released

APIs marked with are pre-published. At this time, we do not guarantee the quality of these APIs, so please use them at your own risk. Also, please note that these API specifications are subject to change without notice.

area

NameDescription
GlobalAPIs that access the extension's execution environment and execution status.
CommandAPI group to access the command received by the command handler.
EventDescribes the API group that accesses the event received by the event handler by area.
Workspace ProjectAPIs that access the workspace of the application or the project open in the application.
ProfileAPIs to access the profile.
ModelAPIs to access the model.
Interaction modelAPIs to access the interaction model.
EditorAPIs to access the editor.
Sequence EditorAPIs for accessing sequence diagrams.
User InterfaceAPIs that access UI such as editors and navigators.
Utility General API group.
Search/Error/OutputAPIs for accessing error information, search results, and output windows.
Model difference/comparison API group to access model comparison operation and difference information.
Product Line APIs to access the product line model.
Team Collaboration APIs that provide linked operations with the configuration management system for team development.
Trace APIs to access Torres information.
Editing Capability APIs to access Editing Capability.
Custom UI APIs to access the custom UI.
Document Generation APIs to access document generation.