Skip to content

Commit

Permalink
chore: release 2.3.36 (#2899)
Browse files Browse the repository at this point in the history
* chore: v2.3.36 & changelog

* chore: release-notify script

* docs: 更新 annotation 文档样式

* docs: 图表实例页,api 文档样式自定义覆盖
  • Loading branch information
visiky authored Oct 8, 2021
1 parent e36296b commit 7baa9e7
Show file tree
Hide file tree
Showing 16 changed files with 117 additions and 88 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release-notify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: DingTalk Release Notify
on:
workflow_dispatch:
release:
types: [published]
types: [published, edited]

jobs:
notify:
Expand Down
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
#### 2.3.36 (2021-10-08)

##### Documentation Changes

* **funnel:** 漏斗图转化率信息组件文档 api 补全 ([#2894](https://github.com/antvis/g2plot/pull/2894)) ([3a708220](https://github.com/antvis/g2plot/commit/3a708220c14fecda184a97945278c1d484ea894e))
* **label:** 补充 label position 配置的文档说明 ([#2896](https://github.com/antvis/g2plot/pull/2896)) ([379df35f](https://github.com/antvis/g2plot/commit/379df35f6fdad4442f8d1234ac264d0e8cf895be))

##### New Features

* **gauge:** 仪表盘支持自定义指示器 indicator ([#2892](https://github.com/antvis/g2plot/pull/2892)) ([e36296b1](https://github.com/antvis/g2plot/commit/e36296b18d1f4ad133e5f1c6ed32dba525d1e476))
* **line:** 修复折线图 marker 交互, 以及丰富折线图自定义 marker demo ([#2895](https://github.com/antvis/g2plot/pull/2895)) ([078a358a](https://github.com/antvis/g2plot/commit/078a358a8e0f667bcf1d2a808bac5c0fc2e9bb08))

##### Bug Fixes

* **sankey:** 桑基图节点顺序需要保证原序 ([#2897](https://github.com/antvis/g2plot/pull/2897)) ([5ad43b72](https://github.com/antvis/g2plot/commit/5ad43b7276f7a49c4ceefcfe929cabc1e10bf2c8))
* **funnel:** 修复漏斗图数据为 0 时,出现 conversionTag 样式问题 ([#2893](https://github.com/antvis/g2plot/pull/2893)) ([6a0512b7](https://github.com/antvis/g2plot/commit/6a0512b70fe2442f9c9e86b8e1705d53d8d10fd5))
* 修复开启 animation 引发 state 样式延迟渲染,导致单测错误 ([#2891](https://github.com/antvis/g2plot/pull/2891)) ([0e8de058](https://github.com/antvis/g2plot/commit/0e8de0581e65caf0b615cc63c43590f9dc5b2041))

##### Refactors

* **gauge:** 米轨仪表盘绘制方案改造 & 单测 ([#2890](https://github.com/antvis/g2plot/pull/2890)) ([cc8fa33d](https://github.com/antvis/g2plot/commit/cc8fa33d5c17d64392f1e549b876f62252ee90d4))

#### 2.3.35 (2021-09-26)

##### Chores
Expand Down
10 changes: 5 additions & 5 deletions docs/common/annotations/arc.zh.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
### Arc Annotation
#### 💠 Arc Annotation

#### type
##### type

<description>**optional** _string_</description>

需要指定 `type: 'arc',` 标识为:辅助弧线,只在**极坐标系**下生效。常用于绘制仪表盘。

#### start
##### start

<description>**optional** _AnnotationPosition_ </description>

Expand Down Expand Up @@ -38,13 +38,13 @@ type AnnotationPosition =

[Example](/zh/examples/component/annotation#line-annotation-position)

#### end
##### end

<description>**optional** _AnnotationPosition_ </description>

结束位置,一般用于 line、region 等。具体配置属性参考: [start](#start)

#### style
##### style

<description>**optional** _object_ </description>

Expand Down
11 changes: 5 additions & 6 deletions docs/common/annotations/base-annotation.zh.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,28 @@

#### top
##### top

<description>**optional** _boolean_ </description>

指定 annotation 是否绘制在 canvas 最上层,默认为 false, 即绘制在最下层。

#### offsetX
##### offsetX

<description>**optional** _number_ </description>

x 轴方向的偏移量。

#### offsetY
##### offsetY

<description>**optional** _number_ </description>

y 轴方向的偏移量。

#### animate
##### animate

<description>**optional** _boolean_ </description>

是否进行动画。

#### animateOption
##### animateOption

<description>**optional** _object_ </description>

Expand Down
16 changes: 8 additions & 8 deletions docs/common/annotations/data-marker.zh.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
### DataMarker Annotation
#### 💠 DataMarker Annotation

#### type
##### type

<description>**optional** _string_</description>

需要指定 `type: 'dataMarker',` 标识为:特殊数据点标注,多用于折线图和面积图。

#### position
##### position

<description>**required** _[string, string] | Datum | ((xScale, yScales) => [string, string])_</description>

DataMarker 标注位置,参考 Text Annotation 标注的 `position` 设置。

[Example](/zh/examples/component/annotation#text-annotation1)

#### point
##### point

<description>**optional** _null | DataMarkerPointCfg_ </description>

Expand All @@ -29,7 +29,7 @@ type DataMarkerPointCfg = {
}
```
#### line
##### line
<description>**optional** _null | DataMarkerLineCfg_ </description>
Expand All @@ -45,7 +45,7 @@ type DataMarkerPointCfg = {
}
```
#### text
##### text
<description>**optional** _null | AnnotationTextCfg_ </description>
Expand All @@ -69,13 +69,13 @@ type AnnotationTextCfg = {
};
```

#### autoAdjust
##### autoAdjust

<description>**optional** _boolean_ </description>

文本超出绘制区域时,是否自动调节文本方向。

#### direction
##### direction

<description>**optional** _upward | downward_ </description>

Expand Down
12 changes: 6 additions & 6 deletions docs/common/annotations/data-region.zh.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
### DataRegion Annotation
#### 💠 DataRegion Annotation

#### type
##### type

<description>**optional** _string_</description>

需要指定 `type: 'dataRegion',` 标识为:特殊数据区间标注,多用于折线图和面积图。

#### position
##### position

<description>**required** _[string, string] | Datum | ((xScale, yScales) => [string, string])_</description>

DataMarker 标注位置,参考 Text Annotation 标注的 `position` 设置。

[Example](/zh/examples/component/annotation#text-annotation1)

#### lineLength
##### lineLength

<description> _number_ **optional** _default:_ `0`</description>

line 长度。

#### region
##### region

<description> _null | { style?: ShapeAttrs }_ **optional** _default:_ `0`</description>

标注区间的配置。点击 [ShapeAttrs](/zh/docs/api/shape/shape-attrs) 查看详细样式配置。

#### text
##### text

<description> _null | EnhancedTextCfg_ **optional** _default:_ `0`</description>

Expand Down
16 changes: 8 additions & 8 deletions docs/common/annotations/html.zh.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,42 @@
### Html Annotation
#### 💠 Html Annotation

#### type
##### type

<description>**optional** _string_</description>

需要指定 `type: 'html',`。自定义任意 HTML 类型的图形标记,通过 option 中的 html 配置来在图表中使用 HTML DOM 元素来添加图形标记。option 配置如下:

#### container
##### container

<description> _string_ | _HTMLElement_ **optional** </description>

可选,自定义 HTML 图形标记的容器元素

#### html
##### html

<description> _string_ | _HTMLElement_ | _((container: HTMLElement, view: View) => void | string | HTMLElement)_ </description>

自定义的图形标记的 HTML 元素,可为 HTML DOM 字符串,或 HTML 元素,或 html 回调函数

#### alignX
##### alignX

<description> _'left'_ | _'middle'_ | _'right'_ **optional** _default:_ 'left' </description>

DOM 元素在 X 方向的对齐方式

#### alignY
##### alignY

<description> _'top'_ | _'middle'_ | _'bottom'_ **optional** _default:_ 'top'</description>

DOM 元素在 Y 方向的对齐方式

#### offsetX
##### offsetX

<description> _number_ **optional** </description>

X 方向的偏移

#### offsetY
##### offsetY

<description> _number_ **optional** </description>

Expand Down
14 changes: 7 additions & 7 deletions docs/common/annotations/image.zh.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
### Image Annotation
#### 💠 Image Annotation

#### type
##### type

<description>**optional** _string_</description>

需要指定 `type: 'image',` 标识为:辅助图片,在图表上添加辅助图片。

#### src
##### src

<description>**optional** _string_ </description>

图片路径,用于 image 中。

#### position
##### position

<description>**optional** _[string, string] | Datum | ((xScale, yScales) => [string, string])_</description>

图片标注位置。

[Example](/zh/examples/component/annotation#image-annotation)

#### start
##### start

<description>**optional** _AnnotationPosition_ </description>

Expand All @@ -37,13 +37,13 @@

[Example](/zh/examples/component/annotation#line-annotation-position)

#### end
##### end

<description>**optional** _AnnotationPosition_ </description>

结束位置,需搭配 `start` 使用,也可以直接只使用 `position`。具体配置属性参考: [start](#start)

#### style
##### style

<description>**optional** _object_ </description>

Expand Down
12 changes: 6 additions & 6 deletions docs/common/annotations/line.zh.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
### Line Annotation
#### 💠 Line Annotation

#### type
##### type

<description>**optional** _string_</description>

需要指定 `type: 'line',` 标识为:辅助线(可带文本),例如表示平均值或者预期分布的直线。

#### start
##### start

<description>**optional** _AnnotationPosition_ </description>

Expand Down Expand Up @@ -38,18 +38,18 @@ type AnnotationPosition =

[Example](/zh/examples/component/annotation#line-annotation-position)

#### end
##### end

<description>**optional** _AnnotationPosition_ </description>

结束位置,一般用于 line、region 等。具体配置属性参考: [start](#start)
#### style
##### style

<description>**optional** _object_ </description>

辅助线样式属性,参考[绘图属性](/zh/docs/api/graphic-style)

#### text
##### text

<description>**optional** _LineAnnotationTextCfg_ </description>

Expand Down
14 changes: 7 additions & 7 deletions docs/common/annotations/region-filter.zh.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
### Region Annotation
#### 💠 Region Annotation

#### type
##### type

<description>**optional** _string_</description>

需要指定 `type: 'regionFilter',` 标识为:区域着色,将图表中位于矩形选区中的图形元素提取出来,重新着色。

#### start
##### start

<description>**optional** _AnnotationPosition_ </description>

Expand Down Expand Up @@ -38,25 +38,25 @@ type AnnotationPosition =

[Example](/zh/examples/component/annotation#line-annotation-position)

#### end
##### end

<description>**optional** _AnnotationPosition_ </description>

结束位置,一般用于 line、region 等。具体配置属性参考: [start](#start)

#### style
##### style

<description>**optional** _object_ </description>

辅助线样式属性,参考[绘图属性](/zh/docs/api/graphic-style)

#### color
##### color

<description>**optional** _string_ </description>

染色色值,一般用于 regionFilter。

#### apply
##### apply

<description>**optional** _string[]_ </description>

Expand Down
Loading

0 comments on commit 7baa9e7

Please sign in to comment.