Skip to content

Commit e1e2606

Browse files
committed
Updated the Readme file.
1 parent 0744437 commit e1e2606

File tree

4 files changed

+27
-0
lines changed

4 files changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,33 @@ This command will analyse all Angular components in the project and collect all
6363

6464
![List all imports](https://github.com/CoderAllan/vscode-angulartools/raw/main/images/ListAllImports.gif)
6565

66+
## Settings
67+
68+
In the Visual Studio Code settings you find under File --> Preferences --> Settings, under Extensions, there is a section with all the settings for AngularTools. It is possible to change the default filenames used when the extension saves a file to the workspace folder. You can change how the component hierarchy graph nodes are rendered, the edge endings, the color of the root nodes and a lot more.
69+
70+
See the full list of settings below the screenshot.
71+
72+
![AngularTools settings](https://github.com/CoderAllan/vscode-angulartools/raw/main/images/Settings.gif)
73+
74+
| Setting | Description |
75+
| --- | --- |
76+
| angularTools.excludeDirectories | Semicolon separated list of directories that should be excluded when scanning for for Angular components. |
77+
| angularTools.componentHierarchyDgml.defaultGraphFilename | The default filename used when saving a component hierarchy to a Directed Graph Markup Language (Dgml) file. |
78+
| angularTools.componentHierarchyDgml.graphLayout | This is the algorithm used to layout the nodes of the graph. Sugiyama wil try to avoid crossing edges as far as possible. ForceDirected will try to cluster the nodes. |
79+
| angularTools.componentHierarchyDgml.graphDirection | This will make the layout algorithm position the graph nodes in the specified direction. |
80+
| angularTools.componentHierarchyDgml.rootNodeBackgroundColor | The color of the root nodes of the directed graph. The string should be in rgba format. |
81+
| angularTools.packageJsonMarkdownFilename | The default filename used when saving the packages.json as a markdown file. |
82+
| angularTools.projectDirectoryStructureMarkdownFilename | The default filename used when saving the project directory structure as a markdown file. |
83+
| angularTools.showComponentHierarchy.rootNodeBackgroundColor | The color of the root nodes of the component hierarchy graph. The string should be in rgba format or standard css color names. |
84+
| angularTools.showComponentHierarchy.edgeArrowToType | The default ending of the edges. |
85+
| angularTools.showComponentHierarchy.nodeShape | The shape of the nodes in the component hierarchy graph. Notice that 'ellipse','circle','database','box' and 'text' have the label inside the shape, the rest have the label outside the shape. |
86+
| angularTools.showComponentHierarchy.graphSelectionGuidelineColor | blue | The color of the guidelines used when selecting part of a component hierarchy graph. The string should be in rgba format or standard css color names. |
87+
| angularTools.showComponentHierarchy.graphSelectionGuidelineWidth | 1 | The width of the guide lines shown when selecting part of a component hierarchy graph |
88+
| angularTools.showComponentHierarchy.graphSelectionColor | red | The color of the selection rectangle used when selecting part of a component hierarchy graph. The string should be in rgba format or standard css color names. |
89+
| angularTools.showComponentHierarchy.graphSelectionWidth | 2 | The width of the selection rectangle shown when selecting part of a component hierarchy graph |
90+
| angularTools.showComponentHierarchy.componentHierarchyFilename | ComponentHierarchy.png | The default name used when saving the component hierarchy to a Png file. |
91+
| angularTools.componentHierarchyMarkdownFilename | The default name used when saving the component hierarchy to a markdown file. |
92+
6693
## Third party components and resources
6794

6895
* [Vis.js](https://visjs.org/index.html) - Used for generating the directed graph for showing the component hierarchy.

images/Settings.gif

1.57 MB
Loading

images/ShowComponentHierarchy.gif

231 KB
Loading

images/ShowComponentHierarchy2.gif

728 KB
Loading

0 commit comments

Comments
 (0)