Skip to content

feat(type): provide ability to extend series option#15735

Merged
pissang merged 1 commit into
releasefrom
series-type-register
Sep 16, 2021
Merged

feat(type): provide ability to extend series option#15735
pissang merged 1 commit into
releasefrom
series-type-register

Conversation

@pissang
Copy link
Copy Markdown
Contributor

@pissang pissang commented Sep 16, 2021

Brief Information

This pull request is in the type of:

  • bug fixing
  • new feature
  • others

What does this PR do?

Previously we can't use TypeScript declaration merging feature to extend our SeriesOption in the extensions like echarts-wordcloud because it's a union type.

This PR adds an interface RegisteredSeriesOption. It can be extended with new types of series. SeriesOption will pick all its values and get a union type.

import echarts from 'echarts';
declare module 'echarts/types/dist/echarts' {
   interface RegisteredSeriesOption {
      wordCloud: WordCloudSeriesOption
   }
 }

@echarts-bot
Copy link
Copy Markdown

echarts-bot Bot commented Sep 16, 2021

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.

The pull request is marked to be PR: author is committer because you are a committer of this project.

@pissang pissang merged commit 5ff6216 into release Sep 16, 2021
@pissang pissang deleted the series-type-register branch September 16, 2021 06:29
@echarts-bot
Copy link
Copy Markdown

echarts-bot Bot commented Sep 16, 2021

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants