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

feat(liquid): add outline, wave options for customize #2099

Merged
merged 4 commits into from
Dec 11, 2020
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
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
* **G2Plot Version**:
* **Platform**:
* **Mini Showcase(like screenshots)**:
* **CodePen Link**:

<!-- Describe your bugs below ^_^ -->

12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
### PR includes
<!-- Add completed items in this PR, and change [ ] to [x]. -->

- [ ] fixed #0
- [ ] add / modify test cases
- [ ] documents, demos

### Screenshot

| Before | After |
|----|----|
|||
7 changes: 5 additions & 2 deletions __tests__/bugs/issue-1909-spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ describe('#1909', () => {
liquidPlot.render();

// @ts-ignore
expect(liquidPlot.chart.geometries[0].container.getChildren()[0].getChildren()[0].attr('opacity')).toBe(0.6);
expect(liquidPlot.chart.geometries[0].container.getChildren()[1].getChildren()[0].attr('opacity')).toBe(0.2);

liquidPlot.update({
liquidStyle: {
Expand All @@ -21,7 +21,10 @@ describe('#1909', () => {
});

// @ts-ignore
expect(liquidPlot.chart.geometries[0].container.getChildren()[0].getChildren()[0].attr('opacity')).toBe(0.06);
expect(liquidPlot.chart.geometries[0].container.getChildren()[1].getChildren()[0].attr('opacity')).toBeCloseTo(
0.02,
5
);

liquidPlot.destroy();
});
Expand Down
2 changes: 2 additions & 0 deletions __tests__/bugs/issue-charts-367-spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,7 @@ describe('charts #367', () => {
.getChildren()
.map((v) => v.attr('text'))
).toEqual(LABELS);

gauge.destroy();
});
});
57 changes: 53 additions & 4 deletions __tests__/unit/plots/liquid/index-spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ describe('liquid', () => {
width: 600,
height: 300,
autoFit: false,
percent: 0.75,
percent: 0.45,
});

liquid.render();
Expand All @@ -16,16 +16,65 @@ describe('liquid', () => {
expect(liquid.options.radius).toBe(0.9);

// @ts-ignore
expect(liquid.chart.middleGroup.getChildren()[0].getChildren()[1].attr('r')).toBe(135);
expect(liquid.chart.middleGroup.getChildren()[0].getChildren()[0].attr('r')).toBe(135);

// 宽 < 高,按照高度来设置 radius
liquid.changeSize(300, 500);

// @ts-ignore
expect(liquid.chart.middleGroup.getChildren()[0].getChildren()[1].attr('r')).toBe(135); // circle
expect(liquid.chart.middleGroup.getChildren()[0].getChildren()[0].attr('r')).toBe(135);
// 宽 < 高,按照高度来设置 radius
liquid.changeSize(500, 500);
// @ts-ignore
expect(liquid.chart.middleGroup.getChildren()[0].getChildren()[0].attr('r')).toBe(225);

liquid.destroy();
});

it('outline & wave', () => {
const liquid = new Liquid(createDiv(), {
width: 600,
height: 300,
autoFit: false,
percent: 0.3,
});

liquid.render();
expect(liquid.options.outline).toEqual({ border: 2, distance: 0 });
expect(liquid.options.wave).toEqual({ count: 3, length: 192 });

expect(liquid.chart.middleGroup.findAllByName('wrap')[0].attr('r')).toBe(135);
expect(liquid.chart.middleGroup.findAllByName('wrap')[0].attr('lineWidth')).toBe(2);
expect(liquid.chart.middleGroup.findAllByName('waterwave-path').length).toBe(3);
expect(liquid.chart.middleGroup.findAllByName('waterwave-path')[0].get('animations')[0].toAttrs.matrix[6]).toBe(
192
);
expect(liquid.chart.middleGroup.findAllByName('waves')[0].get('clipShape').attr('r')).toBe(135);

liquid.update({
outline: {
border: 4,
distance: 8,
},
wave: {
count: 5,
length: 128,
},
});

expect(liquid.options.outline).toEqual({ border: 4, distance: 8 });
expect(liquid.options.wave).toEqual({ count: 5, length: 128 });

expect(liquid.chart.middleGroup.findAllByName('wrap')[0].attr('r')).toBe(135);
expect(liquid.chart.middleGroup.findAllByName('wrap')[0].attr('lineWidth')).toBe(4);
expect(liquid.chart.middleGroup.findAllByName('waterwave-path').length).toBe(5);
expect(liquid.chart.middleGroup.findAllByName('waterwave-path')[0].get('animations')[0].toAttrs.matrix[6]).toBe(
128
);
expect(liquid.chart.middleGroup.findAllByName('waves')[0].get('clipShape').attr('r')).toBe(127);

liquid.destroy();
});

