Skip to content

feat(custom): support compoundPath in custom series renderItem#20402

Merged
Ovilia merged 5 commits intov6from
feat-compoundPath
Oct 16, 2024
Merged

feat(custom): support compoundPath in custom series renderItem#20402
Ovilia merged 5 commits intov6from
feat-compoundPath

Conversation

@Ovilia
Copy link
Copy Markdown
Contributor

@Ovilia Ovilia commented Oct 10, 2024 •
edited
Loading

Brief Information

This pull request is in the type of:

  • bug fixing
  • new feature
  • others

What does this PR do?

This PR supports compoundPath in custom series renderItem. It can be used as:

renderItem(params, api) {
    return {
        type: 'compoundPath',
        shape: {
            paths: [rect, circle, ...]
        }
    }
}

Fixed issues

Details

Before: What was the problem?

compondPath is not supported so that we cannot make complex objects that looks like the union of shapes. If such shapes have opacity and intersection, it's hard to implement without a compoundPath.

After: How does it behave after the fixing?

compondPath is supported.

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@3d71262

Misc

ZRender Changes

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 echarts-bot bot added PR: author is committer PR: awaiting doc Document changes is required for this PR. PR: awaiting review labels Oct 10, 2024
@echarts-bot
Copy link
Copy Markdown

echarts-bot bot commented Oct 10, 2024

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.

Document changes are required in this PR. Please also make a PR to apache/echarts-doc for document changes and update the issue id in the PR description. When the doc PR is merged, the maintainers will remove the PR: awaiting doc label.

This PR depends on ZRender changes. Please update the ZRender dependency to the latest nightly version including this change, which takes place everyday at 8:00 UTC (16:00 Beijing Time).
You can use npm i zrender@npm:zrender-nightly@dev to update package.json.
If you have any question about this, please leave a comment and we will give you extra help on this.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 10, 2024 •
edited
Loading

The changes brought by this PR can be previewed at: https://echarts.apache.org/examples/editor?version=PR-20402@9fb4073

@Ovilia Ovilia merged commit 817ef5c into v6 Oct 16, 2024
@echarts-bot
Copy link
Copy Markdown

echarts-bot bot commented Oct 16, 2024

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

@Ovilia Ovilia deleted the feat-compoundPath branch October 16, 2024 07:31
@plainheart plainheart added this to the 6.0.0 milestone May 3, 2025
100pah
100pah reviewed Jun 1, 2025
View reviewed changes
src/chart/custom/CustomView.ts
}
const Clz = graphicUtil.getShapeClass(path.type);
if (!Clz) {
if (typeof path.buildPath === 'function') {
Copy link
Copy Markdown
Member

@100pah 100pah Jun 1, 2025

Choose a reason for hiding this comment

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

I think probably we should not public that buildPath.

  1. That function is not officially public in any other place, including not public in custom series path.
  2. If publish buildPath function, the signature must not be changed or need backward compat when changing. And the parameter of buildPath includes ctx, which is PathProxy or CanvasContext. Although they are always accessible never be officially public and promised in API stability.

Is it needed in some scenarios? @Ovilia

Ovilia added a commit to apache/echarts-doc that referenced this pull request Jul 1, 2025
@Ovilia
doc(custom): support compoundPath in custom series renderItem
3d71262 
apache/echarts#20402
@echarts-bot echarts-bot bot added PR: doc ready and removed PR: awaiting doc Document changes is required for this PR. labels Jul 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@100pah 100pah 100pah left review comments

Assignees

No one assigned

Labels

PR: author is committer PR: doc ready size/M

Projects

None yet

Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@Ovilia @100pah @plainheart