From a5754bb1b37bfcab3d06e107fbf46213ee030461 Mon Sep 17 00:00:00 2001 From: vicanso Date: Tue, 5 Apr 2022 09:29:10 +0800 Subject: [PATCH] docs: update document --- README_zh.md | 24 ++++++++++++++++++++++++ go.mod | 2 +- go.sum | 4 ++-- 3 files changed, 27 insertions(+), 3 deletions(-) diff --git a/README_zh.md b/README_zh.md index ad7a4d9..6d794e0 100644 --- a/README_zh.md +++ b/README_zh.md @@ -119,6 +119,30 @@ func main() { } ``` +## 常用函数 + +`go-charts`针对常用的几种图表提供了简单的调用方式以及几种常用的Option设置,便捷的生成常用图表。 + +- `LineRender`: 折线图表,第一个参数为二维浮点数,对应图表中的点,支持不定长的OptionFunc参数,用于指定其它的属性 +- `BarRender`: 柱状图表,第一个参数为二维浮点数,对应柱状图的高度,支持不定长的OptionFunc参数,用于指定其它的属性 +- `PieRender`: 饼图表,第一个参数为浮点数数组,对应各占比,支持不定长的OptionFunc参数,用于指定其它的属性 +- `RadarRender`: 雷达图,第一个参数为二维浮点数,对应雷达图中的各值,支持不定长的OptionFunc参数,用于指定其它的属性 +- `FunnelRender`: 漏斗图,第一个参数为浮点数数组,对应各占比,支持不定长的OptionFunc参数,用于指定其它的属性 +- `PNGTypeOption`: 指定输出PNG +- `FontFamilyOptionFunc`: 指定使用的字体 +- `ThemeOptionFunc`: 指定使用的主题类型 +- `TitleOptionFunc`: 指定标题相关属性 +- `LegendOptionFunc`: 指定图例相关属性 +- `XAxisOptionFunc`: 指定x轴的相关属性 +- `YAxisOptionFunc`: 指定y轴的相关属性 +- `WidthOptionFunc`: 指定宽度 +- `HeightOptionFunc`: 指定高度 +- `PaddingOptionFunc`: 指定空白填充区域 +- `BoxOptionFunc`: 指定内容区域 +- `ChildOptionFunc`: 指定子图表 +- `RadarIndicatorOptionFunc`: 雷达图指示器相关属性 +- `BackgroundColorOptionFunc`: 设置背景图颜色 + ## ECharts参数说明 名称有[]的参数非echarts的原有参数,为`go-charts`的新增参数,可根据实际使用场景添加。 diff --git a/go.mod b/go.mod index be8fc27..ff855cc 100644 --- a/go.mod +++ b/go.mod @@ -12,6 +12,6 @@ require ( require ( github.com/davecgh/go-spew v1.1.1 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect - golang.org/x/image v0.0.0-20220302094943-723b81ca9867 // indirect + golang.org/x/image v0.0.0-20220321031419-a8550c1d254a // indirect gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect ) diff --git a/go.sum b/go.sum index ab2ecae..56d77f9 100644 --- a/go.sum +++ b/go.sum @@ -13,8 +13,8 @@ github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/ github.com/wcharczuk/go-chart/v2 v2.1.0 h1:tY2slqVQ6bN+yHSnDYwZebLQFkphK4WNrVwnt7CJZ2I= github.com/wcharczuk/go-chart/v2 v2.1.0/go.mod h1:yx7MvAVNcP/kN9lKXM/NTce4au4DFN99j6i1OwDclNA= golang.org/x/image v0.0.0-20200927104501-e162460cd6b5/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= -golang.org/x/image v0.0.0-20220302094943-723b81ca9867 h1:TcHcE0vrmgzNH1v3ppjcMGbhG5+9fMuvOmUYwNEF4q4= -golang.org/x/image v0.0.0-20220302094943-723b81ca9867/go.mod h1:023OzeP/+EPmXeapQh35lcL3II3LrY8Ic+EFFKVhULM= +golang.org/x/image v0.0.0-20220321031419-a8550c1d254a h1:LnH9RNcpPv5Kzi15lXg42lYMPUf0x8CuPv1YnvBWZAg= +golang.org/x/image v0.0.0-20220321031419-a8550c1d254a/go.mod h1:023OzeP/+EPmXeapQh35lcL3II3LrY8Ic+EFFKVhULM= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=