Skip to content

Commit 5cea003

Browse files
committed
Updated package.json, readme, changelog and screenshot
1 parent 9e4e9c4 commit 5cea003

File tree

4 files changed

+17
-9
lines changed

4 files changed

+17
-9
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Change Log
22

3+
## Version 2.0.0
4+
5+
- The core Javascript library used for rendering the directed graph has been changed from Vis.js to Cytoscape.js. The change was done because Cytoscape.js can render nested nodes which Vis.js was not capable of.
6+
37
## Version 1.3.4
48

59
- Maintenance: Bump packages to latest

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,27 @@
22

33
![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/coderAllan.vscode-dgmlviewer) ![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/coderAllan.vscode-dgmlviewer) ![GitHub top language](https://img.shields.io/github/languages/top/CoderAllan/vscode-dgmlviewer.svg) ![GitHub last commit](https://img.shields.io/github/last-commit/CoderAllan/vscode-dgmlviewer.svg) ![GitHub](https://img.shields.io/github/license/CoderAllan/vscode-dgmlviewer.svg)
44

5-
The [Directed Graph Markup Language (dgml)](https://en.wikipedia.org/wiki/DGML) can be used to visualize things like processes, hierarchies flows and many other things.
5+
The [Directed Graph Markup Language (dgml)](https://en.wikipedia.org/wiki/DGML) can be used to visualize things like processes, hierarchies, flows and many other things.
66

77
This extension for Visual Studio Code can be used to render a *.dgml file into a graphical representation of the graph. Find it on the [Visual Studio Code marketplace](https://marketplace.visualstudio.com/items?itemName=coderAllan.vscode-dgmlviewer).
88

99
## Visualize DGML files
1010

11-
To visualize a dgml file i Visual Studio code you click on the file to open it, then you select the DGML Viewer command from the command pallette to render the graph into a graphical representation.
11+
To visualize a dgml file in Visual Studio Code you click on the file to open it, then you select the "DGMLViewer: Render the dgml graph" command from the command pallette to render the graph.
1212

13-
When the dgml file has been rendered you can save the representation into a PNG file.
13+
When the dgml file has been rendered you can save the representation as a PNG file.
1414

1515
![DGML save to Png file](https://github.com/CoderAllan/vscode-dgmlviewer/raw/main/images/dgmlViewer_save.gif)
1616

17-
You can also choose to only save a selected part of the graph.
18-
19-
You do this by clicking the 'Save selection as png' button, then right-click and drag to select the area you want to save. The selection is saved when you let go of the mouse button.
17+
You can also choose to only save part of the graph. You do this by clicking the 'Save selection as png' button, then right-click and drag to select the area you want to save. The selection is saved when you let go of the mouse button.
2018

2119
![DGML save selection to Png file](https://github.com/CoderAllan/vscode-dgmlviewer/raw/main/images/dgmlViewer_saveSelection.gif)
2220

2321
In a DirectedGraph file you can [link a node to an external file](https://docs.microsoft.com/en-us/previous-versions/visualstudio/visual-studio-2015/modeling/customize-code-maps-by-editing-the-dgml-files?view=vs-2015#to-link-a-document-or-url-to-a-code-element"). DGMLViewer will determine if the file is accessible on the disk and if it is then the node is clickable and will open the file in vscode when the node is clicked.
2422

2523
![DGML click on a node](https://github.com/CoderAllan/vscode-dgmlviewer/raw/main/images/dgmlViewer_clickOnNodes.gif)
2624

27-
By default if the DirectedGraph element of the dgml file has a GraphDirection attribute, then this value is used to layout the graph. But by clicking the 'Change layout' checkbox you can change the layout of the graph. It will not change the dgml file itself, it will only change the rendering of the file.
25+
You can change the rendered layout of the directed graph by clicking the 'Change layout' checkbox and the choose a layout in the dropdown box. It will not change the dgml file itself, it will only change the rendering of the graph.
2826

2927
![DGML change layout](https://github.com/CoderAllan/vscode-dgmlviewer/raw/main/images/dgmlViewer_changeLayout.gif)
3028

@@ -57,3 +55,7 @@ See the full list of settings below the screenshot.
5755
## Known Issues
5856

5957
The [Directed Graph Markup Language (dgml)](https://en.wikipedia.org/wiki/DGML) has the ability to specify conditional rendering of the graph. This is done by using the Style elements in the specification. In the current version of this DGMLViewer extension for Visual Studio code this conditional rendering is very limited. Only the 'HasCategory(...)' condition is evaluated.
58+
59+
## Third party components and resources
60+
61+
* [Cytoscape.js](https://js.cytoscape.org/) - Used for rendering the directed graph.

images/dgmlViewer_changeLayout.gif

1.58 MB
Loading

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"displayName": "DGMLViewer",
55
"description": "DGMLViewer is viewer for dgml (Directed Graph Markup Language) files",
66
"icon": "icon.png",
7-
"version": "1.3.4",
7+
"version": "2.0.0",
88
"repository": "https://github.com/CoderAllan/vscode-dgmlviewer",
99
"engines": {
1010
"vscode": "^1.59.0"
@@ -14,7 +14,9 @@
1414
"Visualization"
1515
],
1616
"keywords": [
17-
"dgml"
17+
"dgml",
18+
"graph",
19+
"visualization"
1820
],
1921
"activationEvents": [
2022
"onCommand:vscode-dgmlviewer.dgmlViewer",

0 commit comments

Comments
 (0)