G2 icon indicating copy to clipboard operation
G2 copied to clipboard

G2 4.x 文档问题统一反馈和吐槽

Open xiaobindebingo opened this issue 4 years ago • 39 comments

  • [ ] I have searched the issues of this repository and believe that this is not a duplicate.

Reproduction link

https://g2.antv.vision/zh/docs/manual/tutorial/event

Steps to reproduce

直接访问这个文档阅读就会发现很多错误

Environment Info
g2 4.0.14
System -
Browser -

期望能及时更新文档,让G2设计这么好的图表可视化工具社区快速繁荣起来,

xiaobindebingo avatar Jul 29 '20 08:07 xiaobindebingo

image 比如这里,这个对象上包括原型链上根本没有isShape这个属性或者方法

xiaobindebingo avatar Jul 29 '20 08:07 xiaobindebingo

顶一个

Sai0514 avatar Aug 19 '20 01:08 Sai0514

好多404

wangjiahan avatar Sep 01 '20 09:09 wangjiahan

文档问题确实很多,最近我们正在整治。这个 issue 作为统一的文档吐槽和反馈,置顶在 issue 中了。欢迎搭建监督吐槽。

hustcc avatar Sep 17 '20 02:09 hustcc

@所有人,4.x 文档重构中,目录大纲如下:https://www.yuque.com/antv/g2-docs/putwke

欢迎感兴趣贡献的同学来参入(如果有意向,随便挑,相信负责的同学会很愿意让出来的),也欢迎在 PR 阶段来 Code Review。

hustcc avatar Sep 18 '20 13:09 hustcc

内置组件使用,没有找到较为详细的内容,目前在使用sider上遇到了问题。不知道如何与当前chart下的view数据进行联动

bhabgs avatar Sep 22 '20 02:09 bhabgs

目前在使用sider上遇到了问题。不

组件部分,我们会出一个详细的配置手册和使用方式。你自己关系 slider 的使用问题,也可以单独一个 issue 提出,我们看看是 bug 还是优化,看看怎么解决。

hustcc avatar Sep 23 '20 01:09 hustcc

建议官方自己先过一遍文档,现在看着真的有点乱

jiankafei avatar Sep 24 '20 06:09 jiankafei

https://g2.antv.vision/zh/docs/manual/upgrade 《G2 4.0升级指南》 “具体配置属性详见 API”中的API链接失效404.

DarrenPei avatar Sep 29 '20 09:09 DarrenPei

geometry.state() 方法的说明中,对 StateOption 接口的描述与实际不符。 例如设置 active 状态的填充透明度,根据文档应写作 geometry.state({ active: { fillOpacity: 1 } });,而实际上需要写作 geometry.state({ active: { style: { fillOpacity: 1 } } });

SentretC avatar Oct 16 '20 08:10 SentretC

有没有对折线图上的折线命名的方法呢 ?

AlexTMing avatar Oct 19 '20 12:10 AlexTMing

有没有对折线图上的折线命名的方法呢 ?

给折线命名是什么意思?

hustcc avatar Oct 19 '20 13:10 hustcc

有没有对折线图上的折线命名的方法呢 ?

给折线命名是什么意思?

就是 比如我现在有一张折线图,上面有两条线 分别代表当前时间段的登录pv以及uv, 在每条折线的上自定义名称,有且仅显示一次(pv,uv),不是 legend ,不是每个点的数据,也不用在意最大值最小值,只是更直观的显示这条线是代表pv 或者 uv的。请问有支持嘛? 我找语雀还有文档都没看到

AlexTMing avatar Oct 20 '20 02:10 AlexTMing

有没有对折线图上的折线命名的方法呢 ?

给折线命名是什么意思?

就是 比如我现在有一张折线图,上面有两条线 分别代表当前时间段的登录pv以及uv, 在每条折线的上自定义名称,有且仅显示一次(pv,uv),不是 legend ,不是每个点的数据,也不用在意最大值最小值,只是更直观的显示这条线是代表pv 或者 uv的。请问有支持嘛? 我找语雀还有文档都没看到

chart.geometries 的顺序会和你创建的顺序(chart.line().xxx)保持一致

visiky avatar Oct 20 '20 02:10 visiky

自定义热力图背景 this.chart.annotation().image({src: '本地图片'}) 为什么图片显示不出来

fancy-cat avatar Oct 29 '20 07:10 fancy-cat

自定义热力图背景 this.chart.annotation().image({src: '本地图片'}) 为什么图片显示不出来

如果不是文档问题,可以新开 issue。这个问题应该就是不能使用本地图片,存在跨域问题。使用 url 的方式。

hustcc avatar Oct 29 '20 07:10 hustcc

自定义热力图背景 this.chart.annotation().image({src: '本地图片'}) 为什么图片显示不出来

