docs(Diagram): Add Diagram component documentation #3089
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yordan-mitev
approved these changes
Jul 9, 2025
|
|
||
| The Layered Diagram layout has the following sub types: | ||
|
|
||
| * `Down`—the root shape is at the top and all descendants are arranged below it |
There was a problem hiding this comment.
End all list items with a full stop as at least one of them is a complete sentence.
Suggested change
| * `Down`—the root shape is at the top and all descendants are arranged below it | |
| * `Down`—the root shape is at the top and all descendants are arranged below it. |
|
|
||
| * Distance between linked shapes | ||
| * Connection lengths | ||
| * Crossings between layers of shapes. |
There was a problem hiding this comment.
None of the list items is a complete sentence, so skip the end punctuation here.
Suggested change
| * Crossings between layers of shapes. | |
| * Crossings between layers of shapes |
|
|
||
| * `Circle`—you can use different `Width` and `Height` values to define an ellipse. | ||
| * `Image`—all shape types support text labels, but only the `Image` shape can display a graphic. Use the `<DiagramShape>` `Source` parameter to define the image URL or data URI. | ||
| * `Rectangle` (default) |
There was a problem hiding this comment.
Suggested change
| * `Rectangle` (default) | |
| * `Rectangle` (default). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some more API links will be added later.