docs: improve documentation for element/edge configuration #6861
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
WalkthroughThis pull request focuses on improving the documentation related to the configuration of elements and edges in the G6 library. It includes updates to various markdown files to enhance clarity and provide examples for better understanding. Changes
|
WalkthroughThis pull request focuses on improving the documentation related to the configuration of elements and edges in the G6 library. It includes updates to various markdown files to enhance clarity and provide examples for better understanding. Changes
🪧 TipsFor further assistance, please describe your question in the comments and @petercat-assistant to start a conversation with me. |
WalkthroughThis pull request focuses on improving the documentation related to the configuration of elements and edges in the G6 library. It includes updates to various markdown files to enhance clarity and provide examples for better understanding. Changes
|
WalkthroughThis pull request focuses on improving the documentation for element and edge configurations in the G6 library. It includes updates to various markdown files, enhancing the descriptions, examples, and style configurations for different edge types such as cubic, cubic-horizontal, cubic-vertical, line, polyline, and quadratic edges. The changes aim to provide clearer guidance and examples for users to better understand and implement these configurations in their projects. Changes
|
hustcc
changed the title
WalkthroughThis pull request focuses on improving the documentation for element and edge configurations in the G6 library. It includes updates to various markdown files to enhance clarity and provide examples for better understanding. Changes
|
![petercat-assistant[bot]](https://avatars.githubusercontent.com/in/875736?s=60&v=4){kind=small}
| | ----------------- | ---------------------------------------------------- | ---------------------------------------------------- | -------------------- | | ||
| | halo | 边光晕是否显示 | boolean | false | | ||
| | haloClass | 边光晕className | string | - | | ||
| | haloCursor | 边光晕鼠标移入样式，[配置项](#cursor) | strig | `default` | |
There was a problem hiding this comment.
There is a typo in the type definition for haloCursor. It should be string instead of strig. Please correct this to avoid potential issues.
yvonneyx
reviewed
Mar 13, 2025
| | filter | 边的阴影的滤镜效果 | string | - | | ||
| | increasedLineWidthForHitTesting | 边的宽度过小时，可以用来增大交互区域 | string | number | - | | ||
| | isBillboard | 3D 场景中生效，始终朝向屏幕，因此线宽不受透视投影影像 | true | boolean | | ||
| | lineDash | 虚线边的偏移量 | 0 | number | |
There was a problem hiding this comment.
lineDash 的描述形容的是 lineDashOffset？
| | badgeBackgroundStroke | 边徽标背景描边颜色 | string | - | | ||
| | badgeBackgroundStrokeOpacity | 边徽标背景描边透明度 | number | string | 1 | | ||
| | badgeBackgroundVisibility | 边徽标背景是否可见 | `visible` | `hidden` | - | | ||
| | badgeBackgroundZIndex | 边徽标背景渲染层级 | number | - | |
yvonneyx
approved these changes
Mar 13, 2025
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.
improve documentation/element/edge configuration