g6/packages/site/docs/apis/interfaces/plugins-TooltipConfig.zh.md
pomelo 1eda86a093
V5 locale (#4870)
* feat: fix locale

* feat: update api doc
2023-08-29 18:39:28 +08:00

3.7 KiB
Raw Blame History

概述 - v5.0.0-alpha.9 / 模块 / 插件 / 工具提示配置

接口TooltipConfig

插件.TooltipConfig

等级制度

  • IPluginBaseConfig

    工具提示配置

特性

班级名称

可选 类名字符串

####继承自

IPluginBaseConfig.className

定义于

types/plugin.ts:6


容器

可选 容器字符串 | HTMLDivElement

####继承自

IPluginBaseConfig.container

定义于

types/plugin.ts:5


修复到节点

可选 fixToNode: [number, number] | 放置

定义于

stdlib/plugin/tooltip/index.ts:66


获取内容

可选 getContent: (evt?: IG6GraphEvent) => string | HTMLDivElement | Promise<字符串 | HTMLDivElement>

类型声明

▸ (evt?): 字符串 | HTMLDivElement | Promise<字符串 | HTMLDivElement>

参数

名称 类型
事件? IG6GraphEvent
返回

字符串 | HTMLDivElement | Promise<字符串 | HTMLDivElement>

定义于

stdlib/plugin/tooltip/index.ts:57


图表

可选 graph: IGraph<BehaviorRegistry, ThemeRegistry>

####继承自

IPluginBaseConfig.graph

定义于

types/plugin.ts:7


项目类型

可选 itemTypes: ("node" | "edge" | "combo" | "canvas")[]

定义于

stdlib/plugin/tooltip/index.ts:64


加载内容

可选 loadingContent字符串 | HTMLDivElement

定义于

stdlib/plugin/tooltip/index.ts:67


偏移X

可选 offsetX数字

定义于

stdlib/plugin/tooltip/index.ts:60


偏移Y

可选 offsetY数字

定义于

stdlib/plugin/tooltip/index.ts:61


应该开始

可选 shouldBegin: (evt?: IG6GraphEvent) => boolean

类型声明

▸ (evt?): 布尔值

参数

名称 类型
事件? IG6GraphEvent
返回

布尔值

定义于

stdlib/plugin/tooltip/index.ts:62


扳机

可选 触发"点击" | “指针输入器”

定义于

stdlib/plugin/tooltip/index.ts:65