Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: component-axis 文档改造 #6644

Open
wants to merge 1 commit into
base: v5
Choose a base branch
from

Conversation

louhaojie99
Copy link
Collaborator

@louhaojie99 louhaojie99 commented Mar 12, 2025

变更点:

  1. 文档结构
  2. 构成元素示例图
  3. Items 配置项总览表格
  4. Item 配置项使用代码示例
  5. 坐标轴(Axis)里原有的必有全面的示例代码写在了图表示例中。

图表组件(坐标轴)效果图:

Kapture 2025-03-14 at 14 11 53

图表示例(坐标轴)效果图:
image
image

Copy link

Walkthrough

本次 PR 对 component-axis 文档进行了全面改造,增加了概述、构成元素、使用方式等部分,并提供了详细的配置项说明和示例代码,旨在提升文档的可读性和实用性。

Changes

文件 概要
site/docs/manual/component/axis.zh.md 对文档进行了全面改造,增加了概述、构成元素、使用方式等部分,提供了详细的配置项说明和示例代码。


坐标轴可以在 Mark 层级配置。在 G2 中每个标记(Mark)都有自己的坐标轴。如果标记对应比例尺是同步的,那么坐标轴也会合并。

```js
```ts

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change from JavaScript to TypeScript in code examples is significant. Ensure that all examples are correctly updated to TypeScript syntax to prevent any potential errors for users following these examples.


### 构成元素

![axis](https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*DnhUSZbue48AAAAAAAAAAAAAemJ7AQ/fmt.avif)
Copy link
Collaborator Author

@louhaojie99 louhaojie99 Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这张图来源于G2Plot - 坐标轴 - Axis 做了修改上传到对应图床中。

image

@coveralls
Copy link

coveralls commented Mar 12, 2025

Pull Request Test Coverage Report for Build 13851003714

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 86.69%

Totals Coverage Status
Change from base Build 13825883006: 0.0%
Covered Lines: 10617
Relevant Lines: 11872

💛 - Coveralls

@louhaojie99 louhaojie99 force-pushed the update-component-axis-doc branch from 5d47ddd to 937a13a Compare March 14, 2025 06:06
@louhaojie99 louhaojie99 force-pushed the update-component-axis-doc branch from 937a13a to f3e631f Compare March 14, 2025 06:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants