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.

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

fix(chart): autoFit do not set width and height of chart options #4922

Merged
merged 1 commit into from
Apr 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion __tests__/integration/api-chart-auto-fit.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ describe('chart.options.autoFit', () => {
const canvas = createNodeGCanvas(800, 500);
let chart;
let button;
let fitted;

it('chart({ autoFit: true }) should fit parent container', async () => {
const { finished, ...rest } = render({
Expand All @@ -17,14 +18,15 @@ describe('chart.options.autoFit', () => {
});
chart = rest.chart;
button = rest.button;
fitted = rest.fitted;
await finished;
await sleep(20);
await expect(canvas).toMatchCanvasSnapshot(dir, 'step0');
});

it('chart.forceFit() should fit parent container', async () => {
button.dispatchEvent(new CustomEvent('click'));
await new Promise((resolve) => chart.on('afterchangesize', resolve));
await fitted;
await sleep(20);
await expect(canvas).toMatchCanvasSnapshot(dir, 'step1');
});
pearmini marked this conversation as resolved.
Show resolved Hide resolved
pearmini marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
Binary file modified __tests__/integration/snapshots/api/chart-auto-fit/step0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions __tests__/plots/api/chart-auto-fit.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,14 @@ export function chartAutoFit(context) {

const finished = chart.render();

let resolve;
const fitted = new Promise((r) => (resolve = r));

button.onclick = () => {
wrapperDiv.style.width = '400px';
wrapperDiv.style.height = '500px';
chart.forceFit();
chart.forceFit().then(resolve);
};

return { chart, button, finished };
return { chart, button, finished, fitted };
}
pearmini marked this conversation as resolved.
Show resolved Hide resolved
pearmini marked this conversation as resolved.
Show resolved Hide resolved
18 changes: 18 additions & 0 deletions __tests__/unit/api/chart.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -605,4 +605,22 @@ describe('Chart', () => {
expect(interval.data()).toEqual([data[1]]);
expect(line.data()).toEqual([data[1]]);
});

it('new Chart({ autoFit: true }) should not set width and height of chart options.', async () => {
const chart = new Chart({ theme: 'classic', autoFit: true });
chart
.interval()
.data([
{ genre: 'Sports', sold: 275 },
{ genre: 'Strategy', sold: 115 },
{ genre: 'Action', sold: 120 },
{ genre: 'Shooter', sold: 350 },
{ genre: 'Other', sold: 150 },
])
.encode('x', 'genre')
.encode('y', 'sold');
await chart.render();
expect(chart.width()).toBeUndefined();
expect(chart.height()).toBeUndefined();
});
});
pearmini marked this conversation as resolved.
Show resolved Hide resolved
pearmini marked this conversation as resolved.
Show resolved Hide resolved
pearmini marked this conversation as resolved.
Show resolved Hide resolved
pearmini marked this conversation as resolved.
Show resolved Hide resolved
68 changes: 35 additions & 33 deletions src/api/chart.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { debounce, deepMix, omit } from '@antv/util';
import EventEmitter from '@antv/event-emitter';
import { G2Context, render, destroy } from '../runtime';
import { ViewComposition } from '../spec';
import { getChartSize } from '../utils/size';
import { getContainerSize } from '../utils/size';
import { ChartEvent } from '../utils/event';
import { G2ViewTree } from '../runtime/types/options';
import { Node } from './node';
Expand Down Expand Up @@ -95,6 +95,13 @@ function Canvas(
});
}

function sizeOf(options, container) {
const { autoFit } = options;
if (autoFit) return getContainerSize(container);
const { width = 640, height = 480 } = options;
return { width, height };
}

