API for develop plugins

Posts

How to Deploy Plugins to VP Products

tomcat-thumbOpen API is an extension mechanism provided by Visual Paradigm for extending the functionalities of the client software. The Open API is in Java based, which allows you to have full access to the model data in your project file. By using Open API, you can create your own plugin to implement some customized features.

Read more

Creating document with Doc. Composer using Open API

The Doc. Composer allows you to create document for your model in a fully customized way. You can  customize the layout of your document by simply modifying the XML templates and specify what’s inside your document by drag & drop the templates into it, just like creating a diagram. But the drag & drop is a manual process, which you need to do it every time when you want to create a new document. Also after adding new contents, you will need to update it manually by adding the new elements into your existing document. In this article, we will show you how you can make use of the Open API to construct a document in a programmatic way, which can save you a lots of time. 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

How to Remove User Defined Tagged Values for All Model Elements Using API

Using tagged values is a convenient way to define additional details to model element. You can define tagged values on individual elements as a one-off usage, or define it under Stereotypes and reuse it by apply the stereotype to model elements. But to remove the tag, say you found that one of the tagged values in your model is no longer valid, you will have to go through model by model to locate and remove them. It is OK for a small project, but a very time consuming job for a large project. Since the Open API provides full access to the model data within the project, we can make use of it to remove the unwanted tagged values. In this article will show you how to remove the user defined tagged values from model element by developing a plugin. Read more

How to Define Stereotype and Tagged Values using API

Stereotype is one of the extension mechanisms in the Unified Modeling Language (UML). By defining stereotype, you can extend new notations by deriving from an existing one. You can define new properties to your derived notations using tagged values. In Visual Paradigm, it is not necessary to stereotypes and tagged values using application’s user interface. You can also do this using Open API. This article will show you how to create stereotype and tagged values using Open API. Read more

Create and Access Logical View via API

Open API not only allows you access the model data within the project, but also create and access the Logical View in your project. This article will show you how to create Logical View using Open API. Read more

How to Create Containment Relationship with API

Open API not only allows you access the model data within the project, but also creating new model elements and connector. This is not only for standard connectors such as association, but also relationships such as containment. This article will show you how to create containment relationship using Open API. Read more

How to Manage Nickname with API

Most of the case, your model just needs to be share by your team, and they are in single language. But in some organizations, especially those with branches in multiple countries, you may need to share your model with different teams, and probably they are using different language. It is painful that you need to maintain multiple sets of models, each on one language. Every time when you need to make modification, you need apply the same modification on all the models you have. This is time very annoying and consuming. 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

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