Skip to content

Commit a3a8f4d

Browse files
Jacqui1031Woodii1998heqiyujingzFredzengfafa
authored
Feature/new layout (#339)
* feat: add message schema * 根据本次可视化布局的优化,整体更新了布局这篇 docs 文档 * 更新 layout 英文版 * release v25.42.0 (#345) * feat: update catalogue (#286) * Add Translations for Custom Panels and some broken links fix (#288) * feat: add dev script to package.json and update links in documentation - Added a new "dev" script to package.json for easier local development. - Updated links in the device collector and data diagnosis documentation for better navigation. - Ensured consistent formatting in the device collector documentation. * Fix absolute links in cn changelog * create project broken link * add translations * translate message converters * translate topic aliases * translate other docs * fix a couple files that did not translate to english * Add more translations * Fix/broken links (#289) * before fixing the markdown references * fix broken links * New user-case: online-simulation-test (#291) * New user-case: online-simulation-test * new quick-start * resolve the conversation comments * resolve the comments * fix format problem * fix picture * fix problem of picture format * fix a couple formatting and remove some unnecessary words * formatting --------- Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> * Data Record Solution (#293) Co-authored-by: 曾擎禹 <[email protected]> * renaming for beterr linuix support * Update embodied intelligence data collection solution documentation and enhance home catalogue with new links * Heterogeneous Robot Data Factory Docs 1.0 (#296) * offical-version1.0 of data collection * Add files via upload * Add files via upload * Add files via upload * Update 5-embodied-intelligence-data-collection-solution.md * fix links --------- Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: xiranyu <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> * Better Links (#297) * safely upgrade deps * improve device admission htmr anchor * Add temporary en translations * update links * ci * Faster Builds (#298) * update changelog * fix changelog # Conflicts: # src/pages/changelog.md * updated changelog,device,rules (#299) * updated changelog,device,rules * fix link * fix changelog * fix link --------- Co-authored-by: Qi He <[email protected]> * enable device and homepage catalogue (#301) * enable device * update catalogue * 新增设备采集器文档中的模板语法使用部分,详细介绍了模板语法的概述、基本语法、支持的变量及时间格式化选项,提升了文档的可读性和实用性。 (#303) * Add simulation translation (#305) * Doc: update device config info (#308) * Release 25.26.0 (#306) * feat: update catalogue (#286) * Add Translations for Custom Panels and some broken links fix (#288) * feat: add dev script to package.json and update links in documentation - Added a new "dev" script to package.json for easier local development. - Updated links in the device collector and data diagnosis documentation for better navigation. - Ensured consistent formatting in the device collector documentation. * Fix absolute links in cn changelog * create project broken link * add translations * translate message converters * translate topic aliases * translate other docs * fix a couple files that did not translate to english * Add more translations * Fix/broken links (#289) * before fixing the markdown references * fix broken links * New user-case: online-simulation-test (#291) * New user-case: online-simulation-test * new quick-start * resolve the conversation comments * resolve the comments * fix format problem * fix picture * fix problem of picture format * fix a couple formatting and remove some unnecessary words * formatting --------- Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> * Data Record Solution (#293) Co-authored-by: 曾擎禹 <[email protected]> * renaming for beterr linuix support * Update embodied intelligence data collection solution documentation and enhance home catalogue with new links * Heterogeneous Robot Data Factory Docs 1.0 (#296) * offical-version1.0 of data collection * Add files via upload * Add files via upload * Add files via upload * Update 5-embodied-intelligence-data-collection-solution.md * fix links --------- Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: xiranyu <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> * Better Links (#297) * safely upgrade deps * improve device admission htmr anchor * Add temporary en translations * update links * ci * Faster Builds (#298) * update changelog * fix changelog # Conflicts: # src/pages/changelog.md * updated changelog,device,rules (#299) * updated changelog,device,rules * fix link * fix changelog * fix link --------- Co-authored-by: Qi He <[email protected]> * enable device and homepage catalogue (#301) * enable device * update catalogue * 新增设备采集器文档中的模板语法使用部分,详细介绍了模板语法的概述、基本语法、支持的变量及时间格式化选项,提升了文档的可读性和实用性。 (#303) * Add simulation translation (#305) --------- Co-authored-by: Woodii <[email protected]> Co-authored-by: Fredzengfafa <[email protected]> Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: xiranyu <[email protected]> Co-authored-by: Qi He <[email protected]> Co-authored-by: Qi He <[email protected]> * doc: update device config info --------- Co-authored-by: Yujing Zheng <[email protected]> Co-authored-by: Woodii <[email protected]> Co-authored-by: Fredzengfafa <[email protected]> Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: xiranyu <[email protected]> Co-authored-by: Qi He <[email protected]> Co-authored-by: Qi He <[email protected]> * Feat/project resource (#307) * Feat/add token runtime info (#313) * add titles to terms of services * add info about costoken * remove dup * add view client information hashtag (#315) * colistener collect (#312) * coListener collect * Update 5-device-collect.md * Update 5-device-collect.md * fix link --------- Co-authored-by: xiranyu <[email protected]> * Changelog (#316) * Update changelog.md * Update changelog.md * fix anchor * update docs link --------- Co-authored-by: Yujing Zheng <[email protected]> * Update coCLI latest changes (#319) * cocli is now out of beta * finish the cocli install page refresh * add basic docs for record ops * view and describe records * finish labels docs * add files operations * emphise the help * cleanup * Add moments related operations * update english version as well * remove unnecessary category json * Remove aseets we dont need anymore * Create records by convention in Action (#321) * complete action runtime docs info * update english version as well * feat: add cocli category * updated devcie & collect & some pages (#323) * update catalogue; uninstall device command (#324) * update uninstall device command * update catalogue * 25.31 changelog (#325) * 25.31 changelog * 25.31 changelog 2 * fix link --------- Co-authored-by: Qi He <[email protected]> * Update: Open API link in docusaurus.config.js to fix to new S3 storage address. (#328) * Feat/data collection (#331) * Add files via upload * Update 5-device-collect.md * Add files via upload * Update 5-device-collect.md * Update 3-add-rule.md * Update 3-add-rule.md * Add files via upload * Update 1-quick-start.md * Add files via upload * Update 1-quick-start.md * Update 3-add-rule.md * Update 3-add-rule.md * fix add rule variable * Update 3-add-rule.md * Update 3-add-rule.md --------- Co-authored-by: Qi He <[email protected]> * Feat/changelog (#332) * Update changelog.md * Update changelog.md * add information of service definition. (#318) * add information of service definition. * nit --------- Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: fei.gao <[email protected]> * fix: openapi url (#336) * Updated the changelog, S3, raw message panel, visual timeline, and permission-related features. (#338) * add user script (#340) * changelog (#344) --------- Co-authored-by: Woodii <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> Co-authored-by: Fredzengfafa <[email protected]> Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> Co-authored-by: xiranyu <[email protected]> Co-authored-by: angryPopcorn <[email protected]> Co-authored-by: fei.gao <[email protected]> * 10-20更新 layout 中英文文档,包括图片、文本描述的微调 * 10-20更新 layout 中英文文档,包括图片、文本描述的微调 --------- Co-authored-by: Woodii <[email protected]> Co-authored-by: Qi He <[email protected]> Co-authored-by: Woodii <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> Co-authored-by: Fredzengfafa <[email protected]> Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> Co-authored-by: xiranyu <[email protected]> Co-authored-by: angryPopcorn <[email protected]> Co-authored-by: fei.gao <[email protected]>
1 parent eec3173 commit a3a8f4d

File tree

21 files changed

+99
-88
lines changed

21 files changed

+99
-88
lines changed

docs/viz/3-layout.md

Lines changed: 46 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -4,93 +4,94 @@ sidebar_position: 3
44

55
# 布局
66

7-
「布局」是可视化界面中安排元素的方式,可与项目和组织成员共享
7+
「布局」是可视化界面中安排元素的方式。它可与项目成员共享,有助于将设备数据以直观的可视化方式呈现,助力用户高效查看与分析各类多模态数据
88

99
## 创建布局
1010

11-
点击【布局菜单栏】,可通过以下方式创建布局:【创建空白布局】、【复制现有布局】或【从文件导入布局】。
11+
点击可视化界面右上角的【布局】进入布局管理页,可通过以下方式创建布局:【创建空白布局】、【从其他项目复制布局】或【本地文件导入】。
1212

1313
![viz-8-1.png](./img/viz-8-1.png)
14-
15-
### 创建空白布局
16-
17-
在布局菜单栏点击【创建空白布局】按钮进入以下页面,选择一个需要的面板:
18-
1914
![viz-8-2.png](./img/viz-8-2.png)
2015

21-
### 复制布局创建
16+
### 创建空白布局
2217

23-
1. 对于组织中已有的布局,可右键点击并选择弹出菜单栏中的【创建个人副本】,将该布局添加到个人布局中。
18+
填入新的布局名称、类型(个人布局或项目布局),以及用于存储布局的可选文件夹
2419

25-
![viz-8-3.png](./img/viz-8-3.png)
20+
![viz-8-3.png](./img/viz-8-3.png)
2621

27-
2. 同样地,右键点击个人布局中的复制选项,可创建该布局的副本
22+
确定后,进入新布局配置页,您可从页面中直接选择感兴趣的面板,或点击右上角的添加面板按钮选择更多面板
2823

29-
![viz-8-4.png](./img/viz-8-4.png)
24+
![viz-8-4.png](./img/viz-8-4.png)
3025

31-
### 导入布局
26+
:::info
27+
🤖 要想在一个布局中使用较多的面板,请使用 **选项卡** 面板功能。按住 Shift 并点击多个面板并选择“按选项卡分组”,即可立即组织它们,无需手动拖动。
28+
:::
3229

33-
通过布局菜单栏中的【从文件导入】可将本地的布局文件导入到个人的布局中。
30+
- 在配置完成后,可点击顶部的【保存】按钮,将布局永久保存;
31+
- 若未点击保存更改,将会存储在当前浏览器的缓存中,以便于下次可视化数据使用;
32+
- 点击【撤销】按钮,布局将恢复到上一次的存储状态。
3433

3534
![viz-8-5.png](./img/viz-8-5.png)
3635

37-
## 推荐布局
3836

39-
「推荐布局」是一种预先设定并建议使用的布局类型,它包括「组织推荐布局」和「项目推荐布局」。
37+
### 从其他项目复制布局
4038

41-
### 组织推荐
42-
> 仅组织管理员可设置
39+
通过复制已有项目的布局,您可以快速获取一个基础的、符合部分需求的布局框架,然后在此基础上进行修改和调整,大大节省了布局设计的时间,提升工作效率。
4340

44-
新建的项目会自动将「组织推荐布局」作为「项目推荐布局」,当项目成员播放记录时,若无可用布局,会默认使用项目布局。
41+
![viz-8-6.png](./img/viz-8-6.png)
4542

46-
可进入头像菜单栏的【组织管理】中的【可视化布局配置】,选择本组织推荐使用的布局。
43+
### 本地文件导入
4744

48-
![viz-8-6.png](./img/viz-8-6.png)
45+
通过本地文件导入可从当前电脑的文件系统中选择一个布局 json 文件导入。
4946

50-
### 项目推荐
51-
> 仅项目管理员及以上角色可设置
47+
![viz-8-7.png](./img/viz-8-7.png)
5248

53-
当项目成员播放记录时,若无可用布局,会默认使用项目布局。
49+
## 布局使用场景
5450

55-
可进入【项目设置】中的【可视化布局配置】,选择本项目推荐使用的布局。
51+
### 个人布局
5652

57-
![viz-8-7.png](./img/viz-8-7.png)
53+
个人布局只有您可以访问 - 其他任何人都无法查看、加载或编辑。
5854

59-
### 记录推荐
55+
您的个人布局的更改将同步到您的所有电脑,并可复制为项目布局以共享使用。
6056

61-
「记录推荐布局」是记录的默认布局,任意用户播放此记录,都会使用该布局。
57+
### 项目布局
6258

63-
在可视化页面中的【布局菜单栏】,右键点击需设置的布局,点击「复制为记录默认布局」
59+
项目布局提供了团队整理一组规范的布局来完成项目内常见的可视化数据方式
6460

65-
![viz-8-9.png](./img/viz-8-10.png)
61+
当项目公开时,项目布局也将一并公开,以供游客浏览可视化数据时可使用合适的布局。
6662

67-
如图示,布局 “NuScenes” 就被成功地设置成为了记录推荐布局。
63+
## 布局的管理
6864

69-
![viz-8-10.png](./img/viz-8-9.png)
65+
可以直接从左侧浏览布局文件夹,它们分为:所有、个人、项目。
7066

71-
### 布局优先级
72-
对于同时设置了三种推荐布局的记录而言,「记录推荐布局」的优先级大于「项目推荐布局」大于「组织推荐布局」。
67+
![viz-8-8.png](./img/viz-8-8.png)
7368

74-
## 管理布局
69+
### 使用布局
7570

76-
点击布局名称右侧的【操作】图标,可对布局进行管理,如:保存更改、撤销更改、重命名、复制、共享、导出、删除等。
71+
在管理布局中,找到想要使用的布局,点击布局名称,即可切换为对应布局
7772

78-
![viz-8-11](./img/viz-8-11.png)
73+
![viz-8-9.png](./img/viz-8-9.png)
7974

80-
### 重命名布局
75+
:::info
76+
🤖 系统会记住您上次在**当前项目中使用的布局**,下次执行可视化操作时,将默认使用上次的布局。
77+
:::
8178

79+
### 重命名布局
8280
修改布局的名称以便更好地识别和分类。
8381

84-
### 导出布局
82+
### 复制布局
83+
将布局复制为个人 / 当前项目布局。
8584

86-
将布局保存为文件,以便共享或在其他环境中使用。
85+
### 移动布局
86+
将布局移动到当前分类(个人/项目)下的其他文件夹中。
8787

88-
### 分享布局
89-
90-
将布局与团队共享,使组织成员能够使用和更改分享的布局副本
88+
### 导出布局
89+
将布局导出为 json 文件,以便分享或在其他环境中使用。
9190

9291
### 删除布局
93-
94-
移除不再需要的布局,保持布局列表的整洁和高效
92+
删除不再需要的布局,保持布局列表的整洁和高效。
93+
:::info
94+
🤖 若是删除项目布局,可访问此项目的用户(项目管理员、项目成员、项目只读成员、公开项目的游客)将无法使用此布局。
95+
:::
9596

9697
---

docs/viz/9-message-schemas/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,4 +84,4 @@ import { Point2 } from "@foxglove/schemas";
8484
const myPoint: Point2 = { x: 1, y: 2 };
8585
```
8686

87-
在处理 JavaScript WebSocket 或 MCAP 项目,或在 coScene 的用户脚本面板中编写自定义数据转换脚本时,请导入这些类型。
87+
在处理 JavaScript WebSocket 或 MCAP 项目,或在 coScene 的用户脚本面板中编写自定义数据转换脚本时,请导入这些类型。

docs/viz/img/viz-8-1.png

62.4 KB
Loading

docs/viz/img/viz-8-2.png

-123 KB
Loading

docs/viz/img/viz-8-3.png

-367 KB
Loading

docs/viz/img/viz-8-4.png

311 KB
Loading

docs/viz/img/viz-8-5.png

-435 KB
Loading

docs/viz/img/viz-8-6.png

2.97 KB
Loading

docs/viz/img/viz-8-7.png

-37.1 KB
Loading

docs/viz/img/viz-8-8.png

321 KB
Loading

0 commit comments

Comments
 (0)