export function optionsOf(node: Node): Record<string, any> {
const root = normalizeRoot(node);
const discovered: Node[] = [root];
Expand Down Expand Up @@ -169,6 +176,8 @@ export class Chart extends View<ChartOptions> {
private _context: G2Context;
private _emitter: EventEmitter;
private _options: G2ViewTree;
private _width: number;
private _height: number;

constructor(options: ChartOptions) {
const { container, canvas, key = G2_CHART_KEY, ...rest } = options || {};
Expand All @@ -183,22 +192,8 @@ export class Chart extends View<ChartOptions> {
render(): Promise<Chart> {
if (!this._context.canvas) {
// Init width and height.
const {
width = 640,
height = 480,
renderer,
plugins,
autoFit,
} = this.options();
const { width: adjustedWidth, height: adjustedHeight } = getChartSize(
this._container,
autoFit,
width,
height,
);
this.width(adjustedWidth);
this.height(adjustedHeight);

const { renderer, plugins } = this.options();
const { width, height } = sizeOf(this.options(), this._container);
// Create canvas if it does not exist.
this._context.canvas = Canvas(
this._container,
Expand All @@ -211,12 +206,21 @@ export class Chart extends View<ChartOptions> {

return new Promise((resolve, reject) => {
try {
render(this.options(), this._context, () => resolve(this), reject);
const { width, height } = sizeOf(this.options(), this._container);
this._width = width;
this._height = height;
render(
{ ...this.options(), width, height },
this._context,
() => resolve(this),
reject,
);
} catch (e) {
reject(e);
}
});
}

/**
* @overload
* @returns {G2ViewTree}
Expand Down Expand Up @@ -291,26 +295,24 @@ export class Chart extends View<ChartOptions> {
}

forceFit() {
const { width, height, autoFit } = this.options();
const { width: adjustedWidth, height: adjustedHeight } = getChartSize(
this._container,
autoFit,
width,
height,
);
if (adjustedHeight && adjustedWidth) {
this.changeSize(adjustedWidth, adjustedHeight);
}
// Don't call changeSize to prevent update width and height of options.
// @ts-ignore
this.options.autoFit = true;
this.emit(ChartEvent.BEFORE_CHANGE_SIZE);
const finished = this.render();
finished.then(() => {
this.emit(ChartEvent.AFTER_CHANGE_SIZE);
});
return finished;
}

changeSize(adjustedWidth: number, adjustedHeight: number): Promise<Chart> {
const { width, height, on } = this.options();
if (width === adjustedWidth && height === adjustedHeight) {
changeSize(width: number, height: number): Promise<Chart> {
if (width === this._width && height === this._height) {
return Promise.resolve(this);
}
pearmini marked this conversation as resolved.
Show resolved Hide resolved
pearmini marked this conversation as resolved.
Show resolved Hide resolved
this.emit(ChartEvent.BEFORE_CHANGE_SIZE);
this.width(adjustedWidth);
this.height(adjustedHeight);
this.width(width);
this.height(height);
const finished = this.render();
finished.then(() => {
this.emit(ChartEvent.AFTER_CHANGE_SIZE);
pearmini marked this conversation as resolved.
Show resolved Hide resolved
pearmini marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
31 changes: 0 additions & 31 deletions src/utils/size.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,37 +31,6 @@ export function getContainerSize(container: HTMLElement): Size {
};
}

/**
*
* @description Calculate the chart size.
* @param container DOM container element.
* @param autoFit Should auto fit.
* @param width Chart width which is set by user.
* @param height Chart height which is set by user.
* @returns chart width and height.
*/
export function getChartSize(
container: HTMLElement,
autoFit: boolean,
width: number,
height: number,
): Size {
if (!autoFit) {
return {
width,
height,
};
}

// Get size from wrapper container.
const size = getContainerSize(container);

return {
width: size.width,
height: size.height,
};
}

/**
* @description Calculate the real canvas size by view options.
*/
pearmini marked this conversation as resolved.
Show resolved Hide resolved
pearmini marked this conversation as resolved.
Show resolved Hide resolved
pearmini marked this conversation as resolved.
Show resolved Hide resolved
pearmini marked this conversation as resolved.
Show resolved Hide resolved
Expand Down