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: 完善 ViewMeta 和 CellData 文档 close #2845 #2868

Merged
merged 1 commit into from
Aug 23, 2024
Merged

Conversation

lijinke666
Copy link
Member

@lijinke666 lijinke666 commented Aug 19, 2024

👀 PR includes

🔧 Chore

  • Test case
  • Docs / demos update
  • CI / workflow
  • Release version
  • Other ()

📝 Description

  1. 抽取 ViewMeta 的公共文档
  2. 增加 CellData 的更新说明和 API 文档

🖼️ Screenshot

Before After

🔗 Related issue link

close #2845

🔍 Self-Check before the merge

  • Add or update relevant docs.
  • Add or update relevant demos.
  • Add or update test case.
  • Add or update relevant TypeScript definitions.

Copy link

vercel bot commented Aug 19, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
antvis-s2 ❌ Failed (Inspect) Aug 19, 2024 9:02am

Copy link
Contributor

Size Change: -18 B (-0.01%)

Total Size: 329 kB

Filename Size Change
./packages/s2-core/dist/index.min.js 229 kB -18 B (-0.01%)
ℹ️ View Unchanged
Filename Size
./packages/s2-core/dist/style.min.css 388 B
./packages/s2-react/dist/index.min.js 70.8 kB
./packages/s2-react/dist/style.min.css 3.88 kB
./packages/s2-vue/dist/index.min.js 22.9 kB
./packages/s2-vue/dist/style.min.css 1.97 kB

compressed-size-action

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.75%. Comparing base (ecdc9c8) to head (d881be0).
Report is 423 commits behind head on next.

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #2868      +/-   ##
==========================================
+ Coverage   75.77%   80.75%   +4.97%     
==========================================
  Files         257      180      -77     
  Lines       11994    10400    -1594     
  Branches     2464     2359     -105     
==========================================
- Hits         9088     8398     -690     
+ Misses       1398      556     -842     
+ Partials     1508     1446      -62     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

const onlyShowCellText = this.spreadsheet.isTableMode();
const cellData = onlyShowCellText
? ({
...(currentCellMeta as ViewMetaData),
value: value || fieldValue,
Copy link
Member Author

Choose a reason for hiding this comment

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

dataCell 的 meta 中没有 valuevalueField, 是类型错误

@@ -37,68 +37,6 @@ s2.dataSet.getFieldName('type')
| displayFormattedValueMap | 单元格所对应格式化后的值(用于编辑表) | `Map<string, string>` | |
| getValueRangeByField | 获取数值最大最小值区间 | `(field: string) => { minValue: number, maxValue: number }` | |

### SimpleData
Copy link
Member Author

@lijinke666 lijinke666 Aug 19, 2024

Choose a reason for hiding this comment

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

移到了 view-meta.md 中

image

@@ -28,72 +28,6 @@ const s2DataConfig = {
| sortParams | 排序参数配置 | [SortParam](#sortparam)[] | | |
| filterParams | 筛选参数配置 | [FilterParam](#filterparam)[] | | |

### RawData
Copy link
Member Author

Choose a reason for hiding this comment

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

同上

@lijinke666 lijinke666 merged commit e05bb56 into next Aug 23, 2024
14 of 15 checks passed
@lijinke666 lijinke666 deleted the docs-2844 branch August 23, 2024 08:31
@lijinke666
Copy link
Member Author

🎉 This PR is included in version @antv/s2-v2.0.0-next.27 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
next 2.0-next 版本的问题 pr(documentation) documentation released on @next
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🤔 自定义单元格时遇到的问题 ViewMeta.data 和1.x数据不一致,文档描述也没变
2 participants