From a91e1d7d5354b8aaeedbca214ea7059cbf16dccf Mon Sep 17 00:00:00 2001 From: zhouxinyu Date: Thu, 26 Dec 2024 19:34:37 +0800 Subject: [PATCH] feat: add poptip option config --- docs/assets/option/en/common/attribute.md | 39 +++++++++++++++++++++++ docs/assets/option/zh/common/attribute.md | 39 +++++++++++++++++++++++ 2 files changed, 78 insertions(+) diff --git a/docs/assets/option/en/common/attribute.md b/docs/assets/option/en/common/attribute.md index 8ba9aa31c..05e2d42d6 100644 --- a/docs/assets/option/en/common/attribute.md +++ b/docs/assets/option/en/common/attribute.md @@ -219,3 +219,42 @@ shadowRoot 在宿主图元的上方还是下方,>0 为下方,<0 为上方 #${prefix} globalCompositeOperation(CanvasRenderingContext2D['globalCompositeOperation']) = '' 对应 Canvas 的 globalCompositeOperation,用来配置滤镜 + +#${prefix} poptip(any) = any +`poptip` 配置,在该图元位置展示配置的 poptip 元素,需要开启 poptip 功能。具体配置查看[poptip](/vrender/guide/asd/VRender_Components/VRender_Components_PopTip) + +##${prefix} position('auto' | 'top' | 'tl' | 'tr' | 'bottom' | 'bl' | 'br' | 'left' | 'lt' | 'lb' | 'right' | 'rt' | 'rb') = 'auto' +位置信息,默认自动定位 +##${prefix} title(string | string[] | number | number[]) +标题内容,如果需要进行换行,则使用数组形式,如 ['abc', '123'] +##${prefix} titleStyle(Partial) +标题文本样式 +##${prefix} titleFormatMethod((t: string | string[] | number | number[]) => string | string[] | number | number[]) +标题格式化函数 +##${prefix} content(string | string[] | number | number[]) +内容文本,如果需要进行换行,则使用数组形式,如 ['abc', '123'] +##${prefix} contentStyle(Partial) +内容文本样式 +##${prefix} contentFormatMethod((t: string | string[] | number | number[]) => string | string[] | number | number[]) +内容格式化函数 +##${prefix} space(number) +标题与内容的间距 +##${prefix} padding(Padding) +内部边距 +##${prefix} panel(BackgroundAttributes & ISymbolGraphicAttribute & { space?: number }) +标签的背景面板配置 +##${prefix} minWidth(number) = 30 +最小宽度,像素值 +##${prefix} maxWidth(number) +最大宽度,像素值。当文字超过最大宽度时,会自动省略。 +##${prefix} maxWidthPercent(number) +最大宽度比例 +##${prefix} visible(boolean) = true +是否可见 +##${prefix} visibleFunc((graphic: IGraphic) => boolean) = undefined +是否可见 + +##${prefix} dx(number) = 0 +x 方向的偏移 +##${prefix} dy(number) = 0 +y 方向的偏移 diff --git a/docs/assets/option/zh/common/attribute.md b/docs/assets/option/zh/common/attribute.md index 8ba9aa31c..05e2d42d6 100644 --- a/docs/assets/option/zh/common/attribute.md +++ b/docs/assets/option/zh/common/attribute.md @@ -219,3 +219,42 @@ shadowRoot 在宿主图元的上方还是下方,>0 为下方,<0 为上方 #${prefix} globalCompositeOperation(CanvasRenderingContext2D['globalCompositeOperation']) = '' 对应 Canvas 的 globalCompositeOperation,用来配置滤镜 + +#${prefix} poptip(any) = any +`poptip` 配置,在该图元位置展示配置的 poptip 元素,需要开启 poptip 功能。具体配置查看[poptip](/vrender/guide/asd/VRender_Components/VRender_Components_PopTip) + +##${prefix} position('auto' | 'top' | 'tl' | 'tr' | 'bottom' | 'bl' | 'br' | 'left' | 'lt' | 'lb' | 'right' | 'rt' | 'rb') = 'auto' +位置信息,默认自动定位 +##${prefix} title(string | string[] | number | number[]) +标题内容,如果需要进行换行,则使用数组形式,如 ['abc', '123'] +##${prefix} titleStyle(Partial) +标题文本样式 +##${prefix} titleFormatMethod((t: string | string[] | number | number[]) => string | string[] | number | number[]) +标题格式化函数 +##${prefix} content(string | string[] | number | number[]) +内容文本,如果需要进行换行,则使用数组形式,如 ['abc', '123'] +##${prefix} contentStyle(Partial) +内容文本样式 +##${prefix} contentFormatMethod((t: string | string[] | number | number[]) => string | string[] | number | number[]) +内容格式化函数 +##${prefix} space(number) +标题与内容的间距 +##${prefix} padding(Padding) +内部边距 +##${prefix} panel(BackgroundAttributes & ISymbolGraphicAttribute & { space?: number }) +标签的背景面板配置 +##${prefix} minWidth(number) = 30 +最小宽度,像素值 +##${prefix} maxWidth(number) +最大宽度,像素值。当文字超过最大宽度时,会自动省略。 +##${prefix} maxWidthPercent(number) +最大宽度比例 +##${prefix} visible(boolean) = true +是否可见 +##${prefix} visibleFunc((graphic: IGraphic) => boolean) = undefined +是否可见 + +##${prefix} dx(number) = 0 +x 方向的偏移 +##${prefix} dy(number) = 0 +y 方向的偏移