fix(type): add overflow property to AxisLabelBaseOption interface. close #17363

[breizh24]

Co-authored-by: Giulio Mazzanti [email protected]

Brief Information

This pull request is in the type of:

• bug fixing
• new feature
• others

What does this PR do?

This PR sets the correct interface that AxisLabelBaseOption extends, changing it from TextCommonOption to LabelOption.

This PR adds the overflow property to the AxisLabelBaseOption interface.

Fixed issues

• [Bug] echarts xAxis.axisLabel 配置, 缺少官方文档描述的 overflow 属性. #17363 : ...

Details

Before: What was the problem?

The overflow property on xAxis.axisLabel works fine as you can see from this demo: Chart demo

The actual issue is with the type of xAxis.axisLabel (AxisLabelBaseOption) that is extending TextCommonOption insted of LabelOption which is already extending TextCommonOption which is missing the overflow property, resulting in a type error if We try to use that property in a typescript file.

If We look at the documentation We can see that the overflow property is available with all the others properties inside LabelOption https://echarts.apache.org/zh/option.html#xAxis.axisLabel.overflow

After: How does it behave after the fixing?

After setting the correct type We can use the overflow property on xAxis.axisLabel without getting a type error.

The issue was fixed by changing the interface that AxisLabelBaseOption was extending from TextCommonOption to LabelOption, as wrote before LabelOption is already extending TextCommonOption.
I have also removed from AxisLabelBaseOption the property that were already available in LabelOption.
The issue was fixed by adding the overflow property to AxisLabelBaseOption, copying the type of overflow from TextStyleProps.

Document Info

One of the following should be checked.

• This PR doesn't relate to document changes
• The document should be updated later
• The document changes have been made in apache/echarts-doc#xxx

Misc

ZRender Changes

• This PR depends on ZRender changes (ecomfe/zrender#xxx).

Related test cases or examples to use the new APIs

N.A.

Others

Merging options

• Please squash the commits into a single one when merging.

Other information

[echarts-bot]

Thanks for your contribution!
The community will review it ASAP. In the meanwhile, please checkout the coding standard and Wiki about How to make a pull request.

[Ovilia]

It seems a lot of attributes of LabelOption should not be included in AxisBaseOptionCommon. So it's probably not a good idea to extend it. Add overflow?: TextStyleProps['overflow'] to AxisBaseOptionCommon may be enough.

[breizh24]

It seems a lot of attributes of LabelOption should not be included in AxisBaseOptionCommon. So it's probably not a good idea to extend it. Add overflow?: TextStyleProps['overflow'] to AxisBaseOptionCommon may be enough.

Agreed, I've done the requested changes

[echarts-bot]

Congratulations! Your PR has been merged. Thanks for your contribution! 👍