Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(polar): angleAxis extent when boundaryGap is false #20184

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

fix(polar): angleAxis extent when boundaryGap is false #20184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eac089c
fix(polar): extent when boundaryGap is false
Ovilia Jul 19, 2024
645bd05
test(polar): add test case for polar bars with boundaryGap false
Ovilia Jul 22, 2024
c36098a
style(polar): fix lint
Ovilia Jul 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/coord/polar/polarCreator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,15 @@ function updatePolarScale(this: Polar, ecModel: GlobalModel, api: ExtensionAPI)
// Fix extent of category angle axis
if (angleAxis.type === 'category' && !angleAxis.onBand) {
const extent = angleAxis.getExtent();
const diff = 360 / (angleAxis.scale as OrdinalScale).count();
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We can see that the old code takes 360 as the range of endAngle to startAngle, which is not always the case.

angleAxis.inverse ? (extent[1] += diff) : (extent[1] -= diff);
angleAxis.setExtent(extent[0], extent[1]);
const angleModel = angleAxis.model;
const endAngle = angleModel.get('endAngle');
const spanAngle = (endAngle == null ? 360 : endAngle - angleModel.get('startAngle'))
Copy link
Member

@100pah 100pah Nov 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

The conditional operator has lower precedence than arithmetic operator.
endAngle == null ? 360 : endAngle - angleModel.get('startAngle')
means
endAngle == null ? 360 : (endAngle - angleModel.get('startAngle'))

This should be a "famous" and commonly occurring mistake in not only JS but also Java, c++, ...

And why there is null checker for only endAngle but not startAngle?
I think in this place we can assume that both endAngle and startAngle are not nullable here. I mean that set default value in only one place (function setAxis).

And should we retrieve value from extent rather from angleModel here?

* (angleAxis.inverse ? -1 : 1);
const diff = spanAngle / (angleAxis.scale as OrdinalScale).count();
if (Math.abs(spanAngle + diff) >= 360) {
extent[1] += Math.abs(diff);
angleAxis.setExtent(extent[0], extent[1]);
Copy link
Member

@100pah 100pah Nov 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

In the current modified approach, this cases are not reasonable enougth:

image (already have a overlap between bar C and bar D) image (endAngle changes a little (from -195 to -198) but the appearance changes significantly.)

I think the "adjusting the extent" is a compromise. It's counter intuitive (the adjusted endAngle is not what use specified) but with out that user have avoid overlap manually.

I just try to modify it: make it keep at a "max span" when there is no enough space.

    // Fix extent of category angle axis
    if (angleAxis.type === 'category' && !angleAxis.onBand) {
        const extent = angleAxis.getExtent();
        let spanAngle = normalizeAngle((normalizeAngle(extent[1]) + 360 - normalizeAngle(extent[0])));
        if (angleAxis.inverse) {
            spanAngle = 360 - spanAngle;
        }
        const spanLimit = 360 - 360 / (angleAxis.scale as OrdinalScale).count();
        if (spanAngle >= spanLimit) {
            extent[1] = extent[0] + (angleAxis.inverse ? -1 : 1) * spanLimit;
            angleAxis.setExtent(extent[0], extent[1]);
        }
    }
    // FIXME: this kind of function should be placed in some common util file? (or similar one already exists?)
    // Normalize an angle value to `[0, 360)`.
    function normalizeAngle(val: number) {
        val = val % 360;
        val < 0 && (val += 360);
        return val;
    }

(it's just a illustrative code to show my current understanding.)

But about clockwise (inverse). I haven't understood the logic yet.
The current behavior (before this PR modified) seems weird:

image

}
}
}

Expand Down
87 changes: 85 additions & 2 deletions test/bar-polar-basic-radial.html
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions test/runTest/actions/__meta__.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions test/runTest/actions/bar-polar-basic-radial.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.