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

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

99 lines
2.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [行为](../modules/behaviors.zh.md ) / 激活关系选项
# 接口ActivateRelationsOptions
[行为](../modules/behaviors.zh.md).ActivateRelationsOptions
特性
### 活动状态
`可选` **activeState**``“已选择”``
默认为“选定”。
#### 定义于
[stdlib/behavior/activate-relations.ts:37](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L37)
___
多种的
`可选` **多个**`布尔值`
是否允许多选。
默认为 true。
如果设置为 false“trigger”选项将被忽略。
#### 定义于
[stdlib/behavior/activate-relations.ts:24](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L24)
___
### 应该开始
`可选` **shouldBegin**: (`event`: [`IG6GraphEvent`](types-IG6GraphEvent.zh.md)) => `boolean`
#### 类型声明
▸ (`事件`): `布尔值`
是否允许该行为发生在当前项目上。
参数
| 名称 | 类型 |
| :------ | :------ |
| `事件` | [`IG6GraphEvent`](types-IG6GraphEvent.zh.md) |
##### 返回
`布尔值`
#### 定义于
[stdlib/behavior/activate-relations.ts:42](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L42)
___
### 应该更新
`可选` **shouldUpdate**: (`event`: [`IG6GraphEvent`](types-IG6GraphEvent.zh.md)) => `boolean`
#### 类型声明
▸ (`事件`): `布尔值`
是否更新项目状态。
如果它返回 false您可能会监听 `eventName`
手动管理状态或数据
参数
| 名称 | 类型 |
| :------ | :------ |
| `事件` | [`IG6GraphEvent`](types-IG6GraphEvent.zh.md) |
##### 返回
`布尔值`
#### 定义于
[stdlib/behavior/activate-relations.ts:48](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L48)
___
扳机
`可选` **触发**``"点击"`` \| ``“鼠标输入”``
单击鼠标按下该键以应用多项选择。
默认为“单击”。
可以是“单击”、“鼠标输入”。
#### 定义于
[stdlib/behavior/activate-relations.ts:30](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L30)