Skip to content

Commit

Permalink
refactor(api): auto generate marks from stdlib (#5380)
Browse files Browse the repository at this point in the history
  • Loading branch information
pearmini authored Aug 9, 2023
1 parent 9a17963 commit ba619cc
Show file tree
Hide file tree
Showing 42 changed files with 924 additions and 1,749 deletions.
2 changes: 1 addition & 1 deletion .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"checkLoops": false
}
],
"@typescript-eslint/no-empty-interface": "warn",
"@typescript-eslint/no-empty-interface": "off",
"@typescript-eslint/no-var-requires": "off",
"@typescript-eslint/ban-ts-comment": "off",
"@typescript-eslint/explicit-module-boundary-types": "off",
Expand Down
3 changes: 2 additions & 1 deletion __tests__/integration/utils/renderSpec.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Canvas } from '@antv/g';
import { createCanvas } from 'canvas';
import { G2Context, G2Spec, render } from '../../../src';
import { G2Context, G2Spec, createLibrary, render } from '../../../src';
import { renderToMountedElement } from '../../utils/renderToMountedElement';
import { createNodeGCanvas } from './createNodeGCanvas';

Expand All @@ -15,6 +15,7 @@ export async function renderSpec(
const renderFunction = mounted ? renderToMountedElement : render;
const options = preprocess({ ...raw, width, height });
context.canvas = gCanvas;
context.library = createLibrary();
context.createCanvas = () => {
// The width attribute defaults to 300, and the height attribute defaults to 150.
// @see https://stackoverflow.com/a/12019582
Expand Down
5 changes: 3 additions & 2 deletions __tests__/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { Plugin as ControlPlugin } from '@antv/g-plugin-control';
import { Plugin as ThreeDPlugin } from '@antv/g-plugin-3d';
import { Renderer as SVGRenderer } from '@antv/g-svg';
import { Renderer as WebGLRenderer } from '@antv/g-webgl';
import { render } from '../src';
import { createLibrary, render } from '../src';
import { renderToMountedElement } from './utils/renderToMountedElement';
import * as statics from './plots/static';
import * as interactions from './plots/interaction';
Expand Down Expand Up @@ -168,7 +168,8 @@ function createSpecRender(object) {
before?.();
const node = renderChart(
{ theme: 'classic', ...options },
{ canvas },
// @ts-ignore
{ canvas, library: createLibrary() },
() => after?.(),
);

Expand Down
1 change: 1 addition & 0 deletions __tests__/plots/api/chart-options-composite-mark.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ export function chartOptionsCompositeMark(context) {
{ genre: 'Shooter', sold: 350 },
{ genre: 'Other', sold: 150 },
],
// @ts-ignore
encode: { value: 'sold', color: 'genre' },
});

Expand Down
129 changes: 43 additions & 86 deletions __tests__/unit/api/chart.spec.ts
Original file line number Diff line number Diff line change
@@ -1,49 +1,6 @@
import { Canvas } from '@antv/g';
import { Renderer as SVGRenderer } from '@antv/g-svg';
import { Chart, createLibrary, ChartEvent } from '../../../src';
import {
View,
TimingKeyframe,
SpaceFlex,
FacetRect,
RepeatMatrix,
FacetCircle,
SpaceLayer,
} from '../../../src/api/composition';
import {
Area,
Cell,
Image,
Interval,
Line,
Link,
Point,
Polygon,
Vector,
Text,
Box,
LineX,
LineY,
Range,
RangeX,
RangeY,
Rect,
Connector,
Boxplot,
Sankey,
Treemap,
Shape,
Pack,
ForceGraph,
Tree,
WordCloud,
Gauge,
Density,
Heatmap,
AxisX,
AxisY,
Legends,
} from '../../../src/api/mark/mark';

const TEST_OPTIONS = {
type: 'interval',
Expand Down Expand Up @@ -140,39 +97,39 @@ describe('Chart', () => {

it('chart.nodeName() should return expected node.', () => {
const chart = new Chart({ theme: 'classic' });
expect(chart.interval()).toBeInstanceOf(Interval);
expect(chart.rect()).toBeInstanceOf(Rect);
expect(chart.point()).toBeInstanceOf(Point);
expect(chart.area()).toBeInstanceOf(Area);
expect(chart.line()).toBeInstanceOf(Line);
expect(chart.cell()).toBeInstanceOf(Cell);
expect(chart.vector()).toBeInstanceOf(Vector);
expect(chart.link()).toBeInstanceOf(Link);
expect(chart.polygon()).toBeInstanceOf(Polygon);
expect(chart.image()).toBeInstanceOf(Image);
expect(chart.text()).toBeInstanceOf(Text);
expect(chart.box()).toBeInstanceOf(Box);
expect(chart.lineX()).toBeInstanceOf(LineX);
expect(chart.lineY()).toBeInstanceOf(LineY);
expect(chart.range()).toBeInstanceOf(Range);
expect(chart.rangeX()).toBeInstanceOf(RangeX);
expect(chart.rangeY()).toBeInstanceOf(RangeY);
expect(chart.connector()).toBeInstanceOf(Connector);
expect(chart.sankey()).toBeInstanceOf(Sankey);
expect(chart.treemap()).toBeInstanceOf(Treemap);
expect(chart.boxplot()).toBeInstanceOf(Boxplot);
expect(chart.shape()).toBeInstanceOf(Shape);
expect(chart.pack()).toBeInstanceOf(Pack);
expect(chart.forceGraph()).toBeInstanceOf(ForceGraph);
expect(chart.tree()).toBeInstanceOf(Tree);
expect(chart.wordCloud()).toBeInstanceOf(WordCloud);
expect(chart.gauge()).toBeInstanceOf(Gauge);
expect(chart.density()).toBeInstanceOf(Density);
expect(chart.heatmap()).toBeInstanceOf(Heatmap);
expect(chart.axisX()).toBeInstanceOf(AxisX);
expect(chart.axisY()).toBeInstanceOf(AxisY);
expect(chart.legends()).toBeInstanceOf(Legends);
expect(chart.options().children).toEqual([
expect(chart.interval().type).toBe('interval');
expect(chart.rect().type).toBe('rect');
expect(chart.point().type).toBe('point');
expect(chart.area().type).toBe('area');
expect(chart.line().type).toBe('line');
expect(chart.cell().type).toBe('cell');
expect(chart.vector().type).toBe('vector');
expect(chart.link().type).toBe('link');
expect(chart.polygon().type).toBe('polygon');
expect(chart.image().type).toBe('image');
expect(chart.text().type).toBe('text');
expect(chart.box().type).toBe('box');
expect(chart.lineX().type).toBe('lineX');
expect(chart.lineY().type).toBe('lineY');
expect(chart.range().type).toBe('range');
expect(chart.rangeX().type).toBe('rangeX');
expect(chart.rangeY().type).toBe('rangeY');
expect(chart.connector().type).toBe('connector');
expect(chart.sankey().type).toBe('sankey');
expect(chart.treemap().type).toBe('treemap');
expect(chart.boxplot().type).toBe('boxplot');
expect(chart.shape().type).toBe('shape');
expect(chart.pack().type).toBe('pack');
expect(chart.forceGraph().type).toBe('forceGraph');
expect(chart.tree().type).toBe('tree');
expect(chart.wordCloud().type).toBe('wordCloud');
expect(chart.gauge().type).toBe('gauge');
expect(chart.density().type).toBe('density');
expect(chart.heatmap().type).toBe('heatmap');
expect(chart.axisX().type).toBe('axisX');
expect(chart.axisY().type).toBe('axisY');
expect(chart.legends().type).toBe('legends');
expect((chart.options() as any).children).toEqual([
{ type: 'interval' },
{ type: 'rect' },
{ type: 'point' },
Expand Down Expand Up @@ -212,7 +169,7 @@ describe('Chart', () => {
const chart = new Chart({ theme: 'classic' });
chart.view();
chart.spaceLayer();
expect(chart.spaceLayer()).toBeInstanceOf(SpaceLayer);
expect(chart.spaceLayer().type).toBe('spaceLayer');
});

it('chart.container() should set layout options for root node.', () => {
Expand Down Expand Up @@ -264,19 +221,19 @@ describe('Chart', () => {

it('chart.container() should return expected container.', () => {
const chart = new Chart({ theme: 'classic' });
expect(chart.view()).toBeInstanceOf(View);
expect(chart.view().type).toBe('view');
expect(chart.options()).toEqual({ type: 'view', theme: 'classic' });
expect(chart.spaceLayer()).toBeInstanceOf(SpaceLayer);
expect(chart.spaceLayer().type).toBe('spaceLayer');
expect(chart.options()).toEqual({ type: 'spaceLayer', theme: 'classic' });
expect(chart.spaceFlex()).toBeInstanceOf(SpaceFlex);
expect(chart.spaceFlex().type).toBe('spaceFlex');
expect(chart.options()).toEqual({ type: 'spaceFlex', theme: 'classic' });
expect(chart.facetRect()).toBeInstanceOf(FacetRect);
expect(chart.facetRect().type).toBe('facetRect');
expect(chart.options()).toEqual({ type: 'facetRect', theme: 'classic' });
expect(chart.repeatMatrix()).toBeInstanceOf(RepeatMatrix);
expect(chart.repeatMatrix().type).toBe('repeatMatrix');
expect(chart.options()).toEqual({ type: 'repeatMatrix', theme: 'classic' });
expect(chart.facetCircle()).toBeInstanceOf(FacetCircle);
expect(chart.facetCircle().type).toBe('facetCircle');
expect(chart.options()).toEqual({ type: 'facetCircle', theme: 'classic' });
expect(chart.timingKeyframe()).toBeInstanceOf(TimingKeyframe);
expect(chart.timingKeyframe().type).toBe('timingKeyframe');
expect(chart.options()).toEqual({
type: 'timingKeyframe',
theme: 'classic',
Expand Down Expand Up @@ -720,8 +677,8 @@ describe('Chart', () => {
.encode('x', 'genre')
.encode('y', 'sold');
await chart.render();
expect(chart.width()).toBeUndefined();
expect(chart.height()).toBeUndefined();
expect(chart.attr('width')).toBeUndefined();
expect(chart.attr('height')).toBeUndefined();
});

it('chart.options({ autoFit: true }) should bind autoFit.', async () => {
Expand Down
Loading

0 comments on commit ba619cc

Please sign in to comment.