Skip to content

Commit

Permalink
docs(legend): 图例增加宽度,高度容器按照比例设置大小参数 (#2711)
Browse files Browse the repository at this point in the history
close: #2511
  • Loading branch information
visiky authored Jul 21, 2021
1 parent 46d2769 commit 3fb32f0
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 2 deletions.
18 changes: 18 additions & 0 deletions docs/common/legend-cfg.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,24 @@ Apply to <tag color="green" text="Classification legend">Classification legend</

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

##### maxItemWidth

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

适用于 <tag color="green" text="分类图例">分类图例</tag>,图例项最大宽度设置。

##### maxWidthRatio

<description> _number_ **optional**. 取值范围:[0, 1], 默认: 0.25</description>

适用于 <tag color="green" text="分类图例">分类图例</tag>,图例项容器最大宽度比例(以 view 的 bbox 容器大小为参照)设置,如果不需要该配置,可以设置为 `null`

##### maxHeightRatio

<description> _number_ **optional**. 取值范围:[0, 1], 默认: 0.25</description>

适用于 <tag color="green" text="分类图例">分类图例</tag>,图例项容器最大高度比例(以 view 的 bbox 容器大小为参照)设置,如果不需要该配置,可以设置为 `null`

##### maxWidth

<description>**optional** _number_ </description>
Expand Down
32 changes: 30 additions & 2 deletions docs/common/legend-cfg.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,17 +175,45 @@ pageNavigator: {

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

##### maxItemWidth

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

适用于 <tag color="green" text="分类图例">分类图例</tag>,图例项最大宽度设置。

##### maxWidthRatio

<description> _number_ **optional**. 取值范围:[0, 1], 默认: 0.25</description>

适用于 <tag color="green" text="分类图例">分类图例</tag>,图例项容器最大宽度比例(以 view 的 bbox 容器大小为参照)设置,如果不需要该配置,可以设置为 `null`

##### maxHeightRatio

<description> _number_ **optional**. 取值范围:[0, 1], 默认: 0.25</description>

适用于 <tag color="green" text="分类图例">分类图例</tag>,图例项容器最大高度比例(以 view 的 bbox 容器大小为参照)设置,如果不需要该配置,可以设置为 `null`

##### maxWidth

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

适用于 <tag color="green" text="分类图例">分类图例</tag>,图例项最大宽度设置。当 layout 等于 'horizontal' 时,生效,当图例项横向排布,超过最大宽度时,会结合 `flipPage: true` 进行分页。
适用于 <tag color="green" text="分类图例">分类图例</tag>,图例项容器最大宽度设置。当 layout 等于 'horizontal' 时,生效,当图例项横向排布,超过最大宽度时,会结合 `flipPage: true` 进行分页。实际上,图例项容器最大宽度的计算如下:

```sign
const viewBBox = this.view.viewBBox;
const maxWidth = Math.min(maxWidth, maxWidthRatio * viewBBox.width);
```

##### maxHeight

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

适用于 <tag color="green" text="分类图例">分类图例</tag>,图例项最大高度设置。当 layout 等于 'vertical' 时,生效,当图例项纵向排布,超过最大高度时,会结合 `flipPage: true` 进行分页。
适用于 <tag color="green" text="分类图例">分类图例</tag>,图例项容器最大高度设置。当 layout 等于 'vertical' 时,生效,当图例项纵向排布,超过最大高度时,会结合 `flipPage: true` 进行分页。实际上,图例项容器最大宽度的计算如下:

```sign
const viewBBox = this.view.viewBBox;
const maxHeight = Math.min(maxHeight, maxHeightRatio * viewBBox.height);
```

##### reversed

Expand Down

0 comments on commit 3fb32f0

Please sign in to comment.