diff --git a/docs/common/legend-cfg.en.md b/docs/common/legend-cfg.en.md index 2aa5a7f7f1..3a88a18b4f 100644 --- a/docs/common/legend-cfg.en.md +++ b/docs/common/legend-cfg.en.md @@ -157,6 +157,24 @@ Apply to Classification legend _number_ **optional** + +适用于 分类图例,图例项最大宽度设置。 + +##### maxWidthRatio + + _number_ **optional**. 取值范围:[0, 1], 默认: 0.25 + +适用于 分类图例,图例项容器最大宽度比例(以 view 的 bbox 容器大小为参照)设置,如果不需要该配置,可以设置为 `null`。 + +##### maxHeightRatio + + _number_ **optional**. 取值范围:[0, 1], 默认: 0.25 + +适用于 分类图例,图例项容器最大高度比例(以 view 的 bbox 容器大小为参照)设置,如果不需要该配置,可以设置为 `null`。 + ##### maxWidth **optional** _number_ diff --git a/docs/common/legend-cfg.zh.md b/docs/common/legend-cfg.zh.md index e9e78cc2a5..1ad1538d09 100644 --- a/docs/common/legend-cfg.zh.md +++ b/docs/common/legend-cfg.zh.md @@ -175,17 +175,45 @@ pageNavigator: { `markdown:docs/common/marker.zh.md` +##### maxItemWidth + + _number_ **optional** + +适用于 分类图例,图例项最大宽度设置。 + +##### maxWidthRatio + + _number_ **optional**. 取值范围:[0, 1], 默认: 0.25 + +适用于 分类图例,图例项容器最大宽度比例(以 view 的 bbox 容器大小为参照)设置,如果不需要该配置,可以设置为 `null`。 + +##### maxHeightRatio + + _number_ **optional**. 取值范围:[0, 1], 默认: 0.25 + +适用于 分类图例,图例项容器最大高度比例(以 view 的 bbox 容器大小为参照)设置,如果不需要该配置,可以设置为 `null`。 + ##### maxWidth **optional** _number_ -适用于 分类图例,图例项最大宽度设置。当 layout 等于 'horizontal' 时,生效,当图例项横向排布,超过最大宽度时,会结合 `flipPage: true` 进行分页。 +适用于 分类图例,图例项容器最大宽度设置。当 layout 等于 'horizontal' 时,生效,当图例项横向排布,超过最大宽度时,会结合 `flipPage: true` 进行分页。实际上,图例项容器最大宽度的计算如下: + +```sign +const viewBBox = this.view.viewBBox; +const maxWidth = Math.min(maxWidth, maxWidthRatio * viewBBox.width); +``` ##### maxHeight **optional** _number_ -适用于 分类图例,图例项最大高度设置。当 layout 等于 'vertical' 时,生效,当图例项纵向排布,超过最大高度时,会结合 `flipPage: true` 进行分页。 +适用于 分类图例,图例项容器最大高度设置。当 layout 等于 'vertical' 时,生效,当图例项纵向排布,超过最大高度时,会结合 `flipPage: true` 进行分页。实际上,图例项容器最大宽度的计算如下: + +```sign +const viewBBox = this.view.viewBBox; +const maxHeight = Math.min(maxHeight, maxHeightRatio * viewBBox.height); +``` ##### reversed