Skip to main content

About Next Design API

Description

This section describes APIs that can be used for Next Design extension development by functional area.

API specification preview released

APIs marked with have been published in advance. 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
globalA group of APIs to access the execution environment and execution state of the extension.
CommandsA group of APIs to access commands received by command handlers.
EventExplains APIs for accessing events received by event handlers by area.
Workspace projectA group of APIs to access the workspace of the application and the projects opened in the application.
ProfileA group of APIs to access profiles.
ModelA group of APIs to access the model.
Interaction modelA group of APIs to access the interaction model.
EditorAPIs to access editors.
Sequence editorAPIs for accessing sequence diagrams.
User interfaceA group of APIs that access the UI such as the editor and navigator.
UtilityGeneral-purpose APIs.
Search/error/outputA group of APIs to access error information, search results, and the output window.
Model difference/comparisonA group of APIs to access model comparison operations and difference information.
Product LineA group of APIs to access the product line model.
Team CollaborationA group of APIs that provide collaboration with configuration management systems for team development.
TraceA group of APIs to access trace information.
EditingCapabilityAPIs to access EditingCapability.
Custom UIA group of APIs to access the custom UI.
Document GenerationAPIs to access document generation.