Tricks for plug-in development.
How to Add Stereotypes from Reference Project to Model Element Using API
Stereotype is one of the extensibility mechanism used in Unified Modeling Language (UML). It allows developers to extend the meaning of a model element. By using stereotype, developer can define domain specific properties to model element and make it suitable for a particular problem domain. Visual Paradigm’s product support defining stereotypes for model, not just via the application interface, but also using Open API. In the old API, you can only specify stereotype to model element from your current working project. Starting from VP Suite 5.2 (build 20110518r), we introduced new interface to let you specify stereotypes from your dependent projects. This article will teach you how to specify a stereotype which is from a dependent to a model element. Read more
How to Retrieve Relationships from Models Using API
A relationship is a connection between model elements, which indicate model elements physically or logically related to each other. Different relationships in UML have their own semantics, and different model elements may have different sets of relationships which can apply to it. This article will show you the types of relationships in VP and how to retrieve them from your model elements. Read more
Create Diagram Image Shape with API
Your diagrams are not necessary to be modeled just with the standard notations. With the Diagram Image Shapes, you can enrich your diagram with customized image files. The Diagram Image Shapes can be created via the prattle of the diagram, as well as using Open API. This article will show you how to create Diagram Image Shapes from an image file deployed in your plugin using Open API. Read more
Create Communication Diagram using Open API
Communication diagram is a kind of behavior diagram in Unified Modeling Language (UML) which helps in visualize the interactions within and between systems. The Communication diagram focus on how objects collaboration together in particular scenario. Instead of creating communication diagram manually, you can also create it programmatically using Open API in Visual Paradigm’s products.
Control diagram preview image in Doc. Composer using Open API
The Doc. Composer allows you to create document for your model in a fully customized way. For diagrams presented on a Doc. Composer, instead of showing the entire diagram you may want to have it focused on a specific part of a diagram. Instead of adjust the zoom ratio and scroll position manually in Doc. Composer, you can also do it with the Open API. In this article we will show you how to make use of Open API to adjust the zoom ratio and scroll position of the diagram image in Doc. Composer. Read more
Retrieve Flow Sequence in Business Process Diagram using Open API
Visual Paradigm’s Open API is a powerful tool which allow user to extend the functionalities of Visual Paradigm software. Open API provide full access to the model information within the project, and user can retrieve the diagram and model information in programmatic approach. For most of the case user can obtain the diagram and model information as a collection where the elements are sorted based on the creation order. But in Business Process Diagram there is a special way to retrieve the elements according to their flow order. In this article we will show you how it works. Read more
Adding Elements to Diagram Layers using Open API
Visual Paradigm support create diagram with multiple layers. The layer function allow you to assign different shapes into different layers. It help in hiding unnecessary information in your diagram. The layer information can also being access via Open API. In this article we will show you how to work with layers using Open API, including create layers and assign the shapes and connectors in your diagram to different layers. Read more
Control Shape Caption Placement using Open API
When creating diagrams sometimes you might want to have the caption not showing in the default location, i.e. to have better layout for the containing elements while not having the name being covered. In this case you may adjust the caption position to reserve space for the child elements. To do this you can specify the caption placement of the individual element via the user interface. But instead of manually specify the caption placement shape by shape, you can also do this via the Open API. In this article we will use Component as sample to demonstrate how to control its caption position with Visual Paradigm’s Open API. Read more
How to retrieve a diagram in your project using Open API
Visual Paradigm’s Open API allow user to access the model data in your project in programmatic way by creating plugin. With Open API you can create new diagram or model elements to your project, also retrieve the diagram or model elements form your project and manipulate it. Read more
