Skip to content

delete hightlight and downplay doc#279

Closed
gitforhlp wants to merge 8 commits intoapache:masterfrom
gitforhlp:master
Closed

delete hightlight and downplay doc#279
gitforhlp wants to merge 8 commits intoapache:masterfrom
gitforhlp:master

Conversation

@gitforhlp
Copy link
Contributor


**Attention: ** The `?:` note in the code shows that this attribute is optional. *EVENT:* stands for the event that triggers action.

## highlight(Action)
Copy link
Member

Choose a reason for hiding this comment

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

We shouldn't remove them as they are still working for other series or components.

The v5 upgrade guide indicates that the highlight action & downplay action in the sunburst series are deprecated but not in all series.

Perhaps we should add new actions for sunburstHighlight & sunburstUnhighlight.

@plainheart plainheart requested review from Ovilia and pissang August 3, 2022 08:43
@Ovilia
Copy link
Contributor

Ovilia commented Aug 24, 2022

@pissang Please help review this PR.

@pissang
Copy link
Contributor

pissang commented Aug 29, 2022

As @plainheart said, this change is only scoped to the sunburst series, it should be mentioned in the note

@pissang
Copy link
Contributor

pissang commented Aug 29, 2022

I was confused because highlight is new introduced since 5.0 and it should not be deprecated. So I just did some search in the code and it seems the warning log is wrong in https://github.com/apache/echarts/blob/master/src/chart/sunburst/sunburstAction.ts#L90

It should be.

deprecateReplaceLog('sunburstHighlight', 'highlight');

So we should change this warning log instead of changing the doc

@gitforhlp
Copy link
Contributor Author

It is stated in the V5 upgrade document that this is discarded in the sunrise chart,please check again
https://echarts.apache.org/handbook/zh/basics/release-note/v5-upgrade-guide#%E4%B8%8D%E5%86%8D%E6%8E%A8%E8%8D%90%E4%BD%BF%E7%94%A8%E7%9A%84-api

旭日图(sunburst):
动作类型 highlight 已被弃用,请使用 sunburstHighlight 代替。
动作类型 downplay 已被弃用,请使用 sunburstUnhighlight 代替。
选项 series.downplay 已被弃用,请使用 series.blur 代替。
选项 series.highlightPolicy 已不适用,请使用 series.emphasis.focus 代替。

@Ovilia
Copy link
Contributor

Ovilia commented Aug 29, 2022

apache/echarts#17587 is following the right track. I think there should be no document changing required so I'm going to close this PR. Thanks for the help!

@Ovilia Ovilia closed this Aug 29, 2022
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.

在 echarts 5 的升级报告中已经明确说明 aciton: hightlight and downplay 已经弃用。但是在文档的 API 中的描述依旧没有变化

5 participants