it('change data', () => {
const liquid = new Liquid(createDiv(), {
width: 600,
Expand Down
6 changes: 3 additions & 3 deletions __tests__/unit/plots/liquid/liquid-style-spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ describe('liquid', () => {
liquid.render();

// @ts-ignore
expect(liquid.chart.middleGroup.getChildren()[0].getChildren()[1].attr('stroke')).toBe('blue'); // circle
expect(liquid.chart.middleGroup.getChildren()[0].getChildren()[0].attr('stroke')).toBe('blue'); // circle
// @ts-ignore
expect(liquid.chart.middleGroup.getChildren()[0].getChildren()[0].getChildren()[0].attr('fill')).toBe('green'); // wave path
expect(liquid.chart.middleGroup.getChildren()[0].getChildren()[1].getChildren()[0].attr('fill')).toBe('green'); // wave path

// @ts-ignore
liquid.chart.getController('annotation').clear(true);
Expand All @@ -34,7 +34,7 @@ describe('liquid', () => {

// G2 chart.clear 的时候,geometry 销毁了,但是 container 还保留的,内存泄露。
// @ts-ignore
expect(liquid.chart.middleGroup.getChildren()[0].getChildren()[0].getChildren()[0].attr('fill')).toBe('red'); // wave path
expect(liquid.chart.middleGroup.getChildren()[0].getChildren()[1].getChildren()[0].attr('fill')).toBe('red'); // wave path

liquid.destroy();
});
Expand Down
22 changes: 22 additions & 0 deletions docs/manual/plots/liquid.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,28 @@ Liguid graphic style.

`markdown:docs/common/color.en.md`

#### outline

<description>**optional** _Outline_</description>

The ouline configure for liquid plot, includes:

| Attr | Type | Desc |
| ------------ | -------------- | ----------------------------------------------------- |
| border | number | border width of ouline, default 2px |
| disatance | number | disatance between ouline and wave, default 0px |

#### wave

<description>**optional** _Wave_</description>

The wave configure for liquid plot, includes:

| Attr | Type | Desc |
| ------------ | -------------- | ----------------------------------------------------- |
| count | number | wave count, default 3 |
| length | number | wave length, default is 192px |

### Plot Components

#### statistic
Expand Down
24 changes: 23 additions & 1 deletion docs/manual/plots/liquid.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,34 @@ order: 12

<description>**optional** _StyleAttr | Function_</description>

水波图的样式
水波图的配色样式

`markdown:docs/common/shape-style.zh.md`

`markdown:docs/common/color.zh.md`

#### outline

<description>**optional** _Outline_</description>

水波图的外框容器配置。主要包含以下内容:

| 属性名 | 类型 | 介绍 |
| ------------ | -------------- | -------------------------------------------- |
| border | number | 外框容器的 border 宽度,默认为 2 像素 |
| disatance | number | 外框容器和内部波形的间距,默认为 0 像素 |

#### wave

<description>**optional** _Wave_</description>

水波图的波形配置。主要包含以下内容:

| 属性名 | 类型 | 介绍 |
| ------------ | -------------- | -------------------------------------------- |
| count | number | 水波的个数,默认为 3 个 |
| length | number | 水波的波长度,默认为 192 像素 |

### 图表组件

#### statistic ✨
Expand Down
25 changes: 7 additions & 18 deletions examples/liquid/basic/demo/basic.ts
Original file line number Diff line number Diff line change
@@ -1,24 +1,13 @@
import { Liquid, measureTextWidth } from '@antv/g2plot';
import { Liquid } from '@antv/g2plot';

const liquidPlot = new Liquid('container', {
percent: 0.25,
statistic: {
content: {
style: {
fontSize: 60,
fill: 'black',
},
customHtml: (container, view, { percent }) => {
const { width, height } = container.getBoundingClientRect();
const d = Math.sqrt(Math.pow(width / 2, 2) + Math.pow(height / 2, 2));
const text = `${(percent * 100).toFixed(0)}%`;
const textWidth = measureTextWidth(text, { fontSize: 60 });
const scale = Math.min(d / textWidth, 1);
return `<div style="width:${d}px;height:${d}px;display:flex;align-items:center;justify-content:center;font-size:${scale}em;line-height:${
scale <= 1 ? 1 : 'inherit'
}">${text}</div>`;
},
},
outline: {
border: 4,
distance: 8,
},
wave: {
length: 128,
},
});
liquidPlot.render();
4 changes: 3 additions & 1 deletion src/plots/liquid/adaptor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const CAT_VALUE = 'liquid';
*/
function geometry(params: Params<LiquidOptions>): Params<LiquidOptions> {
const { chart, options } = params;
const { percent, color, liquidStyle, radius } = options;
const { percent, color, liquidStyle, radius, outline, wave } = options;

const data = [{ percent, type: CAT_VALUE }];

Expand Down Expand Up @@ -47,6 +47,8 @@ function geometry(params: Params<LiquidOptions>): Params<LiquidOptions> {
// 将 radius 传入到自定义 shape 中
geometry.customInfo({
radius,
outline,
wave,
});

// 关闭组件
Expand Down
8 changes: 8 additions & 0 deletions src/plots/liquid/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ export class Liquid extends Plot<LiquidOptions> {
},
},
},
outline: {
border: 2,
distance: 0,
},
wave: {
count: 3,
length: 192,
},
};
}

Expand Down
Loading