如果不是文档问题,可以新开 issue。这个问题应该就是不能使用本地图片,存在跨域问题。使用 url 的方式。

好的 我新开一个

fancy-cat avatar Oct 29 '20 08:10 fancy-cat

G2 主题配置项详解

主题配置项中关于 Tooltip 的部分,只说了开放哪些配置,却没有说怎么配置,看了有些无从下手。

作为对比,同一个页面下,文档的其它部分,都有介绍每个属性名与描述的表格。(其实有表格的那些也不是特别清晰,建议每个部分有对应的示例,会减少很多歧义)

--- 更新 ---

在源码里找到了对应的配置,src/util/theme.ts 建议在文档里加上这个链接。

zmen avatar Nov 02 '20 07:11 zmen

safari 文档页展示有问题 Screen Shot 2020-11-06 at 15 29 20

safari Version 13.1.1 (15609.2.9.1.2)

ymh1028 avatar Nov 06 '20 07:11 ymh1028

主题自定义文档,不够清晰。

hustcc avatar Nov 09 '20 10:11 hustcc

https://antv-g2.gitee.io/en/docs/api/general/legend 我想设置 图例项 宽度,但是没有找到可以用的 api, itemWidthmaxWidth 都不太有用。

直到在代码提示中,发现一个 maxItemWidth ,测试结果证明,是可以设置 图例项 宽度的,但是文档中并没有

xianshenglu avatar Nov 18 '20 09:11 xianshenglu

animate easing delay duration 的回调参数有问题 https://g2.antv.vision/zh/docs/api/general/animate 这里说是:

/**
 * @param  {Number} index      shape 的索引值
 * @param  {Number} id shape 的 id 标识
 **/

https://www.yuque.com/antv/g2-docs/geometry#animate 到了这里回调的参数变成了: (data) => number;

lswl66 avatar Nov 19 '20 06:11 lswl66

关于chart state 配置问题

今天开发chart 遇到一个问题 就是点击chart 上面某一块的时候,给对应的 块加上label, 看到文档已有 state => selected 也就是当某一项被点击选中后。 我就想这块应该能配置了把,但是看到里面就一个style属性,style也行我寻思就是按照ShapeAttrs(需求可能不满足),但是仔细看了下还不是单纯的ShapeAttrs,我以为有戏了吧,赶紧看看都是什么类型。结果进到源码一看 类型很草率的给了一个 通用对象 image

通用对象也行,我想文档总会写清楚 都有哪些配置把。结果还是我草率了,那个有大神知道有什么方法能满足我的需求吗🥺。

源码地址

bhabgs avatar Nov 19 '20 08:11 bhabgs

本周更新了新的文档?现在 chart 实例的API被去掉了,类似 filter,createView 等都看不到。

maplor avatar Nov 27 '20 02:11 maplor

各位大佬想问一下,4.0版本 chart.line().select() 还可以使用吗? 在使用的过程中发现报错了,若是不能使用了,麻烦问一下,怎么修改选中态折线的样式呢?感谢

muyuanshan avatar Dec 03 '20 11:12 muyuanshan

草率了

CoolHenry avatar Dec 04 '20 03:12 CoolHenry

各位大佬想问一下,4.0版本 chart.line().select() 还可以使用吗? 在使用的过程中发现报错了,若是不能使用了,麻烦问一下,怎么修改选中态折线的样式呢?感谢

4.x 状态需要在 Element 上设置, line.elements.forEach(elem => elem.setState('selected', true))

lessmost avatar Dec 08 '20 07:12 lessmost

自定义交互部分:https://g2.antv.vision/zh/docs/api/advanced/registerinteraction { trigger: 'eventName', action: 'actionName:method' | [] | function(context) {}, isEnable(context) {}, // 可选 callback(context) {}, // 可选 once: false // 可选,默认 false } action 中说可以用 function定义, 但是我将context的cfg更改为想要的配置项并无任何动画, 是我写错了ma ? 以下是我写的: action: (context) => { let listActive = context.actions[1]; let ElementActive = context.actions[2];

      listActive.cfg = {
        lineWidth: 2,
      } 

      ElementActive.cfg = {
        strokeOpacity: 0,
      } 
      context.actions[1] = listActive;
      context.actions[2] = ElementActive;
    },

YangGuoXuan-0503 avatar Dec 12 '20 03:12 YangGuoXuan-0503

geometries 的通用方法现在在文档里找不到了

tinymoo avatar Dec 15 '20 13:12 tinymoo

调整 - Adjust 应该放到 geometry 下面吧?后续还有其他部署? 属性间的层级关系应该清晰一些,如果不注意就可能搞半天乌龙

// 下面两行代码应该是完全不一样的吧?
chart.adjust()
gemetry.adjust() 

https://antv-g2.gitee.io/zh/docs/api/general/adjust

alphabetabc avatar Dec 17 '20 04:12 alphabetabc