test/g6
1
0
Fork 0
mirror of https://gitee.com/antv/g6.git synced 2024-11-30 10:48:24 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

feat: fix plugin demo with extensions (#4885)

Browse Source 
* feat: fix plugin demo with extensions

* Chore：check translate (#4886)

* feat: check plugins

* chore: update docs
This commit is contained in:
pomelo 2023-08-30 12:43:08 -05:00 committed by GitHub
parent b9274e9ab2
commit 339f28c564
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
144 changed files with 2279 additions and 9857 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
packages/g6/src/stdlib/plugin/fisheye/index.ts
View File

@ -7,20 +7,48 @@ import { ShapeStyle } from '../../../types/item';
import { Plugin as Base, IPluginBaseConfig } from '../../../types/plugin'; import { Plugin as Base, IPluginBaseConfig } from '../../../types/plugin';
const DELTA = 0.05; const DELTA = 0.05;
/**
* This is an interface named `FisheyeConfig`, which extends the `IPluginBaseConfig` interface. It contains the following properties:
- `trigger`: The trigger method, which can be `'mousemove'`, `'click'`, or `'drag'`.
- `d`: A number representing the magnification factor of the fisheye.
- `r`: A number representing the radius of the fisheye.
- `delegateStyle`: The shape style.
- `showLabel`: A boolean indicating whether to show the label.
- `scaleRBy`: Can be `'wheel'`, `'drag'`, `'unset'`, or `undefined`, representing the scaling method for the fisheye radius.
- `scaleDBy`: Can be `'wheel'`, `'drag'`, `'unset'`, or `undefined`, representing the scaling method for the fisheye magnification factor.
- `maxR`: A number representing the maximum value of the fisheye radius.
- `minR`: A number representing the minimum value of the fisheye radius.
- `maxD`: A number representing the maximum value of the fisheye magnification factor.
- `minD`: A number representing the minimum value of the fisheye magnification factor.
- `throttle`: A number representing the throttle time (in milliseconds).
- `showDPercent`: A boolean indicating whether to show the percentage of the fisheye magnification factor.
*/
export interface FisheyeConfig extends IPluginBaseConfig { export interface FisheyeConfig extends IPluginBaseConfig {
/** The trigger method, which can be `'mousemove'`, `'click'`, or `'drag'`. */
trigger?: 'mousemove' | 'click' | 'drag'; trigger?: 'mousemove' | 'click' | 'drag';
/** A number representing the magnification factor of the fisheye. */
d?: number; d?: number;
/** A number representing the radius of the fisheye. */
r?: number; r?: number;
/** The shape style */
delegateStyle?: ShapeStyle; delegateStyle?: ShapeStyle;
/** A boolean indicating whether to show the label. */
showLabel?: boolean; showLabel?: boolean;
/** Can be `'wheel'`, `'drag'`, `'unset'`, or `undefined`, representing the scaling method for the fisheye radius. */
scaleRBy?: 'wheel' | 'drag' | 'unset' | undefined; scaleRBy?: 'wheel' | 'drag' | 'unset' | undefined;
/** Can be `'wheel'`, `'drag'`, `'unset'`, or `undefined`, representing the scaling method for the fisheye magnification factor. */
scaleDBy?: 'wheel' | 'drag' | 'unset' | undefined; scaleDBy?: 'wheel' | 'drag' | 'unset' | undefined;
/** A number representing the maximum value of the fisheye radius. */
maxR?: number; maxR?: number;
/** A number representing the minimum value of the fisheye radius. */
minR?: number; minR?: number;
/** A number representing the maximum value of the fisheye magnification factor. */
maxD?: number; maxD?: number;
/** A number representing the minimum value of the fisheye magnification factor. */
minD?: number; minD?: number;
/** A number representing the throttle time (in milliseconds). */
throttle?: number; throttle?: number;
/** A boolean indicating whether to show the percentage of the fisheye magnification factor. */
showDPercent?: boolean; showDPercent?: boolean;
} }

7
packages/g6/src/stdlib/plugin/grid/index.ts
View File

@ -7,6 +7,13 @@ import { Plugin as Base, IPluginBaseConfig } from '../../../types/plugin';
const GRID_PNG = const GRID_PNG =
'url(data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iNDAiIGhlaWdodD0iNDAiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+PGRlZnM+PHBhdHRlcm4gaWQ9ImdyaWQiIHdpZHRoPSI0MCIgaGVpZ2h0PSI0MCIgcGF0dGVyblVuaXRzPSJ1c2VyU3BhY2VPblVzZSI+PHBhdGggZD0iTSAwIDEwIEwgNDAgMTAgTSAxMCAwIEwgMTAgNDAgTSAwIDIwIEwgNDAgMjAgTSAyMCAwIEwgMjAgNDAgTSAwIDMwIEwgNDAgMzAgTSAzMCAwIEwgMzAgNDAiIGZpbGw9Im5vbmUiIHN0cm9rZT0iI2UwZTBlMCIgb3BhY2l0eT0iMC4yIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNIDQwIDAgTCAwIDAgMCA0MCIgZmlsbD0ibm9uZSIgc3Ryb2tlPSIjZTBlMGUwIiBzdHJva2Utd2lkdGg9IjEiLz48L3BhdHRlcm4+PC9kZWZzPjxyZWN0IHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiIGZpbGw9InVybCgjZ3JpZCkiLz48L3N2Zz4=)'; 'url(data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iNDAiIGhlaWdodD0iNDAiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+PGRlZnM+PHBhdHRlcm4gaWQ9ImdyaWQiIHdpZHRoPSI0MCIgaGVpZ2h0PSI0MCIgcGF0dGVyblVuaXRzPSJ1c2VyU3BhY2VPblVzZSI+PHBhdGggZD0iTSAwIDEwIEwgNDAgMTAgTSAxMCAwIEwgMTAgNDAgTSAwIDIwIEwgNDAgMjAgTSAyMCAwIEwgMjAgNDAgTSAwIDMwIEwgNDAgMzAgTSAzMCAwIEwgMzAgNDAiIGZpbGw9Im5vbmUiIHN0cm9rZT0iI2UwZTBlMCIgb3BhY2l0eT0iMC4yIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNIDQwIDAgTCAwIDAgMCA0MCIgZmlsbD0ibm9uZSIgc3Ryb2tlPSIjZTBlMGUwIiBzdHJva2Utd2lkdGg9IjEiLz48L3BhdHRlcm4+PC9kZWZzPjxyZWN0IHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiIGZpbGw9InVybCgjZ3JpZCkiLz48L3N2Zz4=)';
/**
* This is an interface named `GridConfig`, which extends the `IPluginBaseConfig` interface. It contains the following properties:
- `img`: A string representing the background image of the grid.
- `follow`: A boolean indicating whether the grid follows the view movement.
*/
export interface GridConfig extends IPluginBaseConfig { export interface GridConfig extends IPluginBaseConfig {
img?: string; img?: string;
follow?: boolean; follow?: boolean;

20
packages/g6/src/stdlib/plugin/history/index.ts
View File

@ -4,6 +4,26 @@ import { STACK_TYPE, StackCfg, StackType } from '../../../types/history';
import { Plugin as Base, IPluginBaseConfig } from '../../../types/plugin'; import { Plugin as Base, IPluginBaseConfig } from '../../../types/plugin';
import CommandFactory, { Command } from './command'; import CommandFactory, { Command } from './command';
/**
* The `HistoryConfig` interface contains the following properties:
- `enableStack`: An optional boolean value that indicates whether to enable the stack.
- `stackCfg`: A required object of type `StackCfg` representing the stack configuration.
The `StackCfg` type is defined as an object with the following properties:
- `stackSize`: An optional number representing the size of the stack.
- `stackActive`: An optional boolean value indicating whether the stack is active. If active, operations can be pushed onto the stack; otherwise, they cannot.
- `excludes`: An optional array of strings representing APIs that should be excluded from being put on the stack, even if their operation type is not ignored.
- `includes`: An optional array of strings representing APIs that should be included in being put on the stack.
- `ignoreAdd`: An optional boolean value indicating whether to ignore add operations.
- `ignoreRemove`: An optional boolean value indicating whether to ignore remove operations.
- `ignoreUpdate`: An optional boolean value indicating whether to ignore update operations.
- `ignoreStateChange`: An optional boolean value indicating whether to ignore state change operations.
- `ignoreLayerChange`: An optional boolean value indicating whether to ignore layer change operations.
- `ignoreDisplayChange`: An optional boolean value indicating whether to ignore display change operations.
*/
export interface HistoryConfig extends IPluginBaseConfig { export interface HistoryConfig extends IPluginBaseConfig {
enableStack?: boolean; enableStack?: boolean;
stackCfg: StackCfg; stackCfg: StackCfg;

14
packages/g6/src/stdlib/plugin/menu/index.ts
View File

@ -1,5 +1,4 @@
import { createDom, modifyCSS } from '@antv/dom-util'; import { createDom, modifyCSS } from '@antv/dom-util';
import { AABB } from '@antv/g';
import { isString } from '@antv/util'; import { isString } from '@antv/util';
import insertCss from 'insert-css'; import insertCss from 'insert-css';
import Item from 'item/item'; import Item from 'item/item';
@ -35,7 +34,20 @@ typeof document !== 'undefined' &&
100% { transform: rotate(360deg); } 100% { transform: rotate(360deg); }
} }
`); `);
/**
* The `MenuConfig` interface contains the following properties:
- `handleMenuClick`: An optional function for handling menu click events. It takes two arguments: `target` (of type HTMLElement) and `item` (of type Item), and has no return value.
- `getContent`: An optional function for getting the content of the menu. It takes an optional argument of type `IG6GraphEvent`, and returns a value of type HTMLDivElement, string, or Promise (resolving to HTMLDivElement or string).
- `offsetX`: An optional number representing the offset of the menu in the X direction.
- `offsetY`: An optional number representing the offset of the menu in the Y direction.
- `shouldBegin`: An optional function for determining whether the menu should be displayed. It takes an optional argument of type `IG6GraphEvent`, and returns a boolean value.
- `itemTypes`: An optional array of strings representing the types of items for which the menu is allowed to be displayed.
- `trigger`: An optional string, either 'click' or 'contextmenu', representing the event type that triggers the display of the menu.
- `onHide`: An optional function to be executed when the menu is hidden. It takes no arguments and returns a boolean value.
- `loadingContent`: An optional HTMLDivElement or string representing the loading DOM.
- `liHoverStyle`: An optional object representing the style of li elements when hovered over. It can contain any number of key-value pairs, where the key is a style name and the value is a string.
*/
export interface MenuConfig extends IPluginBaseConfig { export interface MenuConfig extends IPluginBaseConfig {
handleMenuClick?: (target: HTMLElement, item: Item) => void; handleMenuClick?: (target: HTMLElement, item: Item) => void;
// return the content of menu, support the `Promise` type return value. // return the content of menu, support the `Promise` type return value.

11
packages/g6/src/stdlib/plugin/minimap/index.ts
View File

@ -15,14 +15,23 @@ const DELEGATE_MODE = 'delegate';
const SVG = 'svg'; const SVG = 'svg';
export interface MiniMapConfig extends IPluginBaseConfig { export interface MiniMapConfig extends IPluginBaseConfig {
/** Class name of viewport */
viewportClassName?: string; viewportClassName?: string;
/** Class name of minimap */
className?: string; className?: string;
/** Mode of minimap */
mode?: 'default' | 'keyShape' | 'delegate'; mode?: 'default' | 'keyShape' | 'delegate';
/** Size of minimap */
size?: number[]; size?: number[];
/** Style of delegate shape */
delegateStyle?: ShapeStyle; delegateStyle?: ShapeStyle;
/** Whether to refresh minimap */
refresh?: boolean; refresh?: boolean;
/** Padding of minimap */
padding?: number; padding?: number;
hideEdge?: boolean; // hide the edges on the minimap to enhance the performance /** Whether to hide edges on minimap to enhance performance */
hideEdge?: boolean;
/** Container for minimap */
container?: HTMLDivElement | null; container?: HTMLDivElement | null;
} }

39
packages/g6/src/stdlib/plugin/toolbar/index.ts
View File

@ -4,38 +4,25 @@ import { IGraph } from '../../../types';
import { Plugin as Base, IPluginBaseConfig } from '../../../types/plugin'; import { Plugin as Base, IPluginBaseConfig } from '../../../types/plugin';
/** /**
* @example * The `ToolbarConfig` interface contains the following properties:
* const {Graph} from '@antv/g6';
* const toolbar:ToolbarConfig = { - `handleClick`: An optional function for handling clicks on the toolbar. It takes two arguments: `code` (of type string) and `graph` (of type IGraph), and has no return value.
* type:"toolbar", - `getContent`: A required function for getting the content of the toolbar. It takes an optional argument of type `IGraph`, and returns a value of type HTMLDivElement or string.
* handleClick:()=>{} - `zoomSensitivity`: An optional number representing the zoom sensitivity of the toolbar. The default value is 10.
* } - `minZoom`: An optional number representing the minimum zoom ratio of the toolbar. The default value is 0.00001.
* new Graph({ - `maxZoom`: An optional number representing the maximum zoom ratio of the toolbar. The default value is 1000.
* plugins:[toolbar]
* })
*
*/ */
export interface ToolbarConfig extends IPluginBaseConfig { export interface ToolbarConfig extends IPluginBaseConfig {
/** /** Function for handling clicks on toolbar */
* toolbar config
* @param code toolbar item code
* @param graph Graph Instance
* @returns
*/
handleClick?: (code: string, graph: IGraph) => void; handleClick?: (code: string, graph: IGraph) => void;
/** Function for getting content of toolbar */
getContent: (graph?: IGraph) => HTMLDivElement | string; getContent: (graph?: IGraph) => HTMLDivElement | string;
/** /** Zoom sensitivity of toolbar */
* @default 10
*/
zoomSensitivity: number; zoomSensitivity: number;
/** /** Minimum zoom ratio of toolbar */
* @default 0.00001
*/
minZoom: number; minZoom: number;
/** /** Maximum zoom ratio of toolbar */
* 最小缩放比率
* @default 1000
*/
maxZoom: number; maxZoom: number;
} }

23
packages/g6/src/stdlib/plugin/tooltip/index.ts
View File

@ -53,20 +53,39 @@ type Placement =
| 'bottomRight' | 'bottomRight'
| 'rightBottom'; | 'rightBottom';
/**
* The `TooltipConfig` interface contains the following properties:
- `getContent`: An optional function for getting the content of the tooltip. It takes an optional argument of type `IG6GraphEvent`, and returns a value of type HTMLDivElement, string, or Promise (resolving to HTMLDivElement or string).
- `offsetX`: An optional number representing the offset of the tooltip in the X direction.
- `offsetY`: An optional number representing the offset of the tooltip in the Y direction.
- `shouldBegin`: An optional function for determining whether the tooltip should be displayed. It takes an optional argument of type `IG6GraphEvent`, and returns a boolean value.
- `itemTypes`: An optional array of strings representing the types of items for which the tooltip is allowed to be displayed. The possible values are 'node', 'edge', 'combo', and 'canvas'.
- `trigger`: An optional string, either 'pointerenter' or 'click', representing the event type that triggers the display of the tooltip.
- `fixToNode`: An optional array of two numbers, a string representing a placement, or undefined, representing how to fix the tooltip to a node.
- `loadingContent`: An optional HTMLDivElement or string representing the loading DOM.
*/
export interface TooltipConfig extends IPluginBaseConfig { export interface TooltipConfig extends IPluginBaseConfig {
/** Function for getting tooltip content */
getContent?: ( getContent?: (
evt?: IG6GraphEvent, evt?: IG6GraphEvent,
) => HTMLDivElement | string | Promise<HTMLDivElement | string>; ) => HTMLDivElement | string | Promise<HTMLDivElement | string>;
/** Offset of tooltip in X direction */
offsetX?: number; offsetX?: number;
/** Offset of tooltip in Y direction */
offsetY?: number; offsetY?: number;
/** Determine whether to display tooltip */
shouldBegin?: (evt?: IG6GraphEvent) => boolean; shouldBegin?: (evt?: IG6GraphEvent) => boolean;
// more detail type instead of "string[]" /** Types of items for which tooltip is allowed to be displayed */
itemTypes?: ('node' | 'edge' | 'combo' | 'canvas')[]; itemTypes?: ('node' | 'edge' | 'combo' | 'canvas')[];
/** Event type that triggers display of tooltip */
trigger?: 'pointerenter' | 'click'; trigger?: 'pointerenter' | 'click';
/** How to fix tooltip to node */
fixToNode?: [number, number] | Placement | undefined; fixToNode?: [number, number] | Placement | undefined;
/** Loading DOM */
loadingContent?: HTMLDivElement | string; loadingContent?: HTMLDivElement | string;
} }
export class Tooltip extends Base { export class Tooltip extends Base {
private tooltip; private tooltip;
private container; private container;

6
packages/g6/src/types/history.ts
View File

@ -1,4 +1,5 @@
export type StackCfg = { export type StackCfg = {
/** A number representing the size of the stack. */
stackSize?: number; stackSize?: number;
/** Indicate whether the stack is active. If active, operations can be pushed onto the stack; otherwise, cannot. */ /** Indicate whether the stack is active. If active, operations can be pushed onto the stack; otherwise, cannot. */
stackActive?: boolean; stackActive?: boolean;
@ -9,10 +10,15 @@ export type StackCfg = {
includes?: string[]; includes?: string[];
/** ignore* is a global setting that indicates whether to ignore a certain type of operation */ /** ignore* is a global setting that indicates whether to ignore a certain type of operation */
ignoreAdd?: boolean; ignoreAdd?: boolean;
/** A boolean indicating whether to ignore remove operations. */
ignoreRemove?: boolean; ignoreRemove?: boolean;
/** A boolean indicating whether to ignore update operations. */
ignoreUpdate?: boolean; ignoreUpdate?: boolean;
/** A boolean indicating whether to ignore state change operations.*/
ignoreStateChange?: boolean; ignoreStateChange?: boolean;
/** A boolean indicating whether to ignore layer change operations. */
ignoreLayerChange?: boolean; ignoreLayerChange?: boolean;
/** A boolean indicating whether to ignore display change operations. */
ignoreDisplayChange?: boolean; ignoreDisplayChange?: boolean;
}; };

4
packages/site/docs/apis/.nojekyll
View File

@ -1 +1,5 @@
---
title:
---
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

14
packages/site/docs/apis/README.en.md
View File

@ -1,5 +1,19 @@
---
title: README
---
Overview / [Modules](modules.en.md) Overview / [Modules](modules.en.md)
# G6 API Core Modules
- [behaviors](modules/behaviors.en.md)
- [graph](modules/graph.en.md)
- [item](modules/item.en.md)
- [layout](modules/layout.en.md)
- [plugins](modules/plugins.en.md)
- [types](modules/types.en.md)
- [util](modules/util.en.md)
```jsx ```jsx
import { Graph, Util } from '@antv/g6'; import { Graph, Util } from '@antv/g6';
const data = Util.mock(6).circle(); const data = Util.mock(6).circle();

14
packages/site/docs/apis/README.zh.md
View File

@ -1,5 +1,19 @@
---
title: README
---
概述 / [模块](modules.zh.md) 概述 / [模块](modules.zh.md)
# G6 API 核心模块
- [行为](modules/behaviors.zh.md)
- [图](modules/graph.zh.md)
- [项目](modules/item.zh.md)
- [布局](modules/layout.zh.md)
- [插件](modules/plugins.zh.md)
- [类型](modules/types.zh.md)
- [util](modules/util.zh.md)
````jsx ````jsx
从 '@antv/g6' 导入 { Graph, Util }; 从 '@antv/g6' 导入 { Graph, Util };
const data = Util.mock(6).circle(); const data = Util.mock(6).circle();

2361
packages/site/docs/apis/classes/graph-Graph.en.md
View File

File diff suppressed because it is too large Load Diff

0
packages/site/docs/apis/classes/graph-Graph.zh.md
View File

220
packages/site/docs/apis/classes/graph/Graph.en.md
View File

@ -51,7 +51,7 @@ whether success
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1549](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1549) [packages/g6/src/runtime/graph.ts:1543](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1543)
___ ___
@ -77,7 +77,7 @@ Collapse a combo.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1594](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1594) [packages/g6/src/runtime/graph.ts:1588](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1588)
___ ___
@ -103,7 +103,7 @@ Expand a combo.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1614](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1614) [packages/g6/src/runtime/graph.ts:1608](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1608)
___ ___
@ -123,7 +123,7 @@ In fact, it changes the succeed nodes positions to affect the combo's position,
| `dx` | `number` | | `dx` | `number` |
| `dy` | `number` | | `dy` | `number` |
| `upsertAncestors?` | `boolean` | | `upsertAncestors?` | `boolean` |
| `callback?` | (`model`: `NodeModel` \| `ComboModel` \| `EdgeModel`, `canceled?`: `boolean`) => `void` | | `callback?` | (`model`: `NodeModel` \| `EdgeModel` \| `ComboModel`, `canceled?`: `boolean`) => `void` |
#### Returns #### Returns
@ -135,7 +135,7 @@ In fact, it changes the succeed nodes positions to affect the combo's position,
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1637](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1637) [packages/g6/src/runtime/graph.ts:1631](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1631)
## Constructors ## Constructors
@ -162,13 +162,13 @@ EventEmitter.constructor
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:106](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L106) [packages/g6/src/runtime/graph.ts:100](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L100)
## Data ## Data
### addData ### addData
▸ **addData**(`itemType`, `models`): `NodeModel` \| `ComboModel` \| `EdgeModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[] ▸ **addData**(`itemType`, `models`): `NodeModel` \| `EdgeModel` \| `ComboModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[]
Add one or more node/edge/combo data to the graph. Add one or more node/edge/combo data to the graph.
@ -177,11 +177,11 @@ Add one or more node/edge/combo data to the graph.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `itemType` | `ITEM_TYPE` | item type | | `itemType` | `ITEM_TYPE` | item type |
| `models` | `NodeUserModel` \| `ComboUserModel` \| `EdgeUserModel` \| `NodeUserModel`[] \| `EdgeUserModel`[] \| `ComboUserModel`[] | - | | `models` | `NodeUserModel` \| `EdgeUserModel` \| `ComboUserModel` \| `NodeUserModel`[] \| `EdgeUserModel`[] \| `ComboUserModel`[] | - |
#### Returns #### Returns
`NodeModel` \| `ComboModel` \| `EdgeModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[] `NodeModel` \| `EdgeModel` \| `ComboModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[]
whether success whether success
@ -191,7 +191,7 @@ whether success
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:975](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L975) [packages/g6/src/runtime/graph.ts:969](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L969)
___ ___
@ -218,7 +218,7 @@ Change graph data.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:456](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L456) [packages/g6/src/runtime/graph.ts:450](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L450)
___ ___
@ -240,7 +240,7 @@ all combos' inner data on the graph
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:886](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L886) [packages/g6/src/runtime/graph.ts:880](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L880)
___ ___
@ -262,7 +262,7 @@ all edges' inner data on the graph
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:878](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L878) [packages/g6/src/runtime/graph.ts:872](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L872)
___ ___
@ -284,7 +284,7 @@ all nodes' inner data on the graph
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:870](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L870) [packages/g6/src/runtime/graph.ts:864](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L864)
___ ___
@ -312,7 +312,7 @@ children's data array
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:919](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L919) [packages/g6/src/runtime/graph.ts:913](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L913)
___ ___
@ -340,7 +340,7 @@ result combo's inner data
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:860](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L860) [packages/g6/src/runtime/graph.ts:854](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L854)
___ ___
@ -368,7 +368,7 @@ result edge's inner data
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:847](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L847) [packages/g6/src/runtime/graph.ts:841](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L841)
___ ___
@ -394,7 +394,7 @@ Retrieve the nearby edges for a given node using quadtree collision detection.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:940](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L940) [packages/g6/src/runtime/graph.ts:934](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L934)
___ ___
@ -423,7 +423,7 @@ one-hop nodes' data array
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:907](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L907) [packages/g6/src/runtime/graph.ts:901](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L901)
___ ___
@ -451,7 +451,7 @@ result node's inner data
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:836](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L836) [packages/g6/src/runtime/graph.ts:830](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L830)
___ ___
@ -480,7 +480,7 @@ one-hop edges' data array
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:895](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L895) [packages/g6/src/runtime/graph.ts:889](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L889)
___ ___
@ -507,7 +507,7 @@ If there is old data, diffs and changes it.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:405](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L405) [packages/g6/src/runtime/graph.ts:399](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L399)
___ ___
@ -536,13 +536,13 @@ whether success
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1032](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1032) [packages/g6/src/runtime/graph.ts:1026](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1026)
___ ___
### updateComboPosition ### updateComboPosition
▸ **updateComboPosition**(`models`, `upsertAncestors?`, `disableAnimate?`, `callback?`, `stack?`): `NodeModel` \| `ComboModel` \| `EdgeModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[] ▸ **updateComboPosition**(`models`, `upsertAncestors?`, `disableAnimate?`, `callback?`, `stack?`): `NodeModel` \| `EdgeModel` \| `ComboModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[]
Update one or more combos' positions, Update one or more combos' positions,
do not update other styles which leads to better performance than updating positions by updateData. do not update other styles which leads to better performance than updating positions by updateData.
@ -555,12 +555,12 @@ In fact, it changes the succeed nodes positions to affect the combo's position,
| `models` | `Partial`<`NodeUserModel`\> \| `Partial`<`ComboUserModel` \| `Partial`<`NodeUserModel`\>[] \| `Partial`<`ComboUserModel`\>[]\> | `undefined` | new configurations with x and y for every combo, which has id field to indicate the specific item | | `models` | `Partial`<`NodeUserModel`\> \| `Partial`<`ComboUserModel` \| `Partial`<`NodeUserModel`\>[] \| `Partial`<`ComboUserModel`\>[]\> | `undefined` | new configurations with x and y for every combo, which has id field to indicate the specific item |
| `upsertAncestors?` | `boolean` | `undefined` | - | | `upsertAncestors?` | `boolean` | `undefined` | - |
| `disableAnimate` | `boolean` | `false` | - | | `disableAnimate` | `boolean` | `false` | - |
| `callback?` | (`model`: `NodeModel` \| `ComboModel` \| `EdgeModel`) => `void` | `undefined` | - | | `callback?` | (`model`: `NodeModel` \| `EdgeModel` \| `ComboModel`) => `void` | `undefined` | - |
| `stack?` | `boolean` | `undefined` | - | | `stack?` | `boolean` | `undefined` | - |
#### Returns #### Returns
`NodeModel` \| `ComboModel` \| `EdgeModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[] `NodeModel` \| `EdgeModel` \| `ComboModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[]
#### Implementation of #### Implementation of
@ -568,13 +568,13 @@ In fact, it changes the succeed nodes positions to affect the combo's position,
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1211](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1211) [packages/g6/src/runtime/graph.ts:1205](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1205)
___ ___
### updateData ### updateData
▸ **updateData**(`itemType`, `models`): `NodeModel` \| `ComboModel` \| `EdgeModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[] ▸ **updateData**(`itemType`, `models`): `NodeModel` \| `EdgeModel` \| `ComboModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[]
Update one or more node/edge/combo data on the graph. Update one or more node/edge/combo data on the graph.
@ -587,7 +587,7 @@ Update one or more node/edge/combo data on the graph.
#### Returns #### Returns
`NodeModel` \| `ComboModel` \| `EdgeModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[] `NodeModel` \| `EdgeModel` \| `ComboModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[]
#### Implementation of #### Implementation of
@ -595,13 +595,13 @@ Update one or more node/edge/combo data on the graph.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1122](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1122) [packages/g6/src/runtime/graph.ts:1116](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1116)
___ ___
### updateNodePosition ### updateNodePosition
▸ **updateNodePosition**(`models`, `upsertAncestors?`, `disableAnimate?`, `callback?`, `stack?`): `NodeModel` \| `ComboModel` \| `EdgeModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[] ▸ **updateNodePosition**(`models`, `upsertAncestors?`, `disableAnimate?`, `callback?`, `stack?`): `NodeModel` \| `EdgeModel` \| `ComboModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[]
Update one or more nodes' positions, Update one or more nodes' positions,
do not update other styles which leads to better performance than updating positions by updateData. do not update other styles which leads to better performance than updating positions by updateData.
@ -613,12 +613,12 @@ do not update other styles which leads to better performance than updating posit
| `models` | `Partial`<`NodeUserModel`\> \| `Partial`<`ComboUserModel` \| `Partial`<`NodeUserModel`\>[] \| `Partial`<`ComboUserModel`\>[]\> | `undefined` | new configurations with x and y for every node, which has id field to indicate the specific item | | `models` | `Partial`<`NodeUserModel`\> \| `Partial`<`ComboUserModel` \| `Partial`<`NodeUserModel`\>[] \| `Partial`<`ComboUserModel`\>[]\> | `undefined` | new configurations with x and y for every node, which has id field to indicate the specific item |
| `upsertAncestors?` | `boolean` | `undefined` | - | | `upsertAncestors?` | `boolean` | `undefined` | - |
| `disableAnimate` | `boolean` | `false` | - | | `disableAnimate` | `boolean` | `false` | - |
| `callback?` | (`model`: `NodeModel` \| `ComboModel` \| `EdgeModel`, `canceled?`: `boolean`) => `void` | `undefined` | - | | `callback?` | (`model`: `NodeModel` \| `EdgeModel` \| `ComboModel`, `canceled?`: `boolean`) => `void` | `undefined` | - |
| `stack?` | `boolean` | `undefined` | - | | `stack?` | `boolean` | `undefined` | - |
#### Returns #### Returns
`NodeModel` \| `ComboModel` \| `EdgeModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[] `NodeModel` \| `EdgeModel` \| `ComboModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[]
#### Implementation of #### Implementation of
@ -626,7 +626,7 @@ do not update other styles which leads to better performance than updating posit
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1180](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1180) [packages/g6/src/runtime/graph.ts:1174](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1174)
## Graph Instance ## Graph Instance
@ -652,7 +652,7 @@ Destroy the graph instance and remove the related canvases.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2187](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2187) [packages/g6/src/runtime/graph.ts:2181](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2181)
## Interaction ## Interaction
@ -679,7 +679,7 @@ Add behavior(s) to mode(s).
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1777](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1777) [packages/g6/src/runtime/graph.ts:1771](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1771)
___ ___
@ -693,10 +693,10 @@ Draw or update a G shape or group to the transient canvas.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `type` | `SHAPE_TYPE` \| `ITEM_TYPE` | shape type or item type | | `type` | `ITEM_TYPE` \| `SHAPE_TYPE` | shape type or item type |
| `id` | `ID` | new shape id or updated shape id for a interation shape, node/edge/combo id for item interaction group drawing | | `id` | `ID` | new shape id or updated shape id for a interation shape, node/edge/combo id for item interaction group drawing |
| `config` | `Object` | - | | `config` | `Object` | - |
| `config.action` | ``"update"`` \| ``"remove"`` \| ``"add"`` | - | | `config.action` | ``"update"`` \| ``"add"`` \| ``"remove"`` | - |
| `config.onlyDrawKeyShape?` | `boolean` | - | | `config.onlyDrawKeyShape?` | `boolean` | - |
| `config.style` | `Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `animates?`: `IAnimates` ; `lod?`: `number` ; `visible?`: `boolean` }\> | - | | `config.style` | `Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `animates?`: `IAnimates` ; `lod?`: `number` ; `visible?`: `boolean` }\> | - |
| `config.upsertAncestors?` | `boolean` | - | | `config.upsertAncestors?` | `boolean` | - |
@ -713,7 +713,7 @@ upserted shape or group
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1974](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1974) [packages/g6/src/runtime/graph.ts:1968](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1968)
___ ___
@ -735,7 +735,7 @@ mode name
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1766](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1766) [packages/g6/src/runtime/graph.ts:1760](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1760)
___ ___
@ -762,7 +762,7 @@ Remove behavior(s) from mode(s).
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1803](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1803) [packages/g6/src/runtime/graph.ts:1797](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1797)
___ ___
@ -788,7 +788,7 @@ Switch mode.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1757](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1757) [packages/g6/src/runtime/graph.ts:1751](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1751)
___ ___
@ -815,7 +815,7 @@ Update a behavior on a mode.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1830](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1830) [packages/g6/src/runtime/graph.ts:1824](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1824)
___ ___
@ -843,7 +843,7 @@ Update a plugin of the graph.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1924](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1924) [packages/g6/src/runtime/graph.ts:1918](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1918)
## Item ## Item
@ -869,7 +869,7 @@ Make the item(s) to the back.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1400](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1400) [packages/g6/src/runtime/graph.ts:1394](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1394)
___ ___
@ -896,7 +896,7 @@ Clear all the states for item(s).
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1493](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1493) [packages/g6/src/runtime/graph.ts:1487](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1487)
___ ___
@ -913,7 +913,7 @@ Find items which has the state.
| `itemType` | `ITEM_TYPE` | `undefined` | item type | | `itemType` | `ITEM_TYPE` | `undefined` | item type |
| `state` | `string` | `undefined` | state name | | `state` | `string` | `undefined` | state name |
| `value` | `string` \| `boolean` | `true` | - | | `value` | `string` \| `boolean` | `true` | - |
| `additionalFilter?` | (`item`: `NodeModel` \| `ComboModel` \| `EdgeModel`) => `boolean` | `undefined` | additional filter function | | `additionalFilter?` | (`item`: `NodeModel` \| `EdgeModel` \| `ComboModel`) => `boolean` | `undefined` | additional filter function |
#### Returns #### Returns
@ -927,7 +927,7 @@ items that is the type and has the state
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:953](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L953) [packages/g6/src/runtime/graph.ts:947](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L947)
___ ___
@ -953,7 +953,7 @@ Make the item(s) to the front.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1381](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1381) [packages/g6/src/runtime/graph.ts:1375](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1375)
___ ___
@ -981,7 +981,7 @@ the state names with value true
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1482](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1482) [packages/g6/src/runtime/graph.ts:1476](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1476)
___ ___
@ -1010,7 +1010,7 @@ the state value
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1472](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1472) [packages/g6/src/runtime/graph.ts:1466](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1466)
___ ___
@ -1038,7 +1038,7 @@ visibility for the item, false for invisible or unexistence for the item
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1536](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1536) [packages/g6/src/runtime/graph.ts:1530](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1530)
___ ___
@ -1068,7 +1068,7 @@ rendering bounding box. returns false if the item is not exist
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1521](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1521) [packages/g6/src/runtime/graph.ts:1515](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1515)
___ ___
@ -1095,7 +1095,7 @@ Hide the item(s).
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1352](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1352) [packages/g6/src/runtime/graph.ts:1346](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1346)
___ ___
@ -1123,7 +1123,7 @@ Set state for the item.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1439](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1439) [packages/g6/src/runtime/graph.ts:1433](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1433)
___ ___
@ -1150,7 +1150,7 @@ Show the item(s).
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1324](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1324) [packages/g6/src/runtime/graph.ts:1318](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1318)
## Methods ## Methods
@ -1178,7 +1178,7 @@ more convenient way without manually invoking `startBatch` and `stopBatch`.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2132](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2132) [packages/g6/src/runtime/graph.ts:2126](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2126)
___ ___
@ -1198,7 +1198,7 @@ Indicate whether there are any actions available in the redo stack.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2101](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2101) [packages/g6/src/runtime/graph.ts:2095](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2095)
___ ___
@ -1218,7 +1218,7 @@ Indicate whether there are any actions available in the undo stack.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2093](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2093) [packages/g6/src/runtime/graph.ts:2087](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2087)
___ ___
@ -1244,7 +1244,7 @@ Change the renderer at runtime.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:265](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L265) [packages/g6/src/runtime/graph.ts:259](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L259)
___ ___
@ -1264,7 +1264,7 @@ Clear the graph, means remove all the items on the graph.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:475](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L475) [packages/g6/src/runtime/graph.ts:469](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L469)
___ ___
@ -1290,7 +1290,7 @@ Clear history stack
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2141](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2141) [packages/g6/src/runtime/graph.ts:2135](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2135)
___ ___
@ -1347,7 +1347,7 @@ Execute a callback without allowing any stacking operations.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2035](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2035) [packages/g6/src/runtime/graph.ts:2029](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2029)
___ ___
@ -1373,7 +1373,7 @@ Fit the graph center to the view center.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:711](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L711) [packages/g6/src/runtime/graph.ts:705](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L705)
___ ___
@ -1402,7 +1402,7 @@ Fit the graph content to the view.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:643](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L643) [packages/g6/src/runtime/graph.ts:637](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L637)
___ ___
@ -1429,7 +1429,7 @@ Move the graph to make the item align the view center.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:726](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L726) [packages/g6/src/runtime/graph.ts:720](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L720)
___ ___
@ -1465,7 +1465,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1747](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1747) [packages/g6/src/runtime/graph.ts:1741](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1741)
___ ___
@ -1485,7 +1485,7 @@ Retrieve the current undo stack which consists of operations that were undone
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2056](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2056) [packages/g6/src/runtime/graph.ts:2050](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2050)
___ ___
@ -1507,7 +1507,7 @@ graph specs
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:394](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L394) [packages/g6/src/runtime/graph.ts:388](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L388)
___ ___
@ -1527,7 +1527,7 @@ Retrieve the complete history stack
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2065](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2065) [packages/g6/src/runtime/graph.ts:2059](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2059)
___ ___
@ -1547,7 +1547,7 @@ Retrieve the current redo stack which consists of operations that could be undon
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2048](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2048) [packages/g6/src/runtime/graph.ts:2042](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2042)
___ ___
@ -1567,7 +1567,7 @@ Return the center of viewport, e.g. for a 500 * 500 canvas, its center is [250,
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:492](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L492) [packages/g6/src/runtime/graph.ts:486](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L486)
___ ___
@ -1589,7 +1589,7 @@ current zoom
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:593](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L593) [packages/g6/src/runtime/graph.ts:587](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L587)
___ ___
@ -1609,7 +1609,7 @@ Determine if history (redo/undo) is enabled.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1999](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1999) [packages/g6/src/runtime/graph.ts:1993](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1993)
___ ___
@ -1636,7 +1636,7 @@ Layout the graph (with current configurations if cfg is not assigned).
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1689](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1689) [packages/g6/src/runtime/graph.ts:1683](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1683)
___ ___
@ -1750,7 +1750,7 @@ Pause stacking operation.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2018](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2018) [packages/g6/src/runtime/graph.ts:2012](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2012)
___ ___
@ -1778,7 +1778,7 @@ Push the operation(s) onto the specified stack
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2010](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2010) [packages/g6/src/runtime/graph.ts:2004](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2004)
___ ___
@ -1798,7 +1798,7 @@ Revert recent n operation(s) performed on the graph.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2085](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2085) [packages/g6/src/runtime/graph.ts:2079](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2079)
___ ___
@ -1818,7 +1818,7 @@ Resume stacking operation.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2026](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2026) [packages/g6/src/runtime/graph.ts:2020](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2020)
___ ___
@ -1846,7 +1846,7 @@ Rotate the graph with a relative angle.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:603](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L603) [packages/g6/src/runtime/graph.ts:597](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L597)
___ ___
@ -1874,7 +1874,7 @@ Rotate the graph to an absolute angle.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:625](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L625) [packages/g6/src/runtime/graph.ts:619](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L619)
___ ___
@ -1896,7 +1896,7 @@ treated as a single operation when undoing or redoing.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2111](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2111) [packages/g6/src/runtime/graph.ts:2105](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2105)
___ ___
@ -1918,7 +1918,7 @@ treated as a single operation when undoing or redoing.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2121](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2121) [packages/g6/src/runtime/graph.ts:2115](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2115)
___ ___
@ -1938,7 +1938,7 @@ Some layout algorithms has many iterations which can be stopped at any time.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1739](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1739) [packages/g6/src/runtime/graph.ts:1733](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1733)
___ ___
@ -1958,7 +1958,7 @@ Stop the current transition of transform immediately.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:510](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L510) [packages/g6/src/runtime/graph.ts:504](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L504)
___ ___
@ -1985,7 +1985,7 @@ Transform the graph with a CSS-Transform-like syntax.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:496](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L496) [packages/g6/src/runtime/graph.ts:490](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L490)
___ ___
@ -2012,7 +2012,7 @@ Move the graph with a relative distance under viewport coordinates.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:520](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L520) [packages/g6/src/runtime/graph.ts:514](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L514)
___ ___
@ -2039,7 +2039,7 @@ Move the graph to destination under viewport coordinates.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:541](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L541) [packages/g6/src/runtime/graph.ts:535](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L535)
___ ___
@ -2059,7 +2059,7 @@ Restore n operations that were last n reverted on the graph.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2075](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2075) [packages/g6/src/runtime/graph.ts:2069](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2069)
___ ___
@ -2085,7 +2085,7 @@ Update the specs(configurations).
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:367](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L367) [packages/g6/src/runtime/graph.ts:361](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L361)
___ ___
@ -2111,7 +2111,7 @@ Update the theme specs (configurations).
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:373](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L373) [packages/g6/src/runtime/graph.ts:367](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L367)
___ ___
@ -2139,7 +2139,7 @@ Zoom the graph with a relative ratio.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:555](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L555) [packages/g6/src/runtime/graph.ts:549](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L549)
___ ___
@ -2167,7 +2167,7 @@ Zoom the graph to a specified ratio.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:577](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L577) [packages/g6/src/runtime/graph.ts:571](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L571)
## Plugin ## Plugin
@ -2193,7 +2193,7 @@ Add plugin(s) to graph.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1852](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1852) [packages/g6/src/runtime/graph.ts:1846](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1846)
___ ___
@ -2219,7 +2219,7 @@ Remove plugin(s) from graph.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:1905](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L1905) [packages/g6/src/runtime/graph.ts:1899](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L1899)
## Properties ## Properties
@ -2229,7 +2229,7 @@ Remove plugin(s) from graph.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:84](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L84) [packages/g6/src/runtime/graph.ts:78](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L78)
___ ___
@ -2243,7 +2243,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:74](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L74) [packages/g6/src/runtime/graph.ts:68](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L68)
___ ___
@ -2257,7 +2257,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:76](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L76) [packages/g6/src/runtime/graph.ts:70](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L70)
___ ___
@ -2271,7 +2271,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:78](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L78) [packages/g6/src/runtime/graph.ts:72](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L72)
___ ___
@ -2285,7 +2285,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:72](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L72) [packages/g6/src/runtime/graph.ts:66](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L66)
___ ___
@ -2299,7 +2299,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:80](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L80) [packages/g6/src/runtime/graph.ts:74](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L74)
___ ___
@ -2313,7 +2313,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:82](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L82) [packages/g6/src/runtime/graph.ts:76](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L76)
## Tree ## Tree
@ -2341,7 +2341,7 @@ Collapse sub tree(s).
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2157](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2157) [packages/g6/src/runtime/graph.ts:2151](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2151)
___ ___
@ -2369,7 +2369,7 @@ Expand sub tree(s).
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:2173](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L2173) [packages/g6/src/runtime/graph.ts:2167](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L2167)
## View ## View
@ -2397,7 +2397,7 @@ rendering coordinate
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:824](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L824) [packages/g6/src/runtime/graph.ts:818](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L818)
___ ___
@ -2425,7 +2425,7 @@ canvas dom (viewport) coordinate
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:793](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L793) [packages/g6/src/runtime/graph.ts:787](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L787)
___ ___
@ -2453,7 +2453,7 @@ browser coordinate
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:813](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L813) [packages/g6/src/runtime/graph.ts:807](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L807)
___ ___
@ -2475,7 +2475,7 @@ Get the size of the graph canvas.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:765](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L765) [packages/g6/src/runtime/graph.ts:759](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L759)
___ ___
@ -2503,7 +2503,7 @@ rendering coordinate
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:803](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L803) [packages/g6/src/runtime/graph.ts:797](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L797)
___ ___
@ -2529,4 +2529,4 @@ Set the size for the graph canvas.
#### Defined in #### Defined in
[packages/g6/src/runtime/graph.ts:775](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/runtime/graph.ts#L775) [packages/g6/src/runtime/graph.ts:769](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/runtime/graph.ts#L769)

99
packages/site/docs/apis/interfaces/behaviors-ActivateRelationsOptions.en.md
View File

@ -1,99 +0,0 @@
[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [behaviors](../modules/behaviors.en.md) / ActivateRelationsOptions
# Interface: ActivateRelationsOptions
[behaviors](../modules/behaviors.en.md).ActivateRelationsOptions
## Properties
### activeState
• `Optional` **activeState**: ``"selected"``
Defaults to `"selected"`.
#### Defined in
[stdlib/behavior/activate-relations.ts:37](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L37)
___
### multiple
• `Optional` **multiple**: `boolean`
Whether to allow multiple selection.
Defaults to true.
If set to false, `trigger` options will be ignored.
#### Defined in
[stdlib/behavior/activate-relations.ts:24](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L24)
___
### shouldBegin
• `Optional` **shouldBegin**: (`event`: [`IG6GraphEvent`](types-IG6GraphEvent.en.md)) => `boolean`
#### Type declaration
▸ (`event`): `boolean`
Whether allow the behavior happen on the current item.
##### Parameters
| Name | Type |
| :------ | :------ |
| `event` | [`IG6GraphEvent`](types-IG6GraphEvent.en.md) |
##### Returns
`boolean`
#### Defined in
[stdlib/behavior/activate-relations.ts:42](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L42)
___
### shouldUpdate
• `Optional` **shouldUpdate**: (`event`: [`IG6GraphEvent`](types-IG6GraphEvent.en.md)) => `boolean`
#### Type declaration
▸ (`event`): `boolean`
Whether to update item state.
If it returns false, you may probably listen to `eventName` and
manage states or data manually
##### Parameters
| Name | Type |
| :------ | :------ |
| `event` | [`IG6GraphEvent`](types-IG6GraphEvent.en.md) |
##### Returns
`boolean`
#### Defined in
[stdlib/behavior/activate-relations.ts:48](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L48)
___
### trigger
• `Optional` **trigger**: ``"click"`` \| ``"mouseenter"``
The key to pressed with mouse click to apply multiple selection.
Defaults to `"click"`.
Could be "click", "mouseenter".
#### Defined in
[stdlib/behavior/activate-relations.ts:30](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/activate-relations.ts#L30)

99
packages/site/docs/apis/interfaces/behaviors-ActivateRelationsOptions.zh.md
View File

@ -1,99 +0,0 @@
[概述 - 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)

215
packages/site/docs/apis/interfaces/behaviors-BrushSelectOptions.en.md
View File

@ -1,215 +0,0 @@
[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [behaviors](../modules/behaviors.en.md) / BrushSelectOptions
# Interface: BrushSelectOptions
[behaviors](../modules/behaviors.en.md).BrushSelectOptions
## Properties
### brushStyle
• **brushStyle**: `Object`
The shape style of the brush while selecting.
#### Index signature
▪ [key: `string`]: `unknown`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `fill?` | `string` |
| `fillOpacity?` | `number` |
| `lineWidth?` | `number` |
| `stroke?` | `string` |
#### Defined in
[stdlib/behavior/brush-select.ts:46](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L46)
___
### eventName
• **eventName**: `string`
The event name to trigger when select/unselect an item.
#### Defined in
[stdlib/behavior/brush-select.ts:42](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L42)
___
### itemTypes
• **itemTypes**: (``"node"`` \| ``"edge"`` \| ``"combo"``)[]
Item types to be able to select.
Defaults to `["nodes"]`.
Should be an array of "node", "edge", or "combo".
#### Defined in
[stdlib/behavior/brush-select.ts:32](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L32)
___
### onDeselect
• **onDeselect**: (`selectedIds`: { `combos`: `ID`[] ; `edges`: `ID`[] ; `nodes`: `ID`[] }, `deselectedIds`: { `combos`: `ID`[] ; `edges`: `ID`[] ; `nodes`: `ID`[] }) => `void`
#### Type declaration
▸ (`selectedIds`, `deselectedIds`): `void`
A callback be called after deselecting.
##### Parameters
| Name | Type |
| :------ | :------ |
| `selectedIds` | `Object` |
| `selectedIds.combos` | `ID`[] |
| `selectedIds.edges` | `ID`[] |
| `selectedIds.nodes` | `ID`[] |
| `deselectedIds` | `Object` |
| `deselectedIds.combos` | `ID`[] |
| `deselectedIds.edges` | `ID`[] |
| `deselectedIds.nodes` | `ID`[] |
##### Returns
`void`
#### Defined in
[stdlib/behavior/brush-select.ts:77](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L77)
___
### onSelect
• **onSelect**: (`selectedIds`: { `combos`: `ID`[] ; `edges`: `ID`[] ; `nodes`: `ID`[] }) => `void`
#### Type declaration
▸ (`selectedIds`): `void`
A callback be called after selecting.
##### Parameters
| Name | Type |
| :------ | :------ |
| `selectedIds` | `Object` |
| `selectedIds.combos` | `ID`[] |
| `selectedIds.edges` | `ID`[] |
| `selectedIds.nodes` | `ID`[] |
##### Returns
`void`
#### Defined in
[stdlib/behavior/brush-select.ts:73](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L73)
___
### selectSetMode
• **selectSetMode**: ``"union"`` \| ``"intersect"`` \| ``"diff"`` \| ``"latest"``
The mode to compose the selections from times of brush
#### Defined in
[stdlib/behavior/brush-select.ts:54](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L54)
___
### selectedState
• **selectedState**: ``"selected"``
The state to be applied when select.
Defaults to `"selected"`.
Can be set to "active", "highlighted", etc.
#### Defined in
[stdlib/behavior/brush-select.ts:38](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L38)
___
### shouldBegin
• **shouldBegin**: (`event`: [`IG6GraphEvent`](types-IG6GraphEvent.en.md)) => `boolean`
#### Type declaration
▸ (`event`): `boolean`
Whether allow the behavior happen on the current item.
##### Parameters
| Name | Type |
| :------ | :------ |
| `event` | [`IG6GraphEvent`](types-IG6GraphEvent.en.md) |
##### Returns
`boolean`
#### Defined in
[stdlib/behavior/brush-select.ts:58](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L58)
___
### shouldUpdate
• **shouldUpdate**: (`itemType`: `ITEM_TYPE`, `id`: `ID`, `action`: ``"select"`` \| ``"deselect"``, `self`: `default`) => `boolean`
#### Type declaration
▸ (`itemType`, `id`, `action`, `self`): `boolean`
Whether to update item state.
If it returns false, you may probably listen to `eventName` and
manage states or data manually
##### Parameters
| Name | Type |
| :------ | :------ |
| `itemType` | `ITEM_TYPE` |
| `id` | `ID` |
| `action` | ``"select"`` \| ``"deselect"`` |
| `self` | `default` |
##### Returns
`boolean`
#### Defined in
[stdlib/behavior/brush-select.ts:64](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L64)
___
### trigger
• **trigger**: ``"drag"`` \| ``"shift"`` \| ``"ctrl"`` \| ``"alt"`` \| ``"meta"``
The key to pressed with mouse click to apply multiple selection.
Defaults to `"shift"`.
Could be "drag", "shift", "ctrl", "alt", or "meta".
#### Defined in
[stdlib/behavior/brush-select.ts:26](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L26)

215
packages/site/docs/apis/interfaces/behaviors-BrushSelectOptions.zh.md
View File

@ -1,215 +0,0 @@
[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [行为](../modules/behaviors.zh.md ) / 画笔选择选项
# 接口：BrushSelectOptions
[行为](../modules/behaviors.zh.md).BrushSelectOptions
＃＃ 特性
###画笔样式
• **brushStyle**：`对象`
选择时画笔的形状样式。
#### 索引签名
▪ [key: `string`]: `unknown`
#### 类型声明
| 名称 | 类型 |
| :------ | :------ |
| `填充？` | `字符串` |
| `填充不透明度？` | `数字` |
| `线宽？` | `数字` |
| `中风？` | `字符串` |
#### 定义于
[stdlib/behavior/brush-select.ts:46](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L46)
___
### 事件名称
• **事件名称**：`字符串`
选择/取消选择项目时触发的事件名称。
#### 定义于
[stdlib/behavior/brush-select.ts:42](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L42)
___
### 项目类型
• **itemTypes**: (``"node"`` \| ``"edge"`` \| ``"combo"``)[]
可以选择的项目类型。
默认为`[“节点”]`。
应该是“节点”、“边”或“组合”的数组。
#### 定义于
[stdlib/behavior/brush-select.ts:32](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L32)
___
### on取消选择
• **onDeselect**: (`selectedIds`: { `combos`: `ID`[] ; `edges`: `ID`[] ; `nodes`: `ID`[] }, `deselectedIds`: { ` 组合`:`ID`[] ;`边`:`ID`[] ;`节点`:`ID`[] }) => `void`
#### 类型声明
▸ (`selectedIds`, `deselectedIds`): `void`
取消选择后调用回调。
＃＃＃＃＃ 参数
| 名称 | 类型 |
| :------ | :------ |
| `selectedIds` | `对象` |
| `selectedIds.combos` | `ID`[] |
| `selectedIds.edges` | `ID`[] |
| `selectedIds.nodes` | `ID`[] |
| `取消选择的Ids` | `对象` |
| `deselectedIds.combos` | `ID`[] |
| `deselectedIds.edges` | `ID`[] |
| `deselectedIds.nodes` | `ID`[] |
##### 返回
`无效`
#### 定义于
[stdlib/behavior/brush-select.ts:77](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L77)
___
### on选择
• **onSelect**: (`selectedIds`: { `combos`: `ID`[] ; `edges`: `ID`[] ; `nodes`: `ID`[] }) => `void`
#### 类型声明
▸ (`selectedIds`): `void`
选择后会调用回调。
＃＃＃＃＃ 参数
| 名称 | 类型 |
| :------ | :------ |
| `selectedIds` | `对象` |
| `selectedIds.combos` | `ID`[] |
| `selectedIds.edges` | `ID`[] |
| `selectedIds.nodes` | `ID`[] |
##### 返回
`无效`
#### 定义于
[stdlib/behavior/brush-select.ts:73](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L73)
___
### 选择设置模式
• **selectSetMode**: ``"union"`` \| ``“相交”`` \| ``“差异”`` \| ``“最新”``
笔刷次数组成选区的模式
#### 定义于
[stdlib/behavior/brush-select.ts:54](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L54)
___
### 选定状态
• **selectedState**：``“已选择”``
选择时要应用的状态。
默认为“选定”。
可以设置为“活动”、“突出显示”等。
#### 定义于
[stdlib/behavior/brush-select.ts:38](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L38)
___
### 应该开始
• **shouldBegin**: (`event`: [`IG6GraphEvent`](types-IG6GraphEvent.zh.md)) => `boolean`
#### 类型声明
▸ (`事件`): `布尔值`
是否允许该行为发生在当前项目上。
＃＃＃＃＃ 参数
| 名称 | 类型 |
| :------ | :------ |
| `事件` | [`IG6GraphEvent`](types-IG6GraphEvent.zh.md) |
##### 返回
`布尔值`
#### 定义于
[stdlib/behavior/brush-select.ts:58](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L58)
___
### 应该更新
• **shouldUpdate**: (`itemType`: `ITEM_TYPE`, `id`: `ID`, `action`: ``"选择"`` \| ``"取消选择"``, `self`: ` 默认`) => `布尔值`
#### 类型声明
▸ (`itemType`, `id`, `action`, `self`): `boolean`
是否更新项目状态。
如果它返回 false，您可能会监听 `eventName` 并
手动管理状态或数据
＃＃＃＃＃ 参数
| 名称 | 类型 |
| :------ | :------ |
| `项目类型` | `ITEM_TYPE` |
| `id` | `ID` |
| `行动` | ``“选择”`` \| ``“取消选择”`` |
| `自我` | `默认` |
##### 返回
`布尔值`
#### 定义于
[stdlib/behavior/brush-select.ts:64](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L64)
___
＃＃＃ 扳机
• **触发**：``“拖动”`` \| ``“转变”`` \| ``“ctrl”`` \| ``“替代”`` \| ``“元”``
单击鼠标按下该键以应用多项选择。
默认为“移位”。
可以是“drag”、“shift”、“ctrl”、“alt”或“meta”。
#### 定义于
[stdlib/behavior/brush-select.ts:26](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/behavior/brush-select.ts#L26)

10
packages/site/docs/apis/interfaces/behaviors/ActivateRelationsOptions.en.md
View File

@ -16,7 +16,7 @@ Defaults to `"selected"`.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/activate-relations.ts:37](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/activate-relations.ts#L37) [packages/g6/src/stdlib/behavior/activate-relations.ts:37](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/activate-relations.ts#L37)
___ ___
@ -30,7 +30,7 @@ If set to false, `trigger` options will be ignored.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/activate-relations.ts:24](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/activate-relations.ts#L24) [packages/g6/src/stdlib/behavior/activate-relations.ts:24](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/activate-relations.ts#L24)
___ ___
@ -56,7 +56,7 @@ Whether allow the behavior happen on the current item.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/activate-relations.ts:42](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/activate-relations.ts#L42) [packages/g6/src/stdlib/behavior/activate-relations.ts:42](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/activate-relations.ts#L42)
___ ___
@ -84,7 +84,7 @@ manage states or data manually
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/activate-relations.ts:48](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/activate-relations.ts#L48) [packages/g6/src/stdlib/behavior/activate-relations.ts:48](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/activate-relations.ts#L48)
___ ___
@ -98,4 +98,4 @@ Could be "click", "mouseenter".
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/activate-relations.ts:30](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/activate-relations.ts#L30) [packages/g6/src/stdlib/behavior/activate-relations.ts:30](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/activate-relations.ts#L30)

10
packages/site/docs/apis/interfaces/behaviors/ActivateRelationsOptions.zh.md
View File

@ -16,7 +16,7 @@ title: ActivateRelationsOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/activate-relations.ts:37](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/activate-relations。 ts#L37) [packages/g6/src/stdlib/behavior/activate-relations.ts:37](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/activate-relations。 ts#L37)
___ ___
@ -30,7 +30,7 @@ title: ActivateRelationsOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/activate-relations.ts:24](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/activate-relations。 ts#L24) [packages/g6/src/stdlib/behavior/activate-relations.ts:24](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/activate-relations。 ts#L24)
___ ___
@ -56,7 +56,7 @@ title: ActivateRelationsOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/activate-relations.ts:42](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/activate-relations。 ts#L42) [packages/g6/src/stdlib/behavior/activate-relations.ts:42](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/activate-relations。 ts#L42)
___ ___
@ -84,7 +84,7 @@ title: ActivateRelationsOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/activate-relations.ts:48](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/activate-relations。 ts#L48) [packages/g6/src/stdlib/behavior/activate-relations.ts:48](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/activate-relations。 ts#L48)
___ ___
@ -98,4 +98,4 @@ title: ActivateRelationsOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/activate-relations.ts:30](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/activate-relations。 ts#L30) [packages/g6/src/stdlib/behavior/activate-relations.ts:30](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/activate-relations。 ts#L30)

22
packages/site/docs/apis/interfaces/behaviors/BrushSelectOptions.en.md
View File

@ -29,7 +29,7 @@ The shape style of the brush while selecting.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/brush-select.ts:46](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/brush-select.ts#L46) [packages/g6/src/stdlib/behavior/brush-select.ts:46](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/brush-select.ts#L46)
___ ___
@ -41,7 +41,7 @@ The event name to trigger when select/unselect an item.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/brush-select.ts:42](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/brush-select.ts#L42) [packages/g6/src/stdlib/behavior/brush-select.ts:42](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/brush-select.ts#L42)
___ ___
@ -55,7 +55,7 @@ Should be an array of "node", "edge", or "combo".
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/brush-select.ts:32](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/brush-select.ts#L32) [packages/g6/src/stdlib/behavior/brush-select.ts:32](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/brush-select.ts#L32)
___ ___
@ -88,7 +88,7 @@ A callback be called after deselecting.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/brush-select.ts:77](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/brush-select.ts#L77) [packages/g6/src/stdlib/behavior/brush-select.ts:77](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/brush-select.ts#L77)
___ ___
@ -117,7 +117,7 @@ A callback be called after selecting.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/brush-select.ts:73](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/brush-select.ts#L73) [packages/g6/src/stdlib/behavior/brush-select.ts:73](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/brush-select.ts#L73)
___ ___
@ -129,7 +129,7 @@ The mode to compose the selections from times of brush
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/brush-select.ts:54](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/brush-select.ts#L54) [packages/g6/src/stdlib/behavior/brush-select.ts:54](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/brush-select.ts#L54)
___ ___
@ -143,7 +143,7 @@ Can be set to "active", "highlighted", etc.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/brush-select.ts:38](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/brush-select.ts#L38) [packages/g6/src/stdlib/behavior/brush-select.ts:38](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/brush-select.ts#L38)
___ ___
@ -169,7 +169,7 @@ Whether allow the behavior happen on the current item.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/brush-select.ts:58](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/brush-select.ts#L58) [packages/g6/src/stdlib/behavior/brush-select.ts:58](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/brush-select.ts#L58)
___ ___
@ -200,13 +200,13 @@ manage states or data manually
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/brush-select.ts:64](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/brush-select.ts#L64) [packages/g6/src/stdlib/behavior/brush-select.ts:64](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/brush-select.ts#L64)
___ ___
### trigger ### trigger
• **trigger**: ``"drag"`` \| ``"shift"`` \| ``"ctrl"`` \| ``"alt"`` \| ``"meta"`` • **trigger**: ``"shift"`` \| ``"drag"`` \| ``"ctrl"`` \| ``"alt"`` \| ``"meta"``
The key to pressed with mouse click to apply multiple selection. The key to pressed with mouse click to apply multiple selection.
Defaults to `"shift"`. Defaults to `"shift"`.
@ -214,4 +214,4 @@ Could be "drag", "shift", "ctrl", "alt", or "meta".
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/brush-select.ts:26](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/brush-select.ts#L26) [packages/g6/src/stdlib/behavior/brush-select.ts:26](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/brush-select.ts#L26)

4
packages/site/docs/apis/interfaces/behaviors/CollapseExpandComboOptions.en.md
View File

@ -30,7 +30,7 @@ Whether allow the behavior happen on the current item.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/collapse-expand-combo.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/collapse-expand-combo.ts#L22) [packages/g6/src/stdlib/behavior/collapse-expand-combo.ts:22](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/collapse-expand-combo.ts#L22)
___ ___
@ -44,4 +44,4 @@ Could be "dblclick", "click".
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/collapse-expand-combo.ts:18](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/collapse-expand-combo.ts#L18) [packages/g6/src/stdlib/behavior/collapse-expand-combo.ts:18](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/collapse-expand-combo.ts#L18)

4
packages/site/docs/apis/interfaces/behaviors/CollapseExpandComboOptions.zh.md
View File

@ -30,7 +30,7 @@ title: CollapseExpandComboOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/collapse-expand-combo.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/collapse- 扩展组合.ts#L22) [packages/g6/src/stdlib/behavior/collapse-expand-combo.ts:22](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/collapse- 扩展组合.ts#L22)
___ ___
@ -44,4 +44,4 @@ title: CollapseExpandComboOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/collapse-expand-combo.ts:18](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/collapse- 扩展组合.ts#L18) [packages/g6/src/stdlib/behavior/collapse-expand-combo.ts:18](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/collapse- 扩展组合.ts#L18)

22
packages/site/docs/apis/interfaces/behaviors/DragCanvasOptions.en.md
View File

@ -10,13 +10,13 @@ title: DragCanvasOptions
### direction ### direction
• `Optional` **direction**: ``"x"`` \| ``"y"`` \| ``"both"`` • `Optional` **direction**: ``"both"`` \| ``"x"`` \| ``"y"``
The direction to drag the canvas. 'both' by default. The direction to drag the canvas. 'both' by default.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-canvas.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas.ts#L22) [packages/g6/src/stdlib/behavior/drag-canvas.ts:22](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas.ts#L22)
___ ___
@ -28,7 +28,7 @@ Whether allow trigger this behavior when drag start on nodes / edges / combos.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-canvas.ts:14](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas.ts#L14) [packages/g6/src/stdlib/behavior/drag-canvas.ts:14](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas.ts#L14)
___ ___
@ -40,7 +40,7 @@ Whether enable optimize strategies, which will hide all the shapes excluding nod
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-canvas.ts:10](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas.ts#L10) [packages/g6/src/stdlib/behavior/drag-canvas.ts:10](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas.ts#L10)
___ ___
@ -52,7 +52,7 @@ The event name to trigger when drag end.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-canvas.ts:48](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas.ts#L48) [packages/g6/src/stdlib/behavior/drag-canvas.ts:48](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas.ts#L48)
___ ___
@ -70,7 +70,7 @@ Refer to https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*IFfoS67_HssAAAAA
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-canvas.ts:44](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas.ts#L44) [packages/g6/src/stdlib/behavior/drag-canvas.ts:44](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas.ts#L44)
___ ___
@ -82,7 +82,7 @@ The assistant secondary key on keyboard. If it is not assigned, the behavior wil
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-canvas.ts:26](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas.ts#L26) [packages/g6/src/stdlib/behavior/drag-canvas.ts:26](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas.ts#L26)
___ ___
@ -94,7 +94,7 @@ The assistant secondary key on keyboard to prevent the behavior to be tiggered.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-canvas.ts:30](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas.ts#L30) [packages/g6/src/stdlib/behavior/drag-canvas.ts:30](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas.ts#L30)
___ ___
@ -120,7 +120,7 @@ Whether allow the behavior happen on the current item.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-canvas.ts:52](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas.ts#L52) [packages/g6/src/stdlib/behavior/drag-canvas.ts:52](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas.ts#L52)
___ ___
@ -132,7 +132,7 @@ The key on keyboard to speed up translating while pressing and drag-canvas by di
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-canvas.ts:34](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas.ts#L34) [packages/g6/src/stdlib/behavior/drag-canvas.ts:34](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas.ts#L34)
___ ___
@ -144,4 +144,4 @@ The trigger for the behavior, 'drag' by default. 'directionKeys' means trigger t
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-canvas.ts:18](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas.ts#L18) [packages/g6/src/stdlib/behavior/drag-canvas.ts:18](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas.ts#L18)

22
packages/site/docs/apis/interfaces/behaviors/DragCanvasOptions.zh.md
View File

@ -10,13 +10,13 @@ title: DragCanvasOptions
＃＃＃ 方向 ＃＃＃ 方向
• `可选` **方向**：``"x"`` \| ``“y”`` \| ``“两者”`` • `可选` **方向**：``“两者”`` \| ``“x”`` \| ``“y”``
拖动画布的方向。 默认为“两者”。 拖动画布的方向。 默认为“两者”。
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-canvas.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas. ts#L22) [packages/g6/src/stdlib/behavior/drag-canvas.ts:22](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas. ts#L22)
___ ___
@ -28,7 +28,7 @@ title: DragCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-canvas.ts:14](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas. ts#L14) [packages/g6/src/stdlib/behavior/drag-canvas.ts:14](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas. ts#L14)
___ ___
@ -40,7 +40,7 @@ title: DragCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-canvas.ts:10](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas. ts#L10) [packages/g6/src/stdlib/behavior/drag-canvas.ts:10](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas. ts#L10)
___ ___
@ -52,7 +52,7 @@ title: DragCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-canvas.ts:48](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas. ts#L48) [packages/g6/src/stdlib/behavior/drag-canvas.ts:48](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas. ts#L48)
___ ___
@ -70,7 +70,7 @@ title: DragCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-canvas.ts:44](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas. ts#L44) [packages/g6/src/stdlib/behavior/drag-canvas.ts:44](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas. ts#L44)
___ ___
@ -82,7 +82,7 @@ title: DragCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-canvas.ts:26](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas. ts#L26) [packages/g6/src/stdlib/behavior/drag-canvas.ts:26](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas. ts#L26)
___ ___
@ -94,7 +94,7 @@ title: DragCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-canvas.ts:30](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas. ts#L30) [packages/g6/src/stdlib/behavior/drag-canvas.ts:30](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas. ts#L30)
___ ___
@ -120,7 +120,7 @@ title: DragCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-canvas.ts:52](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas. ts#L52) [packages/g6/src/stdlib/behavior/drag-canvas.ts:52](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas. ts#L52)
___ ___
@ -132,7 +132,7 @@ title: DragCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-canvas.ts:34](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas. ts#L34) [packages/g6/src/stdlib/behavior/drag-canvas.ts:34](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas. ts#L34)
___ ___
@ -144,4 +144,4 @@ title: DragCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-canvas.ts:18](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-canvas. ts#L18) [packages/g6/src/stdlib/behavior/drag-canvas.ts:18](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-canvas. ts#L18)

18
packages/site/docs/apis/interfaces/behaviors/DragComboOptions.en.md
View File

@ -32,7 +32,7 @@ Only used when enableDelegate is true.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-combo.ts:27](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo.ts#L27) [packages/g6/src/stdlib/behavior/drag-combo.ts:27](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo.ts#L27)
___ ___
@ -45,7 +45,7 @@ Defaults to false.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-combo.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo.ts#L22) [packages/g6/src/stdlib/behavior/drag-combo.ts:22](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo.ts#L22)
___ ___
@ -59,7 +59,7 @@ Defaults to true.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-combo.ts:17](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo.ts#L17) [packages/g6/src/stdlib/behavior/drag-combo.ts:17](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo.ts#L17)
___ ___
@ -71,7 +71,7 @@ The event name to trigger when drag end.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-combo.ts:55](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo.ts#L55) [packages/g6/src/stdlib/behavior/drag-combo.ts:55](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo.ts#L55)
___ ___
@ -85,7 +85,7 @@ Defaults to false.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-combo.ts:46](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo.ts#L46) [packages/g6/src/stdlib/behavior/drag-combo.ts:46](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo.ts#L46)
___ ___
@ -98,7 +98,7 @@ Defaults to "selected".
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-combo.ts:51](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo.ts#L51) [packages/g6/src/stdlib/behavior/drag-combo.ts:51](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo.ts#L51)
___ ___
@ -124,7 +124,7 @@ Whether allow the behavior happen on the current item.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-combo.ts:63](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo.ts#L63) [packages/g6/src/stdlib/behavior/drag-combo.ts:63](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo.ts#L63)
___ ___
@ -137,7 +137,7 @@ Defaults to 0.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-combo.ts:40](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo.ts#L40) [packages/g6/src/stdlib/behavior/drag-combo.ts:40](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo.ts#L40)
___ ___
@ -149,4 +149,4 @@ Whether change the combo hierarchy structure or only change size.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-combo.ts:59](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo.ts#L59) [packages/g6/src/stdlib/behavior/drag-combo.ts:59](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo.ts#L59)

18
packages/site/docs/apis/interfaces/behaviors/DragComboOptions.zh.md
View File

@ -32,7 +32,7 @@ title: DragComboOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-combo.ts:27](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo。 ts#L27) [packages/g6/src/stdlib/behavior/drag-combo.ts:27](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo。 ts#L27)
___ ___
@ -45,7 +45,7 @@ title: DragComboOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-combo.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo。 ts#L22) [packages/g6/src/stdlib/behavior/drag-combo.ts:22](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo。 ts#L22)
___ ___
@ -59,7 +59,7 @@ title: DragComboOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-combo.ts:17](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo。 ts#L17) [packages/g6/src/stdlib/behavior/drag-combo.ts:17](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo。 ts#L17)
___ ___
@ -71,7 +71,7 @@ title: DragComboOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-combo.ts:55](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo。 ts#L55) [packages/g6/src/stdlib/behavior/drag-combo.ts:55](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo。 ts#L55)
___ ___
@ -85,7 +85,7 @@ title: DragComboOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-combo.ts:46](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo。 ts#L46) [packages/g6/src/stdlib/behavior/drag-combo.ts:46](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo。 ts#L46)
___ ___
@ -98,7 +98,7 @@ title: DragComboOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-combo.ts:51](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo。 ts#L51) [packages/g6/src/stdlib/behavior/drag-combo.ts:51](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo。 ts#L51)
___ ___
@ -124,7 +124,7 @@ title: DragComboOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-combo.ts:63](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo。 ts#L63) [packages/g6/src/stdlib/behavior/drag-combo.ts:63](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo。 ts#L63)
___ ___
@ -137,7 +137,7 @@ title: DragComboOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-combo.ts:40](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo。 ts#L40) [packages/g6/src/stdlib/behavior/drag-combo.ts:40](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo。 ts#L40)
___ ___
@ -149,4 +149,4 @@ title: DragComboOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-combo.ts:59](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-combo。 ts#L59) [packages/g6/src/stdlib/behavior/drag-combo.ts:59](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-combo。 ts#L59)

18
packages/site/docs/apis/interfaces/behaviors/DragNodeOptions.en.md
View File

@ -32,7 +32,7 @@ Only used when enableDelegate is true.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-node.ts:32](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node.ts#L32) [packages/g6/src/stdlib/behavior/drag-node.ts:32](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node.ts#L32)
___ ___
@ -45,7 +45,7 @@ Defaults to false.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-node.ts:27](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node.ts#L27) [packages/g6/src/stdlib/behavior/drag-node.ts:27](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node.ts#L27)
___ ___
@ -59,7 +59,7 @@ Defaults to true.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-node.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node.ts#L22) [packages/g6/src/stdlib/behavior/drag-node.ts:22](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node.ts#L22)
___ ___
@ -71,7 +71,7 @@ The event name to trigger when drag end.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-node.ts:60](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node.ts#L60) [packages/g6/src/stdlib/behavior/drag-node.ts:60](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node.ts#L60)
___ ___
@ -85,7 +85,7 @@ Defaults to false.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-node.ts:51](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node.ts#L51) [packages/g6/src/stdlib/behavior/drag-node.ts:51](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node.ts#L51)
___ ___
@ -98,7 +98,7 @@ Defaults to "selected".
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-node.ts:56](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node.ts#L56) [packages/g6/src/stdlib/behavior/drag-node.ts:56](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node.ts#L56)
___ ___
@ -124,7 +124,7 @@ Whether allow the behavior happen on the current item.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-node.ts:68](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node.ts#L68) [packages/g6/src/stdlib/behavior/drag-node.ts:68](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node.ts#L68)
___ ___
@ -137,7 +137,7 @@ Defaults to 0.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-node.ts:45](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node.ts#L45) [packages/g6/src/stdlib/behavior/drag-node.ts:45](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node.ts#L45)
___ ___
@ -149,4 +149,4 @@ Whether change the combo hierarchy structure or only change size.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/drag-node.ts:64](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node.ts#L64) [packages/g6/src/stdlib/behavior/drag-node.ts:64](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node.ts#L64)

18
packages/site/docs/apis/interfaces/behaviors/DragNodeOptions.zh.md
View File

@ -32,7 +32,7 @@ title: DragNodeOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-node.ts:32](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node。 ts#L32) [packages/g6/src/stdlib/behavior/drag-node.ts:32](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node。 ts#L32)
___ ___
@ -45,7 +45,7 @@ title: DragNodeOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-node.ts:27](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node。 ts#L27) [packages/g6/src/stdlib/behavior/drag-node.ts:27](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node。 ts#L27)
___ ___
@ -59,7 +59,7 @@ title: DragNodeOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-node.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node。 ts#L22) [packages/g6/src/stdlib/behavior/drag-node.ts:22](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node。 ts#L22)
___ ___
@ -71,7 +71,7 @@ title: DragNodeOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-node.ts:60](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node。 ts#L60) [packages/g6/src/stdlib/behavior/drag-node.ts:60](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node。 ts#L60)
___ ___
@ -85,7 +85,7 @@ title: DragNodeOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-node.ts:51](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node。 ts#L51) [packages/g6/src/stdlib/behavior/drag-node.ts:51](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node。 ts#L51)
___ ___
@ -98,7 +98,7 @@ title: DragNodeOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-node.ts:56](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node。 ts#L56) [packages/g6/src/stdlib/behavior/drag-node.ts:56](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node。 ts#L56)
___ ___
@ -124,7 +124,7 @@ title: DragNodeOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-node.ts:68](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node。 ts#L68) [packages/g6/src/stdlib/behavior/drag-node.ts:68](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node。 ts#L68)
___ ___
@ -137,7 +137,7 @@ title: DragNodeOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-node.ts:45](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node。 ts#L45) [packages/g6/src/stdlib/behavior/drag-node.ts:45](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node。 ts#L45)
___ ___
@ -149,4 +149,4 @@ title: DragNodeOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/drag-node.ts:64](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/drag-node。 ts#L64) [packages/g6/src/stdlib/behavior/drag-node.ts:64](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/drag-node。 ts#L64)

10
packages/site/docs/apis/interfaces/behaviors/HoverActivateOptions.en.md
View File

@ -17,7 +17,7 @@ Defaults to "selected".
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/hover-activate.ts:16](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/hover-activate.ts#L16) [packages/g6/src/stdlib/behavior/hover-activate.ts:16](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/hover-activate.ts#L16)
___ ___
@ -29,7 +29,7 @@ The event name to trigger when drag end.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/hover-activate.ts:26](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/hover-activate.ts#L26) [packages/g6/src/stdlib/behavior/hover-activate.ts:26](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/hover-activate.ts#L26)
___ ___
@ -43,7 +43,7 @@ Should be an array of "node", "edge", or "combo".
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/hover-activate.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/hover-activate.ts#L22) [packages/g6/src/stdlib/behavior/hover-activate.ts:22](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/hover-activate.ts#L22)
___ ___
@ -69,7 +69,7 @@ Whether allow the behavior happen on the current item.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/hover-activate.ts:30](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/hover-activate.ts#L30) [packages/g6/src/stdlib/behavior/hover-activate.ts:30](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/hover-activate.ts#L30)
___ ___
@ -82,4 +82,4 @@ Defaults to 0.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/hover-activate.ts:11](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/hover-activate.ts#L11) [packages/g6/src/stdlib/behavior/hover-activate.ts:11](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/hover-activate.ts#L11)

10
packages/site/docs/apis/interfaces/behaviors/HoverActivateOptions.zh.md
View File

@ -17,7 +17,7 @@ title: HoverActivateOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/hover-activate.ts:16](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/hover-activate。 ts#L16) [packages/g6/src/stdlib/behavior/hover-activate.ts:16](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/hover-activate。 ts#L16)
___ ___
@ -29,7 +29,7 @@ title: HoverActivateOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/hover-activate.ts:26](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/hover-activate。 ts#L26) [packages/g6/src/stdlib/behavior/hover-activate.ts:26](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/hover-activate。 ts#L26)
___ ___
@ -43,7 +43,7 @@ title: HoverActivateOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/hover-activate.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/hover-activate。 ts#L22) [packages/g6/src/stdlib/behavior/hover-activate.ts:22](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/hover-activate。 ts#L22)
___ ___
@ -69,7 +69,7 @@ title: HoverActivateOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/hover-activate.ts:30](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/hover-activate。 ts#L30) [packages/g6/src/stdlib/behavior/hover-activate.ts:30](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/hover-activate。 ts#L30)
___ ___
@ -82,4 +82,4 @@ title: HoverActivateOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/hover-activate.ts:11](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/hover-activate。 ts#L11) [packages/g6/src/stdlib/behavior/hover-activate.ts:11](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/hover-activate。 ts#L11)

8
packages/site/docs/apis/interfaces/behaviors/IG6GraphEvent.en.md
View File

@ -544,7 +544,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/event.ts:42](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/event.ts#L42) [packages/g6/src/types/event.ts:42](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/event.ts#L42)
___ ___
@ -608,7 +608,7 @@ Original event emitted by G
#### Defined in #### Defined in
[packages/g6/src/types/event.ts:46](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/event.ts#L46) [packages/g6/src/types/event.ts:46](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/event.ts#L46)
___ ___
@ -717,7 +717,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/event.ts:44](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/event.ts#L44) [packages/g6/src/types/event.ts:44](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/event.ts#L44)
___ ___
@ -727,7 +727,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/event.ts:43](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/event.ts#L43) [packages/g6/src/types/event.ts:43](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/event.ts#L43)
___ ___

10
packages/site/docs/apis/interfaces/behaviors/Options.en.md
View File

@ -16,7 +16,7 @@ Whether disable the collapse / expand animation triggered by this behavior.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:21](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/collapse-expand-tree.ts#L21) [packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:21](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/collapse-expand-tree.ts#L21)
___ ___
@ -28,7 +28,7 @@ The event name to trigger when select/unselect an item.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:17](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/collapse-expand-tree.ts#L17) [packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:17](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/collapse-expand-tree.ts#L17)
___ ___
@ -54,7 +54,7 @@ Whether allow the behavior happen on the current item.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:25](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/collapse-expand-tree.ts#L25) [packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:25](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/collapse-expand-tree.ts#L25)
___ ___
@ -82,7 +82,7 @@ manage states or data manually
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:31](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/collapse-expand-tree.ts#L31) [packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:31](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/collapse-expand-tree.ts#L31)
___ ___
@ -96,4 +96,4 @@ Could be "shift", "ctrl", "alt", or "meta".
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:13](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/collapse-expand-tree.ts#L13) [packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:13](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/collapse-expand-tree.ts#L13)

10
packages/site/docs/apis/interfaces/behaviors/Options.zh.md
View File

@ -16,7 +16,7 @@ title: Options
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:21](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/collapse- 展开树.ts#L21) [packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:21](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/collapse- 展开树.ts#L21)
___ ___
@ -28,7 +28,7 @@ title: Options
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:17](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/collapse- 展开树.ts#L17) [packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:17](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/collapse- 展开树.ts#L17)
___ ___
@ -54,7 +54,7 @@ title: Options
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:25](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/collapse- 展开树.ts#L25) [packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:25](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/collapse- 展开树.ts#L25)
___ ___
@ -82,7 +82,7 @@ title: Options
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:31](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/collapse- 展开树.ts#L31) [packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:31](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/collapse- 展开树.ts#L31)
___ ___
@ -96,4 +96,4 @@ title: Options
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:13](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/collapse- 展开树.ts#L13) [packages/g6/src/stdlib/behavior/collapse-expand-tree.ts:13](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/collapse- 展开树.ts#L13)

8
packages/site/docs/apis/interfaces/behaviors/OrbitCanvas3DOptions.en.md
View File

@ -16,7 +16,7 @@ The event name to trigger when drag end.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:24](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts#L24) [packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:24](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts#L24)
___ ___
@ -31,7 +31,7 @@ to make the behavior triggered only when the key is pressing and trigger is happ
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:20](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts#L20) [packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:20](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts#L20)
___ ___
@ -57,7 +57,7 @@ Whether allow the behavior happen on the current item.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:28](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts#L28) [packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:28](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts#L28)
___ ___
@ -69,4 +69,4 @@ The way to tranlate the canvas. 'drag' (default) means dragged by mouse, 'direct
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:13](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts#L13) [packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:13](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts#L13)

8
packages/site/docs/apis/interfaces/behaviors/OrbitCanvas3DOptions.zh.md
View File

@ -16,7 +16,7 @@ title: OrbitCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:24](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/orbit- canvas-3d.ts#L24) [packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:24](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/orbit- canvas-3d.ts#L24)
___ ___
@ -31,7 +31,7 @@ title: OrbitCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:20](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/orbit- canvas-3d.ts#L20) [packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:20](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/orbit- canvas-3d.ts#L20)
___ ___
@ -57,7 +57,7 @@ title: OrbitCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:28](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/orbit- canvas-3d.ts#L28) [packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:28](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/orbit- canvas-3d.ts#L28)
___ ___
@ -69,4 +69,4 @@ title: OrbitCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:13](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/orbit- canvas-3d.ts#L13) [packages/g6/src/stdlib/behavior/orbit-canvas-3d.ts:13](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/orbit- canvas-3d.ts#L13)

12
packages/site/docs/apis/interfaces/behaviors/RotateCanvas3DOptions.en.md
View File

@ -16,7 +16,7 @@ The event name to trigger when drag end.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:31](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts#L31) [packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:31](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts#L31)
___ ___
@ -31,7 +31,7 @@ to make the behavior triggered only when the key is pressing and trigger is happ
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:19](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts#L19) [packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:19](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts#L19)
___ ___
@ -57,7 +57,7 @@ Whether allow the behavior happen on the current item.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:35](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts#L35) [packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:35](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts#L35)
___ ___
@ -69,7 +69,7 @@ To speed up rotating while pressing and rotate the canvas by direciton keys (tri
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:23](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts#L23) [packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:23](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts#L23)
___ ___
@ -81,7 +81,7 @@ The way to tranlate the canvas. 'drag' (default) means dragged by mouse, 'direct
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:12](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts#L12) [packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:12](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts#L12)
___ ___
@ -93,4 +93,4 @@ Whether allow zooming canvas on a node/edge/combo.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:27](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts#L27) [packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:27](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts#L27)

12
packages/site/docs/apis/interfaces/behaviors/RotateCanvas3DOptions.zh.md
View File

@ -16,7 +16,7 @@ title: RotateCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:31](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/rotate- canvas-3d.ts#L31) [packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:31](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/rotate- canvas-3d.ts#L31)
___ ___
@ -31,7 +31,7 @@ title: RotateCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:19](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/rotate- canvas-3d.ts#L19) [packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:19](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/rotate- canvas-3d.ts#L19)
___ ___
@ -57,7 +57,7 @@ title: RotateCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:35](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/rotate- canvas-3d.ts#L35) [packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:35](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/rotate- canvas-3d.ts#L35)
___ ___
@ -69,7 +69,7 @@ title: RotateCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:23](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/rotate- canvas-3d.ts#L23) [packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:23](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/rotate- canvas-3d.ts#L23)
___ ___
@ -81,7 +81,7 @@ title: RotateCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:12](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/rotate- canvas-3d.ts#L12) [packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:12](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/rotate- canvas-3d.ts#L12)
___ ___
@ -93,4 +93,4 @@ title: RotateCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:27](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/rotate- canvas-3d.ts#L27) [packages/g6/src/stdlib/behavior/rotate-canvas-3d.ts:27](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/rotate- canvas-3d.ts#L27)

8
packages/site/docs/apis/interfaces/behaviors/TrackCanvas3DOptions.en.md
View File

@ -16,7 +16,7 @@ The event name to trigger when drag end.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/track-canvas-3d.ts:24](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/track-canvas-3d.ts#L24) [packages/g6/src/stdlib/behavior/track-canvas-3d.ts:24](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/track-canvas-3d.ts#L24)
___ ___
@ -31,7 +31,7 @@ to make the behavior triggered only when the key is pressing and trigger is happ
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/track-canvas-3d.ts:20](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/track-canvas-3d.ts#L20) [packages/g6/src/stdlib/behavior/track-canvas-3d.ts:20](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/track-canvas-3d.ts#L20)
___ ___
@ -57,7 +57,7 @@ Whether allow the behavior happen on the current item.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/track-canvas-3d.ts:28](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/track-canvas-3d.ts#L28) [packages/g6/src/stdlib/behavior/track-canvas-3d.ts:28](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/track-canvas-3d.ts#L28)
___ ___
@ -69,4 +69,4 @@ The way to tranlate the canvas. 'drag' (default) means dragged by mouse, 'direct
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/track-canvas-3d.ts:13](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/track-canvas-3d.ts#L13) [packages/g6/src/stdlib/behavior/track-canvas-3d.ts:13](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/track-canvas-3d.ts#L13)

8
packages/site/docs/apis/interfaces/behaviors/TrackCanvas3DOptions.zh.md
View File

@ -16,7 +16,7 @@ title: TrackCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/track-canvas-3d.ts:24](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/track- canvas-3d.ts#L24) [packages/g6/src/stdlib/behavior/track-canvas-3d.ts:24](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/track- canvas-3d.ts#L24)
___ ___
@ -31,7 +31,7 @@ title: TrackCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/track-canvas-3d.ts:20](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/track- canvas-3d.ts#L20) [packages/g6/src/stdlib/behavior/track-canvas-3d.ts:20](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/track- canvas-3d.ts#L20)
___ ___
@ -57,7 +57,7 @@ title: TrackCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/track-canvas-3d.ts:28](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/track- canvas-3d.ts#L28) [packages/g6/src/stdlib/behavior/track-canvas-3d.ts:28](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/track- canvas-3d.ts#L28)
___ ___
@ -69,4 +69,4 @@ title: TrackCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/track-canvas-3d.ts:13](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/track- canvas-3d.ts#L13) [packages/g6/src/stdlib/behavior/track-canvas-3d.ts:13](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/track- canvas-3d.ts#L13)

16
packages/site/docs/apis/interfaces/behaviors/ZoomCanvas3DOptions.en.md
View File

@ -16,7 +16,7 @@ The event name to trigger when drag end.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:33](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L33) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:33](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L33)
___ ___
@ -28,7 +28,7 @@ The max value of camera's dolly to constrain the zoom-canvas-3d behavior
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:41](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L41) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:41](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L41)
___ ___
@ -40,7 +40,7 @@ The min value of camera's dolly to constrain the zoom-canvas-3d behavior
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:37](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L37) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:37](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L37)
___ ___
@ -55,7 +55,7 @@ to make the behavior triggered only when the key is pressing and trigger is happ
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:21](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L21) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:21](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L21)
___ ___
@ -67,7 +67,7 @@ Sensitivity of zooming.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:25](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L25) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:25](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L25)
___ ___
@ -93,7 +93,7 @@ Whether allow the behavior happen on the current item.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:45](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L45) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:45](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L45)
___ ___
@ -105,7 +105,7 @@ The way to tranlate the canvas. 'drag' (default) means dragged by mouse, 'direct
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:14](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L14) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:14](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L14)
___ ___
@ -117,4 +117,4 @@ Whether allow zooming canvas on a node/edge/combo.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:29](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L29) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:29](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts#L29)

16
packages/site/docs/apis/interfaces/behaviors/ZoomCanvas3DOptions.zh.md
View File

@ -16,7 +16,7 @@ title: ZoomCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:33](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L33) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:33](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L33)
___ ___
@ -28,7 +28,7 @@ title: ZoomCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:41](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L41) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:41](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L41)
___ ___
@ -40,7 +40,7 @@ title: ZoomCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:37](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L37) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:37](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L37)
___ ___
@ -55,7 +55,7 @@ title: ZoomCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:21](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L21) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:21](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L21)
___ ___
@ -67,7 +67,7 @@ title: ZoomCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:25](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L25) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:25](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L25)
___ ___
@ -93,7 +93,7 @@ title: ZoomCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:45](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L45) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:45](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L45)
___ ___
@ -105,7 +105,7 @@ title: ZoomCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:14](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L14) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:14](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L14)
___ ___
@ -117,4 +117,4 @@ title: ZoomCanvas3DOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:29](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L29) [packages/g6/src/stdlib/behavior/zoom-canvas-3d.ts:29](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom- canvas-3d.ts#L29)

20
packages/site/docs/apis/interfaces/behaviors/ZoomCanvasOptions.en.md
View File

@ -17,7 +17,7 @@ TODO: optimize when trigger is upDownKeys
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:10](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L10) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:10](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L10)
___ ___
@ -29,7 +29,7 @@ The event name to trigger when zoom end.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:34](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L34) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:34](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L34)
___ ___
@ -41,7 +41,7 @@ The max value of zoom ratio to constrain the zoom-canvas-3d behavior
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:42](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L42) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:42](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L42)
___ ___
@ -53,7 +53,7 @@ The min value of zoom ratio to constrain the zoom-canvas-3d behavior
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:38](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L38) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:38](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L38)
___ ___
@ -65,7 +65,7 @@ The assistant secondary key on keyboard. If it is not assigned, the behavior wil
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L22) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:22](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L22)
___ ___
@ -77,7 +77,7 @@ The sensitivity / speed of zooming.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:30](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L30) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:30](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L30)
___ ___
@ -103,7 +103,7 @@ Whether allow the behavior happen on the current item.
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:46](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L46) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:46](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L46)
___ ___
@ -115,7 +115,7 @@ The key on keyboard to speed up translating while pressing and zoom-canvas by di
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:26](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L26) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:26](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L26)
___ ___
@ -127,7 +127,7 @@ The trigger for the behavior, 'wheel' by default. 'upDownKeys' means trigger thi
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:18](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L18) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:18](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L18)
___ ___
@ -139,4 +139,4 @@ Whether allow trigger this behavior when wheeling start on nodes / edges / combo
#### Defined in #### Defined in
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:14](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L14) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:14](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas.ts#L14)

20
packages/site/docs/apis/interfaces/behaviors/ZoomCanvasOptions.zh.md
View File

@ -17,7 +17,7 @@ title: ZoomCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:10](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L10) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:10](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas。 ts#L10)
___ ___
@ -29,7 +29,7 @@ title: ZoomCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:34](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L34) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:34](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L34)
___ ___
@ -41,7 +41,7 @@ title: ZoomCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:42](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L42) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:42](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L42)
___ ___
@ -53,7 +53,7 @@ title: ZoomCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:38](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L38) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:38](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L38)
___ ___
@ -65,7 +65,7 @@ title: ZoomCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L22) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:22](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L22)
___ ___
@ -77,7 +77,7 @@ title: ZoomCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:30](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L30) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:30](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L30)
___ ___
@ -103,7 +103,7 @@ title: ZoomCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:46](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L46) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:46](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L46)
___ ___
@ -115,7 +115,7 @@ title: ZoomCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:26](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L26) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:26](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L26)
___ ___
@ -127,7 +127,7 @@ title: ZoomCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:18](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L18) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:18](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L18)
___ ___
@ -139,4 +139,4 @@ title: ZoomCanvasOptions
#### 定义于 #### 定义于
[packages/g6/src/stdlib/behavior/zoom-canvas.ts:14](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L14) [packages/g6/src/stdlib/behavior/zoom-canvas.ts:14](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/behavior/zoom-canvas. ts#L14)

6
packages/site/docs/apis/interfaces/graph/GraphData.en.md
View File

@ -14,7 +14,7 @@ title: GraphData
#### Defined in #### Defined in
[packages/g6/src/types/data.ts:14](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/data.ts#L14) [packages/g6/src/types/data.ts:14](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/data.ts#L14)
___ ___
@ -24,7 +24,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/data.ts:13](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/data.ts#L13) [packages/g6/src/types/data.ts:13](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/data.ts#L13)
___ ___
@ -34,4 +34,4 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/data.ts:12](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/data.ts#L12) [packages/g6/src/types/data.ts:12](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/data.ts#L12)

6
packages/site/docs/apis/interfaces/graph/GraphData.zh.md
View File

@ -14,7 +14,7 @@ title: GraphData
#### 定义于 #### 定义于
[packages/g6/src/types/data.ts:14](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/data.ts#L14) [packages/g6/src/types/data.ts:14](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/data.ts#L14)
___ ___
@ -24,7 +24,7 @@ title: GraphData
#### 定义于 #### 定义于
[packages/g6/src/types/data.ts:13](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/data.ts#L13) [packages/g6/src/types/data.ts:13](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/data.ts#L13)
___ ___
@ -34,4 +34,4 @@ title: GraphData
#### 定义于 #### 定义于
[packages/g6/src/types/data.ts:12](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/data.ts#L12) [packages/g6/src/types/data.ts:12](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/data.ts#L12)

218
packages/site/docs/apis/interfaces/graph/IGraph.en.md
View File

@ -56,7 +56,7 @@ whether success
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:554](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L554) [packages/g6/src/types/graph.ts:554](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L554)
___ ___
@ -83,7 +83,7 @@ Collapse a combo.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:564](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L564) [packages/g6/src/types/graph.ts:564](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L564)
___ ___
@ -110,17 +110,17 @@ Expand a combo.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:571](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L571) [packages/g6/src/types/graph.ts:571](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L571)
## Data ## Data
### addData ### addData
• **addData**: (`itemType`: `ITEM_TYPE`, `model`: `NodeUserModel` \| `ComboUserModel` \| `EdgeUserModel` \| `NodeUserModel`[] \| `EdgeUserModel`[] \| `ComboUserModel`[], `stack?`: `boolean`) => `NodeModel` \| `ComboModel` \| `EdgeModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[] • **addData**: (`itemType`: `ITEM_TYPE`, `model`: `NodeUserModel` \| `EdgeUserModel` \| `ComboUserModel` \| `NodeUserModel`[] \| `EdgeUserModel`[] \| `ComboUserModel`[], `stack?`: `boolean`) => `NodeModel` \| `EdgeModel` \| `ComboModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[]
#### Type declaration #### Type declaration
▸ (`itemType`, `model`, `stack?`): `NodeModel` \| `ComboModel` \| `EdgeModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[] ▸ (`itemType`, `model`, `stack?`): `NodeModel` \| `EdgeModel` \| `ComboModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[]
Add one or more node/edge/combo data to the graph. Add one or more node/edge/combo data to the graph.
@ -129,18 +129,18 @@ Add one or more node/edge/combo data to the graph.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `itemType` | `ITEM_TYPE` | item type | | `itemType` | `ITEM_TYPE` | item type |
| `model` | `NodeUserModel` \| `ComboUserModel` \| `EdgeUserModel` \| `NodeUserModel`[] \| `EdgeUserModel`[] \| `ComboUserModel`[] | user data | | `model` | `NodeUserModel` \| `EdgeUserModel` \| `ComboUserModel` \| `NodeUserModel`[] \| `EdgeUserModel`[] \| `ComboUserModel`[] | user data |
| `stack?` | `boolean` | whether push this operation to stack | | `stack?` | `boolean` | whether push this operation to stack |
##### Returns ##### Returns
`NodeModel` \| `ComboModel` \| `EdgeModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[] `NodeModel` \| `EdgeModel` \| `ComboModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[]
whehter success whehter success
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:177](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L177) [packages/g6/src/types/graph.ts:177](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L177)
___ ___
@ -167,7 +167,7 @@ Change graph data.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:148](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L148) [packages/g6/src/types/graph.ts:148](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L148)
___ ___
@ -189,7 +189,7 @@ all combos' inner data on the graph
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:99](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L99) [packages/g6/src/types/graph.ts:99](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L99)
___ ___
@ -211,7 +211,7 @@ all edges' inner data on the graph
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:93](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L93) [packages/g6/src/types/graph.ts:93](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L93)
___ ___
@ -233,7 +233,7 @@ all nodes' inner data on the graph
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:87](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L87) [packages/g6/src/types/graph.ts:87](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L87)
___ ___
@ -261,7 +261,7 @@ result combo's inner data
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:81](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L81) [packages/g6/src/types/graph.ts:81](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L81)
___ ___
@ -289,7 +289,7 @@ result edge's inner data
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:74](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L74) [packages/g6/src/types/graph.ts:74](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L74)
___ ___
@ -318,7 +318,7 @@ one-hop node ids
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:116](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L116) [packages/g6/src/types/graph.ts:116](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L116)
___ ___
@ -346,7 +346,7 @@ result node's inner data
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:67](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L67) [packages/g6/src/types/graph.ts:67](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L67)
___ ___
@ -375,13 +375,13 @@ one-hop edge ids
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:106](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L106) [packages/g6/src/types/graph.ts:106](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L106)
___ ___
### moveCombo ### moveCombo
• **moveCombo**: (`ids`: `ID`[], `dx`: `number`, `dy`: `number`, `upsertAncestors?`: `boolean`, `callback?`: (`model`: `NodeModel` \| `ComboModel` \| `EdgeModel`, `canceled?`: `boolean`) => `void`, `stack?`: `boolean`) => `ComboModel`[] • **moveCombo**: (`ids`: `ID`[], `dx`: `number`, `dy`: `number`, `upsertAncestors?`: `boolean`, `callback?`: (`model`: `NodeModel` \| `EdgeModel` \| `ComboModel`, `canceled?`: `boolean`) => `void`, `stack?`: `boolean`) => `ComboModel`[]
#### Type declaration #### Type declaration
@ -399,7 +399,7 @@ In fact, it changes the succeed nodes positions to affect the combo's position,
| `dx` | `number` | - | | `dx` | `number` | - |
| `dy` | `number` | - | | `dy` | `number` | - |
| `upsertAncestors?` | `boolean` | - | | `upsertAncestors?` | `boolean` | - |
| `callback?` | (`model`: `NodeModel` \| `ComboModel` \| `EdgeModel`, `canceled?`: `boolean`) => `void` | - | | `callback?` | (`model`: `NodeModel` \| `EdgeModel` \| `ComboModel`, `canceled?`: `boolean`) => `void` | - |
| `stack?` | `boolean` | whether push this operation into graph's stack, true by default | | `stack?` | `boolean` | whether push this operation into graph's stack, true by default |
##### Returns ##### Returns
@ -408,7 +408,7 @@ In fact, it changes the succeed nodes positions to affect the combo's position,
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:278](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L278) [packages/g6/src/types/graph.ts:278](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L278)
___ ___
@ -435,7 +435,7 @@ If there is old data, diffs and changes it.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:140](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L140) [packages/g6/src/types/graph.ts:140](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L140)
___ ___
@ -465,7 +465,7 @@ whehter success
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:201](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L201) [packages/g6/src/types/graph.ts:201](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L201)
___ ___
@ -492,13 +492,13 @@ Show the item(s).
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:466](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L466) [packages/g6/src/types/graph.ts:466](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L466)
___ ___
### updateComboPosition ### updateComboPosition
• **updateComboPosition**: (`models`: `Partial`<`ComboUserModel`\> \| `Partial`<`ComboUserModel` \| `Partial`<`NodeUserModel`\>[] \| `Partial`<`ComboUserModel`\>[]\>, `upsertAncestors?`: `boolean`, `disableAnimate?`: `boolean`, `callback?`: (`model`: `NodeModel` \| `ComboModel` \| `EdgeModel`) => `void`, `stack?`: `boolean`) => `NodeModel` \| `ComboModel` \| `NodeModel`[] \| `ComboModel`[] • **updateComboPosition**: (`models`: `Partial`<`ComboUserModel`\> \| `Partial`<`ComboUserModel` \| `Partial`<`NodeUserModel`\>[] \| `Partial`<`ComboUserModel`\>[]\>, `upsertAncestors?`: `boolean`, `disableAnimate?`: `boolean`, `callback?`: (`model`: `NodeModel` \| `EdgeModel` \| `ComboModel`) => `void`, `stack?`: `boolean`) => `NodeModel` \| `ComboModel` \| `NodeModel`[] \| `ComboModel`[]
#### Type declaration #### Type declaration
@ -514,7 +514,7 @@ Do not update other styles which leads to better performance than updating posit
| `models` | `Partial`<`ComboUserModel`\> \| `Partial`<`ComboUserModel` \| `Partial`<`NodeUserModel`\>[] \| `Partial`<`ComboUserModel`\>[]\> | new configurations with x and y for every combo, which has id field to indicate the specific item | | `models` | `Partial`<`ComboUserModel`\> \| `Partial`<`ComboUserModel` \| `Partial`<`NodeUserModel`\>[] \| `Partial`<`ComboUserModel`\>[]\> | new configurations with x and y for every combo, which has id field to indicate the specific item |
| `upsertAncestors?` | `boolean` | - | | `upsertAncestors?` | `boolean` | - |
| `disableAnimate?` | `boolean` | - | | `disableAnimate?` | `boolean` | - |
| `callback?` | (`model`: `NodeModel` \| `ComboModel` \| `EdgeModel`) => `void` | - | | `callback?` | (`model`: `NodeModel` \| `EdgeModel` \| `ComboModel`) => `void` | - |
| `stack?` | `boolean` | whether push this operation into graph's stack, true by default | | `stack?` | `boolean` | whether push this operation into graph's stack, true by default |
##### Returns ##### Returns
@ -523,17 +523,17 @@ Do not update other styles which leads to better performance than updating posit
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:258](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L258) [packages/g6/src/types/graph.ts:258](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L258)
___ ___
### updateData ### updateData
• **updateData**: (`itemType`: `ITEM_TYPE`, `model`: `Partial`<`NodeUserModel`\> \| `Partial`<`EdgeUserModel`\> \| `Partial`<`ComboUserModel` \| `Partial`<`NodeUserModel`\>[] \| `Partial`<`EdgeUserModel`\>[] \| `Partial`<`ComboUserModel`\>[]\>, `stack?`: `boolean`) => `NodeModel` \| `ComboModel` \| `EdgeModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[] • **updateData**: (`itemType`: `ITEM_TYPE`, `model`: `Partial`<`NodeUserModel`\> \| `Partial`<`EdgeUserModel`\> \| `Partial`<`ComboUserModel` \| `Partial`<`NodeUserModel`\>[] \| `Partial`<`EdgeUserModel`\>[] \| `Partial`<`ComboUserModel`\>[]\>, `stack?`: `boolean`) => `NodeModel` \| `EdgeModel` \| `ComboModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[]
#### Type declaration #### Type declaration
▸ (`itemType`, `model`, `stack?`): `NodeModel` \| `ComboModel` \| `EdgeModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[] ▸ (`itemType`, `model`, `stack?`): `NodeModel` \| `EdgeModel` \| `ComboModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[]
Update one or more node/edge/combo data on the graph. Update one or more node/edge/combo data on the graph.
@ -547,17 +547,17 @@ Update one or more node/edge/combo data on the graph.
##### Returns ##### Returns
`NodeModel` \| `ComboModel` \| `EdgeModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[] `NodeModel` \| `EdgeModel` \| `ComboModel` \| `NodeModel`[] \| `EdgeModel`[] \| `ComboModel`[]
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:209](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L209) [packages/g6/src/types/graph.ts:209](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L209)
___ ___
### updateNodePosition ### updateNodePosition
• **updateNodePosition**: (`models`: `Partial`<`NodeUserModel`\> \| `Partial`<`ComboUserModel` \| `Partial`<`NodeUserModel`\>[] \| `Partial`<`ComboUserModel`\>[]\>, `upsertAncestors?`: `boolean`, `disableAnimate?`: `boolean`, `callback?`: (`model`: `NodeModel` \| `ComboModel` \| `EdgeModel`, `canceled?`: `boolean`) => `void`, `stack?`: `boolean`) => `NodeModel` \| `ComboModel` \| `NodeModel`[] \| `ComboModel`[] • **updateNodePosition**: (`models`: `Partial`<`NodeUserModel`\> \| `Partial`<`ComboUserModel` \| `Partial`<`NodeUserModel`\>[] \| `Partial`<`ComboUserModel`\>[]\>, `upsertAncestors?`: `boolean`, `disableAnimate?`: `boolean`, `callback?`: (`model`: `NodeModel` \| `EdgeModel` \| `ComboModel`, `canceled?`: `boolean`) => `void`, `stack?`: `boolean`) => `NodeModel` \| `ComboModel` \| `NodeModel`[] \| `ComboModel`[]
#### Type declaration #### Type declaration
@ -573,7 +573,7 @@ do not update other styles which leads to better performance than updating posit
| `models` | `Partial`<`NodeUserModel`\> \| `Partial`<`ComboUserModel` \| `Partial`<`NodeUserModel`\>[] \| `Partial`<`ComboUserModel`\>[]\> | new configurations with x and y for every node, which has id field to indicate the specific item | | `models` | `Partial`<`NodeUserModel`\> \| `Partial`<`ComboUserModel` \| `Partial`<`NodeUserModel`\>[] \| `Partial`<`ComboUserModel`\>[]\> | new configurations with x and y for every node, which has id field to indicate the specific item |
| `upsertAncestors?` | `boolean` | - | | `upsertAncestors?` | `boolean` | - |
| `disableAnimate?` | `boolean` | - | | `disableAnimate?` | `boolean` | - |
| `callback?` | (`model`: `NodeModel` \| `ComboModel` \| `EdgeModel`, `canceled?`: `boolean`) => `void` | - | | `callback?` | (`model`: `NodeModel` \| `EdgeModel` \| `ComboModel`, `canceled?`: `boolean`) => `void` | - |
| `stack?` | `boolean` | whether push this operation into graph's stack, true by default | | `stack?` | `boolean` | whether push this operation into graph's stack, true by default |
##### Returns ##### Returns
@ -582,7 +582,7 @@ do not update other styles which leads to better performance than updating posit
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:236](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L236) [packages/g6/src/types/graph.ts:236](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L236)
## Graph Instance ## Graph Instance
@ -608,13 +608,13 @@ Destroy the graph instance and remove the related canvases.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:39](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L39) [packages/g6/src/types/graph.ts:39](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L39)
## Interaction ## Interaction
### drawTransient ### drawTransient
• **drawTransient**: (`type`: `SHAPE_TYPE` \| `ITEM_TYPE`, `id`: `ID`, `config`: `any`) => `DisplayObject`<`any`, `any`\> • **drawTransient**: (`type`: `ITEM_TYPE` \| `SHAPE_TYPE`, `id`: `ID`, `config`: `any`) => `DisplayObject`<`any`, `any`\>
#### Type declaration #### Type declaration
@ -626,7 +626,7 @@ Draw or update a G shape or group to the transient canvas.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `type` | `SHAPE_TYPE` \| `ITEM_TYPE` | shape type or item type | | `type` | `ITEM_TYPE` \| `SHAPE_TYPE` | shape type or item type |
| `id` | `ID` | new shape id or updated shape id for a interation shape, node/edge/combo id for item interaction group drawing | | `id` | `ID` | new shape id or updated shape id for a interation shape, node/edge/combo id for item interaction group drawing |
| `config` | `any` | - | | `config` | `any` | - |
@ -638,7 +638,7 @@ upserted shape or group
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:628](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L628) [packages/g6/src/types/graph.ts:628](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L628)
___ ___
@ -660,7 +660,7 @@ mode name
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:593](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L593) [packages/g6/src/types/graph.ts:593](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L593)
___ ___
@ -687,7 +687,7 @@ Remove behavior(s) from mode(s).
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:611](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L611) [packages/g6/src/types/graph.ts:611](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L611)
___ ___
@ -713,7 +713,7 @@ Switch mode.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:587](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L587) [packages/g6/src/types/graph.ts:587](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L587)
___ ___
@ -740,7 +740,7 @@ Update a behavior on a mode.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:619](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L619) [packages/g6/src/types/graph.ts:619](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L619)
## Item ## Item
@ -767,7 +767,7 @@ Make the item(s) to the back.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:487](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L487) [packages/g6/src/types/graph.ts:487](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L487)
___ ___
@ -795,13 +795,13 @@ Clear all the states for item(s).
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:524](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L524) [packages/g6/src/types/graph.ts:524](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L524)
___ ___
### findIdByState ### findIdByState
• **findIdByState**: (`itemType`: `ITEM_TYPE`, `state`: `string`, `value?`: `string` \| `boolean`, `additionalFilter?`: (`model`: `NodeModel` \| `ComboModel` \| `EdgeModel`) => `boolean`) => `ID`[] • **findIdByState**: (`itemType`: `ITEM_TYPE`, `state`: `string`, `value?`: `string` \| `boolean`, `additionalFilter?`: (`model`: `NodeModel` \| `EdgeModel` \| `ComboModel`) => `boolean`) => `ID`[]
#### Type declaration #### Type declaration
@ -816,7 +816,7 @@ Find items which has the state.
| `itemType` | `ITEM_TYPE` | item type | | `itemType` | `ITEM_TYPE` | item type |
| `state` | `string` | state name | | `state` | `string` | state name |
| `value?` | `string` \| `boolean` | state value, true by default | | `value?` | `string` \| `boolean` | state value, true by default |
| `additionalFilter?` | (`model`: `NodeModel` \| `ComboModel` \| `EdgeModel`) => `boolean` | additional filter function | | `additionalFilter?` | (`model`: `NodeModel` \| `EdgeModel` \| `ComboModel`) => `boolean` | additional filter function |
##### Returns ##### Returns
@ -826,7 +826,7 @@ items that is the type and has the state
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:163](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L163) [packages/g6/src/types/graph.ts:163](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L163)
___ ___
@ -853,7 +853,7 @@ Make the item(s) to the front.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:480](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L480) [packages/g6/src/types/graph.ts:480](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L480)
___ ___
@ -881,7 +881,7 @@ the state names with value true
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:516](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L516) [packages/g6/src/types/graph.ts:516](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L516)
___ ___
@ -910,7 +910,7 @@ the state value
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:509](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L509) [packages/g6/src/types/graph.ts:509](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L509)
___ ___
@ -937,7 +937,7 @@ Hide the item(s).
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:473](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L473) [packages/g6/src/types/graph.ts:473](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L473)
___ ___
@ -966,7 +966,7 @@ Set state for the item(s).
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:496](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L496) [packages/g6/src/types/graph.ts:496](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L496)
## Methods ## Methods
@ -1119,7 +1119,7 @@ Add plugin(s) to graph.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:640](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L640) [packages/g6/src/types/graph.ts:640](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L640)
___ ___
@ -1145,7 +1145,7 @@ Remove plugin(s) from graph.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:654](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L654) [packages/g6/src/types/graph.ts:654](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L654)
___ ___
@ -1173,7 +1173,7 @@ Update one plugin of the graph.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:662](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L662) [packages/g6/src/types/graph.ts:662](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L662)
## Properties ## Properties
@ -1200,7 +1200,7 @@ Add behavior(s) to mode(s).
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:600](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L600) [packages/g6/src/types/graph.ts:600](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L600)
___ ___
@ -1228,7 +1228,7 @@ more convenient way without manually invoking `startBatch` and `stopBatch`.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:752](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L752) [packages/g6/src/types/graph.ts:752](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L752)
___ ___
@ -1248,7 +1248,7 @@ Indicate whether there are any actions available in the redo stack.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:730](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L730) [packages/g6/src/types/graph.ts:730](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L730)
___ ___
@ -1268,7 +1268,7 @@ Indicate whether there are any actions available in the undo stack.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:725](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L725) [packages/g6/src/types/graph.ts:725](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L725)
___ ___
@ -1278,7 +1278,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:27](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L27) [packages/g6/src/types/graph.ts:27](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L27)
___ ___
@ -1304,7 +1304,7 @@ Change the renderer at runtime.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:58](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L58) [packages/g6/src/types/graph.ts:58](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L58)
___ ___
@ -1324,7 +1324,7 @@ Clear the graph, means remove all the items on the graph.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:153](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L153) [packages/g6/src/types/graph.ts:153](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L153)
___ ___
@ -1352,7 +1352,7 @@ more convenient way without manually invoking `startBatch` and `stopBatch`.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:759](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L759) [packages/g6/src/types/graph.ts:759](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L759)
___ ___
@ -1362,7 +1362,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:30](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L30) [packages/g6/src/types/graph.ts:30](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L30)
___ ___
@ -1372,7 +1372,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:29](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L29) [packages/g6/src/types/graph.ts:29](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L29)
___ ___
@ -1398,7 +1398,7 @@ Execute a callback without allowing any stacking operations.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:693](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L693) [packages/g6/src/types/graph.ts:693](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L693)
___ ___
@ -1422,7 +1422,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:132](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L132) [packages/g6/src/types/graph.ts:132](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L132)
___ ___
@ -1450,7 +1450,7 @@ visibility for the item, false for invisible or unexistence for the item
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:542](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L542) [packages/g6/src/types/graph.ts:542](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L542)
___ ___
@ -1478,7 +1478,7 @@ edges
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:125](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L125) [packages/g6/src/types/graph.ts:125](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L125)
___ ___
@ -1498,7 +1498,7 @@ Retrieve the current undo stack which consists of operations that were undone
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:702](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L702) [packages/g6/src/types/graph.ts:702](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L702)
___ ___
@ -1528,7 +1528,7 @@ rendering bounding box. returns false if the item is not exist
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:531](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L531) [packages/g6/src/types/graph.ts:531](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L531)
___ ___
@ -1550,7 +1550,7 @@ graph specs
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:52](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L52) [packages/g6/src/types/graph.ts:52](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L52)
___ ___
@ -1570,7 +1570,7 @@ Retrieve the complete history stack
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:708](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L708) [packages/g6/src/types/graph.ts:708](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L708)
___ ___
@ -1590,7 +1590,7 @@ Retrieve the current redo stack which consists of operations that could be undon
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:697](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L697) [packages/g6/src/types/graph.ts:697](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L697)
___ ___
@ -1610,7 +1610,7 @@ Return the center of viewport, e.g. for a 500 * 500 canvas, its center is [250,
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:381](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L381) [packages/g6/src/types/graph.ts:381](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L381)
___ ___
@ -1632,7 +1632,7 @@ current zoom
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:319](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L319) [packages/g6/src/types/graph.ts:319](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L319)
___ ___
@ -1642,7 +1642,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:26](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L26) [packages/g6/src/types/graph.ts:26](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L26)
___ ___
@ -1662,7 +1662,7 @@ Determine if history (redo/undo) is enabled.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:673](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L673) [packages/g6/src/types/graph.ts:673](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L673)
___ ___
@ -1689,7 +1689,7 @@ Layout the graph (with current configurations if cfg is not assigned).
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:577](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L577) [packages/g6/src/types/graph.ts:577](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L577)
___ ___
@ -1709,7 +1709,7 @@ Pause stacking operation.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:684](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L684) [packages/g6/src/types/graph.ts:684](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L684)
___ ___
@ -1736,7 +1736,7 @@ Push the operation(s) onto the specified stack
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:680](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L680) [packages/g6/src/types/graph.ts:680](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L680)
___ ___
@ -1756,7 +1756,7 @@ Restore the operation that was last n reverted on the graph.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:720](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L720) [packages/g6/src/types/graph.ts:720](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L720)
___ ___
@ -1766,7 +1766,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:31](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L31) [packages/g6/src/types/graph.ts:31](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L31)
___ ___
@ -1786,7 +1786,7 @@ Resume stacking operation.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:688](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L688) [packages/g6/src/types/graph.ts:688](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L688)
___ ___
@ -1814,7 +1814,7 @@ Rotate the graph with a relative angle in clockwise.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:348](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L348) [packages/g6/src/types/graph.ts:348](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L348)
___ ___
@ -1842,7 +1842,7 @@ Rotate the graph to an absolute angle in clockwise.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:359](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L359) [packages/g6/src/types/graph.ts:359](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L359)
___ ___
@ -1864,7 +1864,7 @@ treated as a single operation when undoing or redoing.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:737](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L737) [packages/g6/src/types/graph.ts:737](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L737)
___ ___
@ -1886,7 +1886,7 @@ treated as a single operation when undoing or redoing.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:744](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L744) [packages/g6/src/types/graph.ts:744](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L744)
___ ___
@ -1904,7 +1904,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:578](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L578) [packages/g6/src/types/graph.ts:578](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L578)
___ ___
@ -1924,7 +1924,7 @@ Stop the current transition of transform immediately.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:377](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L377) [packages/g6/src/types/graph.ts:377](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L377)
___ ___
@ -1951,7 +1951,7 @@ Transform the graph with a CSS-Transform-like syntax.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:370](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L370) [packages/g6/src/types/graph.ts:370](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L370)
___ ___
@ -1961,7 +1961,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:28](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L28) [packages/g6/src/types/graph.ts:28](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L28)
___ ___
@ -1988,7 +1988,7 @@ Move the graph with a relative vector.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:298](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L298) [packages/g6/src/types/graph.ts:298](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L298)
___ ___
@ -2015,7 +2015,7 @@ Move the graph and align to a point.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:311](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L311) [packages/g6/src/types/graph.ts:311](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L311)
___ ___
@ -2035,7 +2035,7 @@ Revert the last n operation(s) on the graph.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:714](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L714) [packages/g6/src/types/graph.ts:714](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L714)
___ ___
@ -2061,7 +2061,7 @@ Update the specs (configurations).
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:43](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L43) [packages/g6/src/types/graph.ts:43](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L43)
___ ___
@ -2087,7 +2087,7 @@ Update the theme specs (configurations).
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:47](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L47) [packages/g6/src/types/graph.ts:47](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L47)
___ ___
@ -2115,7 +2115,7 @@ Zoom the graph with a relative ratio.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:326](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L326) [packages/g6/src/types/graph.ts:326](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L326)
___ ___
@ -2143,7 +2143,7 @@ Zoom the graph to a specified ratio.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:337](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L337) [packages/g6/src/types/graph.ts:337](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L337)
## Tree ## Tree
@ -2171,7 +2171,7 @@ Collapse sub tree(s).
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:769](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L769) [packages/g6/src/types/graph.ts:769](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L769)
___ ___
@ -2199,7 +2199,7 @@ Expand sub tree(s).
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:778](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L778) [packages/g6/src/types/graph.ts:778](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L778)
## View ## View
@ -2225,7 +2225,7 @@ Fit the graph center to the view center.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:403](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L403) [packages/g6/src/types/graph.ts:403](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L403)
___ ___
@ -2254,7 +2254,7 @@ Fit the graph content to the view.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:390](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L390) [packages/g6/src/types/graph.ts:390](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L390)
___ ___
@ -2281,7 +2281,7 @@ Move the graph to make the item align the view center.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:410](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L410) [packages/g6/src/types/graph.ts:410](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L410)
___ ___
@ -2309,7 +2309,7 @@ rendering coordinate
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:457](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L457) [packages/g6/src/types/graph.ts:457](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L457)
___ ___
@ -2337,7 +2337,7 @@ canvas dom (viewport) coordinate
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:433](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L433) [packages/g6/src/types/graph.ts:433](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L433)
___ ___
@ -2365,7 +2365,7 @@ browser coordinate
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:449](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L449) [packages/g6/src/types/graph.ts:449](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L449)
___ ___
@ -2387,7 +2387,7 @@ Get the size of the graph canvas.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:419](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L419) [packages/g6/src/types/graph.ts:419](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L419)
___ ___
@ -2415,7 +2415,7 @@ rendering coordinate
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:441](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L441) [packages/g6/src/types/graph.ts:441](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L441)
___ ___
@ -2441,4 +2441,4 @@ Set the size for the graph canvas.
#### Defined in #### Defined in
[packages/g6/src/types/graph.ts:425](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/graph.ts#L425) [packages/g6/src/types/graph.ts:425](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/graph.ts#L425)

52
packages/site/docs/apis/interfaces/graph/Specification.en.md
View File

@ -23,7 +23,7 @@ global animate
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:113](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L113) [packages/g6/src/types/spec.ts:113](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L113)
___ ___
@ -33,7 +33,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:49](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L49) [packages/g6/src/types/spec.ts:49](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L49)
___ ___
@ -43,7 +43,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:36](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L36) [packages/g6/src/types/spec.ts:36](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L36)
___ ___
@ -53,7 +53,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:37](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L37) [packages/g6/src/types/spec.ts:37](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L37)
___ ___
@ -63,7 +63,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:83](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L83) [packages/g6/src/types/spec.ts:83](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L83)
___ ___
@ -77,7 +77,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:96](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L96) [packages/g6/src/types/spec.ts:96](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L96)
___ ___
@ -87,7 +87,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:35](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L35) [packages/g6/src/types/spec.ts:35](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L35)
___ ___
@ -99,7 +99,7 @@ data
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:71](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L71) [packages/g6/src/types/spec.ts:71](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L71)
___ ___
@ -109,7 +109,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:82](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L82) [packages/g6/src/types/spec.ts:82](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L82)
___ ___
@ -123,7 +123,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:91](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L91) [packages/g6/src/types/spec.ts:91](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L91)
___ ___
@ -133,7 +133,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:128](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L128) [packages/g6/src/types/spec.ts:128](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L128)
___ ___
@ -143,7 +143,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:40](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L40) [packages/g6/src/types/spec.ts:40](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L40)
___ ___
@ -155,7 +155,7 @@ layout
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:103](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L103) [packages/g6/src/types/spec.ts:103](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L103)
___ ___
@ -165,7 +165,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:110](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L110) [packages/g6/src/types/spec.ts:110](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L110)
___ ___
@ -181,7 +181,7 @@ interaction
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:106](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L106) [packages/g6/src/types/spec.ts:106](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L106)
___ ___
@ -193,7 +193,7 @@ item
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:81](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L81) [packages/g6/src/types/spec.ts:81](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L81)
___ ___
@ -209,7 +209,7 @@ item state styles
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:86](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L86) [packages/g6/src/types/spec.ts:86](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L86)
___ ___
@ -219,7 +219,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:68](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L68) [packages/g6/src/types/spec.ts:68](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L68)
___ ___
@ -231,7 +231,7 @@ free plugins
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:116](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L116) [packages/g6/src/types/spec.ts:116](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L116)
___ ___
@ -241,7 +241,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:41](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L41) [packages/g6/src/types/spec.ts:41](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L41)
___ ___
@ -251,7 +251,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:130](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L130) [packages/g6/src/types/spec.ts:130](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L130)
___ ___
@ -263,7 +263,7 @@ theme
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:126](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L126) [packages/g6/src/types/spec.ts:126](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L126)
___ ___
@ -273,7 +273,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:72](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L72) [packages/g6/src/types/spec.ts:72](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L72)
___ ___
@ -283,7 +283,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:38](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L38) [packages/g6/src/types/spec.ts:38](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L38)
___ ___
@ -293,7 +293,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:39](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L39) [packages/g6/src/types/spec.ts:39](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L39)
___ ___
@ -303,4 +303,4 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/spec.ts:48](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/spec.ts#L48) [packages/g6/src/types/spec.ts:48](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/spec.ts#L48)

30
packages/site/docs/apis/interfaces/item/NodeUserModelData.en.md
View File

@ -25,20 +25,20 @@ More styles should be configured in node mapper.
#### Defined in #### Defined in
[packages/g6/src/types/node.ts:65](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L65) [packages/g6/src/types/node.ts:67](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L67)
___ ___
### badges ### badges
• `Optional` **badges**: { `position`: `BadgePosition` ; `text`: `string` ; `type`: ``"icon"`` \| ``"text"`` }[] • `Optional` **badges**: { `position`: `BadgePosition` ; `text`: `string` ; `type`: ``"text"`` \| ``"icon"`` }[]
The badges to show on the node. The badges to show on the node.
More styles should be configured in node mapper. More styles should be configured in node mapper.
#### Defined in #### Defined in
[packages/g6/src/types/node.ts:70](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L70) [packages/g6/src/types/node.ts:72](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L72)
___ ___
@ -51,7 +51,7 @@ More styles should be configured in node mapper.
#### Defined in #### Defined in
[packages/g6/src/types/node.ts:34](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L34) [packages/g6/src/types/node.ts:36](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L36)
___ ___
@ -68,11 +68,11 @@ More styles should be configured in node mapper.
| :------ | :------ | | :------ | :------ |
| `img?` | `string` | | `img?` | `string` |
| `text?` | `string` | | `text?` | `string` |
| `type` | ``"icon"`` \| ``"text"`` | | `type` | ``"text"`` \| ``"icon"`` |
#### Defined in #### Defined in
[packages/g6/src/types/node.ts:56](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L56) [packages/g6/src/types/node.ts:58](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L58)
___ ___
@ -84,7 +84,7 @@ Whether to be a root at when used as a tree.
#### Defined in #### Defined in
[packages/g6/src/types/node.ts:51](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L51) [packages/g6/src/types/node.ts:53](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L53)
___ ___
@ -97,7 +97,7 @@ More styles should be configured in node mapper.
#### Defined in #### Defined in
[packages/g6/src/types/node.ts:39](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L39) [packages/g6/src/types/node.ts:41](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L41)
___ ___
@ -109,7 +109,7 @@ Reserved for combo.
#### Defined in #### Defined in
[packages/g6/src/types/node.ts:47](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L47) [packages/g6/src/types/node.ts:49](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L49)
___ ___
@ -123,7 +123,7 @@ Only valid for polyline
#### Defined in #### Defined in
[packages/g6/src/types/node.ts:80](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L80) [packages/g6/src/types/node.ts:82](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L82)
___ ___
@ -135,7 +135,7 @@ Node type, e.g. 'circle-node'.
#### Defined in #### Defined in
[packages/g6/src/types/node.ts:29](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L29) [packages/g6/src/types/node.ts:31](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L31)
___ ___
@ -147,7 +147,7 @@ Whether show the node by default.
#### Defined in #### Defined in
[packages/g6/src/types/node.ts:43](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L43) [packages/g6/src/types/node.ts:45](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L45)
___ ___
@ -159,7 +159,7 @@ Node position.
#### Defined in #### Defined in
[packages/g6/src/types/node.ts:23](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L23) [packages/g6/src/types/node.ts:25](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L25)
___ ___
@ -169,7 +169,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/node.ts:24](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L24) [packages/g6/src/types/node.ts:26](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L26)
___ ___
@ -179,4 +179,4 @@ ___
#### Defined in #### Defined in
[packages/g6/src/types/node.ts:25](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L25) [packages/g6/src/types/node.ts:27](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L27)

30
packages/site/docs/apis/interfaces/item/NodeUserModelData.zh.md
View File

@ -25,20 +25,20 @@ title: NodeUserModelData
#### 定义于 #### 定义于
[packages/g6/src/types/node.ts:65](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L65) [packages/g6/src/types/node.ts:67](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L67)
___ ___
### 徽章 ### 徽章
• `可选` **徽章**: { `position`: `BadgePosition` ; `文本`: `字符串`; `类型`: ``"图标"`` \| ``“文本”`` }[] • `可选` **徽章**: { `position`: `BadgePosition` ; `文本`: `字符串`; `类型`: ``"文本"`` \| ``“图标”`` }[]
要在节点上显示的徽章。 要在节点上显示的徽章。
应该在节点映射器中配置更多样式。 应该在节点映射器中配置更多样式。
#### 定义于 #### 定义于
[packages/g6/src/types/node.ts:70](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L70) [packages/g6/src/types/node.ts:72](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L72)
___ ___
@ -51,7 +51,7 @@ title: NodeUserModelData
#### 定义于 #### 定义于
[packages/g6/src/types/node.ts:34](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L34) [packages/g6/src/types/node.ts:36](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L36)
___ ___
@ -68,11 +68,11 @@ title: NodeUserModelData
| :------ | :------ | | :------ | :------ |
| `img？` | `字符串` | | `img？` | `字符串` |
| `文字？` | `字符串` | | `文字？` | `字符串` |
| `类型` | ``“图标”`` \| ``“文本”`` | | `类型` | ``“文本”`` \| ``“图标”`` |
#### 定义于 #### 定义于
[packages/g6/src/types/node.ts:56](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L56) [packages/g6/src/types/node.ts:58](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L58)
___ ___
@ -84,7 +84,7 @@ title: NodeUserModelData
#### 定义于 #### 定义于
[packages/g6/src/types/node.ts:51](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L51) [packages/g6/src/types/node.ts:53](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L53)
___ ___
@ -97,7 +97,7 @@ title: NodeUserModelData
#### 定义于 #### 定义于
[packages/g6/src/types/node.ts:39](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L39) [packages/g6/src/types/node.ts:41](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L41)
___ ___
@ -109,7 +109,7 @@ title: NodeUserModelData
#### 定义于 #### 定义于
[packages/g6/src/types/node.ts:47](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L47) [packages/g6/src/types/node.ts:49](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L49)
___ ___
@ -123,7 +123,7 @@ title: NodeUserModelData
#### 定义于 #### 定义于
[packages/g6/src/types/node.ts:80](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L80) [packages/g6/src/types/node.ts:82](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L82)
___ ___
@ -135,7 +135,7 @@ title: NodeUserModelData
#### 定义于 #### 定义于
[packages/g6/src/types/node.ts:29](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L29) [packages/g6/src/types/node.ts:31](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L31)
___ ___
@ -147,7 +147,7 @@ title: NodeUserModelData
#### 定义于 #### 定义于
[packages/g6/src/types/node.ts:43](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L43) [packages/g6/src/types/node.ts:45](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L45)
___ ___
@ -159,7 +159,7 @@ title: NodeUserModelData
#### 定义于 #### 定义于
[packages/g6/src/types/node.ts:23](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L23) [packages/g6/src/types/node.ts:25](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L25)
___ ___
@ -169,7 +169,7 @@ title: NodeUserModelData
#### 定义于 #### 定义于
[packages/g6/src/types/node.ts:24](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L24) [packages/g6/src/types/node.ts:26](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L26)
___ ___
@ -179,4 +179,4 @@ title: NodeUserModelData
#### 定义于 #### 定义于
[packages/g6/src/types/node.ts:25](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/node.ts#L25) [packages/g6/src/types/node.ts:27](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/node.ts#L27)

30
packages/site/docs/apis/interfaces/layout/CircularLayoutOptions.en.md
View File

@ -14,7 +14,7 @@ title: CircularLayoutOptions
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:121 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:121
___ ___
@ -24,7 +24,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:112 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:112
___ ___
@ -34,7 +34,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:118 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:118
___ ___
@ -44,7 +44,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:119 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:119
___ ___
@ -54,7 +54,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:123 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:123
___ ___
@ -64,7 +64,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:117 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:117
___ ___
@ -74,17 +74,17 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:114 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:114
___ ___
### nodeSize ### nodeSize
• `Optional` **nodeSize**: `number` \| `number`[] • `Optional` **nodeSize**: `number` \| `number`[] \| (`nodeData`: `Node`) => `number`
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:125 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:125
___ ___
@ -94,7 +94,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:124 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:124
___ ___
@ -104,7 +104,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:120 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:120
___ ___
@ -114,7 +114,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:115 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:115
___ ___
@ -124,7 +124,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:122 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:122
___ ___
@ -134,7 +134,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:116 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:116
___ ___
@ -144,4 +144,4 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:113 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:113

30
packages/site/docs/apis/interfaces/layout/CircularLayoutOptions.zh.md
View File

@ -14,7 +14,7 @@ title: CircularLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:121 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:121
___ ___
@ -24,7 +24,7 @@ title: CircularLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:112 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:112
___ ___
@ -34,7 +34,7 @@ title: CircularLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:118 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:118
___ ___
@ -44,7 +44,7 @@ title: CircularLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:119 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:119
___ ___
@ -54,7 +54,7 @@ title: CircularLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:123 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:123
___ ___
@ -64,7 +64,7 @@ title: CircularLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:117 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:117
___ ___
@ -74,17 +74,17 @@ title: CircularLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:114 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:114
___ ___
### 节点大小 ### 节点大小
• `可选` **nodeSize**: `number` \| `数字`[] • `可选` **nodeSize**: `number` \| `数字`[] \| (`nodeData`: `Node`) => `数字`
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:125 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:125
___ ___
@ -94,7 +94,7 @@ title: CircularLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:124 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:124
___ ___
@ -104,7 +104,7 @@ title: CircularLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:120 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:120
___ ___
@ -114,7 +114,7 @@ title: CircularLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:115 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:115
___ ___
@ -124,7 +124,7 @@ title: CircularLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:122 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:122
___ ___
@ -134,7 +134,7 @@ title: CircularLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:116 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:116
___ ___
@ -144,4 +144,4 @@ title: CircularLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:113 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:113

14
packages/site/docs/apis/interfaces/layout/ComboCombinedLayoutOptions.en.md
View File

@ -14,7 +14,7 @@ title: ComboCombinedLayoutOptions
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:242 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:242
___ ___
@ -24,7 +24,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:247 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:247
___ ___
@ -34,7 +34,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:246 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:246
___ ___
@ -44,7 +44,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:243 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:243
___ ___
@ -54,7 +54,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:245 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:245
___ ___
@ -64,7 +64,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:244 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:244
___ ___
@ -74,4 +74,4 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:248 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:248

14
packages/site/docs/apis/interfaces/layout/ComboCombinedLayoutOptions.zh.md
View File

@ -14,7 +14,7 @@ title: ComboCombinedLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:242 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:242
___ ___
@ -24,7 +24,7 @@ title: ComboCombinedLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:247 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:247
___ ___
@ -34,7 +34,7 @@ title: ComboCombinedLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:246 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:246
___ ___
@ -44,7 +44,7 @@ title: ComboCombinedLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:243 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:243
___ ___
@ -54,7 +54,7 @@ title: ComboCombinedLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:245 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:245
___ ___
@ -64,7 +64,7 @@ title: ComboCombinedLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:244 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:244
___ ___
@ -74,4 +74,4 @@ title: ComboCombinedLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:248 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:248

26
packages/site/docs/apis/interfaces/layout/ConcentricLayoutOptions.en.md
View File

@ -14,7 +14,7 @@ title: ConcentricLayoutOptions
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:154 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:154
___ ___
@ -24,7 +24,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:160 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:160
___ ___
@ -34,7 +34,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:158 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:158
___ ___
@ -44,7 +44,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:164 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:164
___ ___
@ -54,17 +54,17 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:161 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:161
___ ___
### nodeSize ### nodeSize
• `Optional` **nodeSize**: `number` \| `PointTuple` • `Optional` **nodeSize**: `number` \| `PointTuple` \| (`nodeData`: `Node`) => `number`
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:156 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:156
___ ___
@ -74,7 +74,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:165 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:165
___ ___
@ -84,7 +84,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:155 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:155
___ ___
@ -94,7 +94,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:162 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:162
___ ___
@ -104,7 +104,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:159 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:159
___ ___
@ -114,7 +114,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:157 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:157
___ ___
@ -124,4 +124,4 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:163 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:163

26
packages/site/docs/apis/interfaces/layout/ConcentricLayoutOptions.zh.md
View File

@ -14,7 +14,7 @@ title: ConcentricLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:154 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:154
___ ___
@ -24,7 +24,7 @@ title: ConcentricLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:160 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:160
___ ___
@ -34,7 +34,7 @@ title: ConcentricLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:158 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:158
___ ___
@ -44,7 +44,7 @@ title: ConcentricLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:164 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:164
___ ___
@ -54,17 +54,17 @@ title: ConcentricLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:161 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:161
___ ___
### 节点大小 ### 节点大小
• `可选` **nodeSize**: `number` \| `点元组` • `可选` **nodeSize**: `number` \| `点元组` \| (`nodeData`: `Node`) => `数字`
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:156 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:156
___ ___
@ -74,7 +74,7 @@ title: ConcentricLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:165 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:165
___ ___
@ -84,7 +84,7 @@ title: ConcentricLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:155 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:155
___ ___
@ -94,7 +94,7 @@ title: ConcentricLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:162 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:162
___ ___
@ -104,7 +104,7 @@ title: ConcentricLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:159 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:159
___ ___
@ -114,7 +114,7 @@ title: ConcentricLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:157 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:157
___ ___
@ -124,4 +124,4 @@ title: ConcentricLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:163 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:163

38
packages/site/docs/apis/interfaces/layout/D3ForceLayoutOptions.en.md
View File

@ -14,7 +14,7 @@ title: D3ForceLayoutOptions
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:214 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:214
___ ___
@ -24,7 +24,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:215 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:215
___ ___
@ -34,7 +34,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:216 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:216
___ ___
@ -44,7 +44,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:206 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:206
___ ___
@ -54,7 +54,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:220 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:220
___ ___
@ -64,7 +64,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:219 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:219
___ ___
@ -74,7 +74,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:222 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:222
___ ___
@ -84,7 +84,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:221 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:221
___ ___
@ -94,7 +94,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:218 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:218
___ ___
@ -104,7 +104,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:217 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:217
___ ___
@ -114,7 +114,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:211 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:211
___ ___
@ -124,7 +124,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:208 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:208
___ ___
@ -134,7 +134,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:223 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:223
___ ___
@ -144,7 +144,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:207 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:207
___ ___
@ -154,7 +154,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:212 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:212
___ ___
@ -164,7 +164,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:213 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:213
___ ___
@ -174,7 +174,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:209 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:209
___ ___
@ -198,7 +198,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:224 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:224
___ ___
@ -208,4 +208,4 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:210 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:210

38
packages/site/docs/apis/interfaces/layout/D3ForceLayoutOptions.zh.md
View File

@ -14,7 +14,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:214 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:214
___ ___
@ -24,7 +24,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:215 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:215
___ ___
@ -34,7 +34,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:216 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:216
___ ___
@ -44,7 +44,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:206 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:206
___ ___
@ -54,7 +54,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:220 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:220
___ ___
@ -64,7 +64,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:219 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:219
___ ___
@ -74,7 +74,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:222 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:222
___ ___
@ -84,7 +84,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:221 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:221
___ ___
@ -94,7 +94,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:218 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:218
___ ___
@ -104,7 +104,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:217 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:217
___ ___
@ -114,7 +114,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:211 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:211
___ ___
@ -124,7 +124,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:208 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:208
___ ___
@ -134,7 +134,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:223 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:223
___ ___
@ -144,7 +144,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:207 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:207
___ ___
@ -154,7 +154,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:212 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:212
___ ___
@ -164,7 +164,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:213 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:213
___ ___
@ -174,7 +174,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:209 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:209
___ ___
@ -198,7 +198,7 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:224 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:224
___ ___
@ -208,4 +208,4 @@ title: D3ForceLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:210 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:210

32
packages/site/docs/apis/interfaces/layout/DagreLayoutOptions.en.md
View File

@ -14,7 +14,7 @@ title: DagreLayoutOptions
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:187 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:187
___ ___
@ -24,7 +24,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:188 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:188
___ ___
@ -34,7 +34,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:192 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:192
___ ___
@ -44,7 +44,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:194 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:194
___ ___
@ -54,7 +54,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:197 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:197
___ ___
@ -64,17 +64,17 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:195 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:195
___ ___
### nodeSize ### nodeSize
• `Optional` **nodeSize**: `number` \| `number`[] • `Optional` **nodeSize**: `number` \| `number`[] \| (`nodeData`: `Node`) => `number`
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:189 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:189
___ ___
@ -84,7 +84,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:190 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:190
___ ___
@ -108,7 +108,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:202 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:202
___ ___
@ -125,7 +125,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:198 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:198
___ ___
@ -135,7 +135,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:196 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:196
___ ___
@ -145,7 +145,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:186 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:186
___ ___
@ -155,7 +155,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:191 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:191
___ ___
@ -179,7 +179,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:203 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:203
___ ___
@ -189,4 +189,4 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:193 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:193

32
packages/site/docs/apis/interfaces/layout/DagreLayoutOptions.zh.md
View File

@ -14,7 +14,7 @@ title: DagreLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:187 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:187
___ ___
@ -24,7 +24,7 @@ title: DagreLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:188 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:188
___ ___
@ -34,7 +34,7 @@ title: DagreLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:192 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:192
___ ___
@ -44,7 +44,7 @@ title: DagreLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:194 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:194
___ ___
@ -54,7 +54,7 @@ title: DagreLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:197 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:197
___ ___
@ -64,17 +64,17 @@ title: DagreLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:195 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:195
___ ___
### 节点大小 ### 节点大小
• `可选` **nodeSize**: `number` \| `数字`[] • `可选` **nodeSize**: `number` \| `数字`[] \| (`nodeData`: `Node`) => `数字`
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:189 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:189
___ ___
@ -84,7 +84,7 @@ title: DagreLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:190 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:190
___ ___
@ -108,7 +108,7 @@ title: DagreLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:202 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:202
___ ___
@ -125,7 +125,7 @@ title: DagreLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:198 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:198
___ ___
@ -135,7 +135,7 @@ title: DagreLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:196 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:196
___ ___
@ -145,7 +145,7 @@ title: DagreLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:186 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:186
___ ___
@ -155,7 +155,7 @@ title: DagreLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:191 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:191
___ ___
@ -179,7 +179,7 @@ title: DagreLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:203 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:203
___ ___
@ -189,4 +189,4 @@ title: DagreLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:193 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:193

42
packages/site/docs/apis/interfaces/layout/ForceAtlas2LayoutOptions.en.md
View File

@ -20,7 +20,7 @@ title: ForceAtlas2LayoutOptions
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:305 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:305
___ ___
@ -34,7 +34,7 @@ CommonForceLayoutOptions.center
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:252 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:252
___ ___
@ -48,7 +48,7 @@ CommonForceLayoutOptions.dimensions
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:251 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:251
___ ___
@ -58,13 +58,13 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:304 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:304
___ ___
### distanceThresholdMode ### distanceThresholdMode
• `Optional` **distanceThresholdMode**: ``"max"`` \| ``"min"`` \| ``"mean"`` • `Optional` **distanceThresholdMode**: ``"min"`` \| ``"max"`` \| ``"mean"``
#### Inherited from #### Inherited from
@ -72,7 +72,7 @@ CommonForceLayoutOptions.distanceThresholdMode
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:255 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:255
___ ___
@ -82,7 +82,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:296 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:296
___ ___
@ -92,7 +92,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:298 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:298
___ ___
@ -102,7 +102,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:297 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:297
___ ___
@ -112,7 +112,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:299 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:299
___ ___
@ -122,7 +122,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:300 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:300
___ ___
@ -140,7 +140,7 @@ CommonForceLayoutOptions.maxDistance
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:261 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:261
___ ___
@ -154,7 +154,7 @@ CommonForceLayoutOptions.maxIteration
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:254 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:254
___ ___
@ -168,7 +168,7 @@ CommonForceLayoutOptions.minMovement
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:253 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:253
___ ___
@ -178,7 +178,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:302 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:302
___ ___
@ -188,7 +188,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:307 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:307
___ ___
@ -212,7 +212,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:308 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:308
___ ___
@ -222,7 +222,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:303 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:303
___ ___
@ -232,7 +232,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:306 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:306
___ ___
@ -242,7 +242,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:301 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:301
___ ___
@ -252,4 +252,4 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:295 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:295

42
packages/site/docs/apis/interfaces/layout/ForceAtlas2LayoutOptions.zh.md
View File

@ -20,7 +20,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:305 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:305
___ ___
@ -34,7 +34,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:252 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:252
___ ___
@ -48,7 +48,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:251 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:251
___ ___
@ -58,13 +58,13 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:304 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:304
___ ___
### 距离阈值模式 ### 距离阈值模式
• `可选` **distanceThresholdMode**：``"max"`` \| ``“分钟”`` \| ``“意思”`` • `可选` **distanceThresholdMode**：``"min"`` \| ``“最大”`` \| ``“意思”``
####继承自 ####继承自
@ -72,7 +72,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:255 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:255
___ ___
@ -82,7 +82,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:296 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:296
___ ___
@ -92,7 +92,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:298 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:298
___ ___
@ -102,7 +102,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:297 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:297
___ ___
@ -112,7 +112,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:299 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:299
___ ___
@ -122,7 +122,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:300 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:300
___ ___
@ -140,7 +140,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:261 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:261
___ ___
@ -154,7 +154,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:254 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:254
___ ___
@ -168,7 +168,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:253 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:253
___ ___
@ -178,7 +178,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:302 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:302
___ ___
@ -188,7 +188,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:307 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:307
___ ___
@ -212,7 +212,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:308 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:308
___ ___
@ -222,7 +222,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:303 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:303
___ ___
@ -232,7 +232,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:306 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:306
___ ___
@ -242,7 +242,7 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:301 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:301
___ ___
@ -252,4 +252,4 @@ title: ForceAtlas2LayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:295 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:295

62
packages/site/docs/apis/interfaces/layout/ForceLayoutOptions.en.md
View File

@ -24,7 +24,7 @@ CommonForceLayoutOptions.center
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:252 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:252
___ ___
@ -34,7 +34,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:278 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:278
___ ___
@ -44,7 +44,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:282 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:282
___ ___
@ -54,7 +54,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:280 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:280
___ ___
@ -64,7 +64,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:283 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:283
___ ___
@ -74,7 +74,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:274 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:274
___ ___
@ -84,7 +84,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:272 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:272
___ ___
@ -98,13 +98,13 @@ CommonForceLayoutOptions.dimensions
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:251 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:251
___ ___
### distanceThresholdMode ### distanceThresholdMode
• `Optional` **distanceThresholdMode**: ``"max"`` \| ``"min"`` \| ``"mean"`` • `Optional` **distanceThresholdMode**: ``"min"`` \| ``"max"`` \| ``"mean"``
#### Inherited from #### Inherited from
@ -112,7 +112,7 @@ CommonForceLayoutOptions.distanceThresholdMode
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:255 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:255
___ ___
@ -122,7 +122,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:268 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:268
___ ___
@ -132,7 +132,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:276 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:276
___ ___
@ -157,7 +157,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:286 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:286
___ ___
@ -181,7 +181,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:285 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:285
___ ___
@ -191,7 +191,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:275 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:275
___ ___
@ -201,7 +201,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:265 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:265
___ ___
@ -211,7 +211,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:277 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:277
___ ___
@ -221,7 +221,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:279 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:279
___ ___
@ -231,7 +231,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:266 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:266
___ ___
@ -249,7 +249,7 @@ CommonForceLayoutOptions.maxDistance
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:261 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:261
___ ___
@ -263,7 +263,7 @@ CommonForceLayoutOptions.maxIteration
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:254 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:254
___ ___
@ -273,7 +273,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:273 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:273
___ ___
@ -287,7 +287,7 @@ CommonForceLayoutOptions.minMovement
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:253 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:253
___ ___
@ -315,7 +315,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:287 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:287
___ ___
@ -325,7 +325,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:281 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:281
___ ___
@ -335,7 +335,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:270 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:270
___ ___
@ -345,7 +345,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:271 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:271
___ ___
@ -355,7 +355,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:267 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:267
___ ___
@ -379,7 +379,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:284 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:284
___ ___
@ -389,7 +389,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:269 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:269
___ ___
@ -399,4 +399,4 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:264 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:264

30
packages/site/docs/apis/interfaces/layout/FruchtermanLayoutOptions.en.md
View File

@ -24,7 +24,7 @@ CommonForceLayoutOptions.center
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:252 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:252
___ ___
@ -34,7 +34,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:316 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:316
___ ___
@ -44,7 +44,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:315 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:315
___ ___
@ -58,13 +58,13 @@ CommonForceLayoutOptions.dimensions
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:251 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:251
___ ___
### distanceThresholdMode ### distanceThresholdMode
• `Optional` **distanceThresholdMode**: ``"max"`` \| ``"min"`` \| ``"mean"`` • `Optional` **distanceThresholdMode**: ``"min"`` \| ``"max"`` \| ``"mean"``
#### Inherited from #### Inherited from
@ -72,7 +72,7 @@ CommonForceLayoutOptions.distanceThresholdMode
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:255 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:255
___ ___
@ -82,7 +82,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:313 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:313
___ ___
@ -92,7 +92,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:312 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:312
___ ___
@ -110,7 +110,7 @@ CommonForceLayoutOptions.maxDistance
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:261 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:261
___ ___
@ -124,7 +124,7 @@ CommonForceLayoutOptions.maxIteration
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:254 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:254
___ ___
@ -138,7 +138,7 @@ CommonForceLayoutOptions.minMovement
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:253 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:253
___ ___
@ -148,7 +148,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:317 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:317
___ ___
@ -172,7 +172,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:318 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:318
___ ___
@ -182,7 +182,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:314 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:314
___ ___
@ -192,4 +192,4 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:311 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:311

30
packages/site/docs/apis/interfaces/layout/FruchtermanLayoutOptions.zh.md
View File

@ -24,7 +24,7 @@ title: FruchtermanLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:252 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:252
___ ___
@ -34,7 +34,7 @@ title: FruchtermanLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:316 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:316
___ ___
@ -44,7 +44,7 @@ title: FruchtermanLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:315 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:315
___ ___
@ -58,13 +58,13 @@ title: FruchtermanLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:251 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:251
___ ___
### 距离阈值模式 ### 距离阈值模式
• `可选` **distanceThresholdMode**：``"max"`` \| ``“分钟”`` \| ``“意思”`` • `可选` **distanceThresholdMode**：``"min"`` \| ``“最大”`` \| ``“意思”``
####继承自 ####继承自
@ -72,7 +72,7 @@ title: FruchtermanLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:255 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:255
___ ___
@ -82,7 +82,7 @@ title: FruchtermanLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:313 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:313
___ ___
@ -92,7 +92,7 @@ title: FruchtermanLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:312 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:312
___ ___
@ -110,7 +110,7 @@ title: FruchtermanLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:261 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:261
___ ___
@ -124,7 +124,7 @@ title: FruchtermanLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:254 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:254
___ ___
@ -138,7 +138,7 @@ title: FruchtermanLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:253 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:253
___ ___
@ -148,7 +148,7 @@ title: FruchtermanLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:317 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:317
___ ___
@ -172,7 +172,7 @@ title: FruchtermanLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:318 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:318
___ ___
@ -182,7 +182,7 @@ title: FruchtermanLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:314 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:314
___ ___
@ -192,4 +192,4 @@ title: FruchtermanLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:311 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:311

26
packages/site/docs/apis/interfaces/layout/GridLayoutOptions.en.md
View File

@ -14,7 +14,7 @@ title: GridLayoutOptions
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:130 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:130
___ ___
@ -24,7 +24,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:136 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:136
___ ___
@ -34,7 +34,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:134 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:134
___ ___
@ -44,17 +44,17 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:129 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:129
___ ___
### nodeSize ### nodeSize
• `Optional` **nodeSize**: `number` \| `number`[] • `Optional` **nodeSize**: `number` \| `number`[] \| (`nodeData`: `Node`) => `number`
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:132 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:132
___ ___
@ -64,7 +64,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:142 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:142
___ ___
@ -93,7 +93,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:138 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:138
___ ___
@ -103,7 +103,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:131 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:131
___ ___
@ -113,7 +113,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:133 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:133
___ ___
@ -123,7 +123,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:135 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:135
___ ___
@ -133,7 +133,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:137 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:137
___ ___
@ -143,4 +143,4 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:128 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:128

26
packages/site/docs/apis/interfaces/layout/GridLayoutOptions.zh.md
View File

@ -14,7 +14,7 @@ title: GridLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:130 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:130
___ ___
@ -24,7 +24,7 @@ title: GridLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:136 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:136
___ ___
@ -34,7 +34,7 @@ title: GridLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:134 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:134
___ ___
@ -44,17 +44,17 @@ title: GridLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:129 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:129
___ ___
### 节点大小 ### 节点大小
• `可选` **nodeSize**: `number` \| `数字`[] • `可选` **nodeSize**: `number` \| `数字`[] \| (`nodeData`: `Node`) => `数字`
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:132 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:132
___ ___
@ -64,7 +64,7 @@ title: GridLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:142 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:142
___ ___
@ -93,7 +93,7 @@ title: GridLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:138 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:138
___ ___
@ -103,7 +103,7 @@ title: GridLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:131 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:131
___ ___
@ -113,7 +113,7 @@ title: GridLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:133 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:133
___ ___
@ -123,7 +123,7 @@ title: GridLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:135 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:135
___ ___
@ -133,7 +133,7 @@ title: GridLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:137 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:137
___ ___
@ -143,4 +143,4 @@ title: GridLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:128 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:128

4
packages/site/docs/apis/interfaces/layout/MDSLayoutOptions.en.md
View File

@ -14,7 +14,7 @@ title: MDSLayoutOptions
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:150 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:150
___ ___
@ -24,4 +24,4 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:151 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:151

4
packages/site/docs/apis/interfaces/layout/MDSLayoutOptions.zh.md
View File

@ -14,7 +14,7 @@ title: MDSLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:150 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:150
___ ___
@ -24,4 +24,4 @@ title: MDSLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:151 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:151

30
packages/site/docs/apis/interfaces/layout/RadialLayoutOptions.en.md
View File

@ -14,7 +14,7 @@ title: RadialLayoutOptions
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:168 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:168
___ ___
@ -24,7 +24,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:173 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:173
___ ___
@ -34,7 +34,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:170 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:170
___ ___
@ -44,7 +44,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:171 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:171
___ ___
@ -54,7 +54,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:172 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:172
___ ___
@ -64,17 +64,17 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:178 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:178
___ ___
### nodeSize ### nodeSize
• `Optional` **nodeSize**: `number` \| `number`[] • `Optional` **nodeSize**: `number` \| `number`[] \| (`nodeData`: `Node`) => `number`
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:176 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:176
___ ___
@ -84,7 +84,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:177 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:177
___ ___
@ -94,7 +94,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:175 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:175
___ ___
@ -104,7 +104,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:180 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:180
___ ___
@ -114,7 +114,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:181 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:181
___ ___
@ -124,7 +124,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:179 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:179
___ ___
@ -134,7 +134,7 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:174 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:174
___ ___
@ -144,4 +144,4 @@ ___
#### Defined in #### Defined in
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:169 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:169

30
packages/site/docs/apis/interfaces/layout/RadialLayoutOptions.zh.md
View File

@ -14,7 +14,7 @@ title: RadialLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:168 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:168
___ ___
@ -24,7 +24,7 @@ title: RadialLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:173 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:173
___ ___
@ -34,7 +34,7 @@ title: RadialLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:170 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:170
___ ___
@ -44,7 +44,7 @@ title: RadialLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:171 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:171
___ ___
@ -54,7 +54,7 @@ title: RadialLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:172 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:172
___ ___
@ -64,17 +64,17 @@ title: RadialLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:178 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:178
___ ___
### 节点大小 ### 节点大小
• `可选` **nodeSize**: `number` \| `数字`[] • `可选` **nodeSize**: `number` \| `数字`[] \| (`nodeData`: `Node`) => `数字`
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:176 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:176
___ ___
@ -84,7 +84,7 @@ title: RadialLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:177 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:177
___ ___
@ -94,7 +94,7 @@ title: RadialLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:175 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:175
___ ___
@ -104,7 +104,7 @@ title: RadialLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:180 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:180
___ ___
@ -114,7 +114,7 @@ title: RadialLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:181 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:181
___ ___
@ -124,7 +124,7 @@ title: RadialLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:179 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:179
___ ___
@ -134,7 +134,7 @@ title: RadialLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:174 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:174
___ ___
@ -144,4 +144,4 @@ title: RadialLayoutOptions
#### 定义于 #### 定义于
node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:169 node_modules/.pnpm/@antv+layout@1.2.9_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:169

123
packages/site/docs/apis/interfaces/plugins-LegendConfig.en.md
View File

@ -1,123 +0,0 @@
[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [plugins](../modules/plugins.en.md) / LegendConfig
# Interface: LegendConfig
[plugins](../modules/plugins.en.md).LegendConfig
## Hierarchy
- `IPluginBaseConfig`
↳ **`LegendConfig`**
## Properties
### activeState
• `Optional` **activeState**: `string`
#### Defined in
[stdlib/plugin/legend/index.ts:55](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L55)
___
### className
• `Optional` **className**: `string`
#### Overrides
IPluginBaseConfig.className
#### Defined in
[stdlib/plugin/legend/index.ts:47](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L47)
___
### container
• `Optional` **container**: `HTMLDivElement`
#### Overrides
IPluginBaseConfig.container
#### Defined in
[stdlib/plugin/legend/index.ts:45](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L45)
___
### edge
• `Optional` **edge**: `ItemLegendConfig`
#### Defined in
[stdlib/plugin/legend/index.ts:61](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L61)
___
### graph
• `Optional` **graph**: [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\>
#### Inherited from
IPluginBaseConfig.graph
#### Defined in
[types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7)
___
### inactiveState
• `Optional` **inactiveState**: `string`
#### Defined in
[stdlib/plugin/legend/index.ts:57](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L57)
___
### node
• `Optional` **node**: `ItemLegendConfig`
#### Defined in
[stdlib/plugin/legend/index.ts:59](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L59)
___
### orientation
• `Optional` **orientation**: ``"horizontal"`` \| ``"vertical"``
#### Defined in
[stdlib/plugin/legend/index.ts:51](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L51)
___
### selectedState
• `Optional` **selectedState**: `string`
#### Defined in
[stdlib/plugin/legend/index.ts:53](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L53)
___
### size
• `Optional` **size**: ``"fit-content"`` \| [`string` \| `number`, `string` \| `number`]
#### Defined in
[stdlib/plugin/legend/index.ts:49](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L49)

123
packages/site/docs/apis/interfaces/plugins-LegendConfig.zh.md
View File

@ -1,123 +0,0 @@
[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [插件](../modules/plugins.zh.md ) / LegendConfig
# 接口：LegendConfig
[插件](../modules/plugins.zh.md).LegendConfig
＃＃ 等级制度
- `IPluginBaseConfig`
↳ **`图例配置`**
＃＃ 特性
### 活动状态
• `可选` **activeState**：`字符串`
#### 定义于
[stdlib/plugin/legend/index.ts:55](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L55)
___
＃＃＃ 班级名称
• `可选` **类名**：`字符串`
#### 覆盖
IPluginBaseConfig.className
#### 定义于
[stdlib/plugin/legend/index.ts:47](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L47)
___
＃＃＃ 容器
• `可选` **容器**：`HTMLDivElement`
#### 覆盖
IPluginBaseConfig.container
#### 定义于
[stdlib/plugin/legend/index.ts:45](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L45)
___
＃＃＃ 边缘
• `可选` **边缘**：`ItemLegendConfig`
#### 定义于
[stdlib/plugin/legend/index.ts:61](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L61)
___
### 图表
• `可选` **graph**: [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>
####继承自
IPluginBaseConfig.graph
#### 定义于
[types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7)
___
### 非活动状态
• `可选` **inactiveState**：`字符串`
#### 定义于
[stdlib/plugin/legend/index.ts:57](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L57)
___
### 节点
• `可选` **节点**：`ItemLegendConfig`
#### 定义于
[stdlib/plugin/legend/index.ts:59](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L59)
___
＃＃＃ 方向
• `可选` **方向**：``"水平"`` \| ``“垂直”``
#### 定义于
[stdlib/plugin/legend/index.ts:51](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L51)
___
### 选定状态
• `可选` **selectedState**：`字符串`
#### 定义于
[stdlib/plugin/legend/index.ts:53](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L53)
___
＃＃＃ 尺寸
• `可选` **尺寸**：``"fit-content"`` \| [`字符串`\| `数字`、`字符串` \| `数字`]
#### 定义于
[stdlib/plugin/legend/index.ts:49](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/legend/index.ts#L49)

123
packages/site/docs/apis/interfaces/plugins-MiniMapConfig.en.md
View File

@ -1,123 +0,0 @@
[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [plugins](../modules/plugins.en.md) / MiniMapConfig
# Interface: MiniMapConfig
[plugins](../modules/plugins.en.md).MiniMapConfig
## Hierarchy
- `IPluginBaseConfig`
↳ **`MiniMapConfig`**
## Properties
### className
• `Optional` **className**: `string`
#### Overrides
IPluginBaseConfig.className
#### Defined in
[stdlib/plugin/minimap/index.ts:19](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L19)
___
### container
• `Optional` **container**: `HTMLDivElement`
#### Overrides
IPluginBaseConfig.container
#### Defined in
[stdlib/plugin/minimap/index.ts:26](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L26)
___
### delegateStyle
• `Optional` **delegateStyle**: `Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `animates?`: `IAnimates` ; `lod?`: `number` ; `visible?`: `boolean` }\>
#### Defined in
[stdlib/plugin/minimap/index.ts:22](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L22)
___
### graph
• `Optional` **graph**: [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\>
#### Inherited from
IPluginBaseConfig.graph
#### Defined in
[types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7)
___
### hideEdge
• `Optional` **hideEdge**: `boolean`
#### Defined in
[stdlib/plugin/minimap/index.ts:25](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L25)
___
### mode
• `Optional` **mode**: ``"keyShape"`` \| ``"default"`` \| ``"delegate"``
#### Defined in
[stdlib/plugin/minimap/index.ts:20](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L20)
___
### padding
• `Optional` **padding**: `number`
#### Defined in
[stdlib/plugin/minimap/index.ts:24](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L24)
___
### refresh
• `Optional` **refresh**: `boolean`
#### Defined in
[stdlib/plugin/minimap/index.ts:23](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L23)
___
### size
• `Optional` **size**: `number`[]
#### Defined in
[stdlib/plugin/minimap/index.ts:21](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L21)
___
### viewportClassName
• `Optional` **viewportClassName**: `string`
#### Defined in
[stdlib/plugin/minimap/index.ts:18](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L18)

123
packages/site/docs/apis/interfaces/plugins-MiniMapConfig.zh.md
View File

@ -1,123 +0,0 @@
[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [插件](../modules/plugins.zh.md ) / 小地图配置
# 接口：MiniMapConfig
[插件](../modules/plugins.zh.md).MiniMapConfig
＃＃ 等级制度
- `IPluginBaseConfig`
↳ **`MiniMapConfig`**
＃＃ 特性
＃＃＃ 班级名称
• `可选` **类名**：`字符串`
#### 覆盖
IPluginBaseConfig.className
#### 定义于
[stdlib/plugin/minimap/index.ts:19](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L19)
___
＃＃＃ 容器
• `可选` **容器**：`HTMLDivElement`
#### 覆盖
IPluginBaseConfig.container
#### 定义于
[stdlib/plugin/minimap/index.ts:26](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L26)
___
### 委托样式
• `可选` **delegateStyle**：`Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `动画？`: `IAnimates` ; `lod?`: `数字`; `可见？`: `布尔值` }\>
#### 定义于
[stdlib/plugin/minimap/index.ts:22](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L22)
___
### 图表
• `可选` **graph**: [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>
####继承自
IPluginBaseConfig.graph
#### 定义于
[types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7)
___
### 隐藏边缘
• `可选` **hideEdge**：`布尔值`
#### 定义于
[stdlib/plugin/minimap/index.ts:25](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L25)
___
＃＃＃ 模式
• `可选` **模式**：``"keyShape"`` \| ``“默认”`` \| ``“代表”``
#### 定义于
[stdlib/plugin/minimap/index.ts:20](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L20)
___
### 填充
• `可选` **填充**：`数字`
#### 定义于
[stdlib/plugin/minimap/index.ts:24](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L24)
___
＃＃＃ 刷新
• `可选` **刷新**：`布尔值`
#### 定义于
[stdlib/plugin/minimap/index.ts:23](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L23)
___
＃＃＃ 尺寸
• `可选` **尺寸**：`数量`[]
#### 定义于
[stdlib/plugin/minimap/index.ts:21](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L21)
___
### 视口类名
• `可选` **viewportClassName**：`string`
#### 定义于
[stdlib/plugin/minimap/index.ts:18](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/minimap/index.ts#L18)

134
packages/site/docs/apis/interfaces/plugins-ToolbarConfig.en.md
View File

@ -1,134 +0,0 @@
[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [plugins](../modules/plugins.en.md) / ToolbarConfig
# Interface: ToolbarConfig
[plugins](../modules/plugins.en.md).ToolbarConfig
## Hierarchy
- `IPluginBaseConfig`
↳ **`ToolbarConfig`**
## Properties
### className
• `Optional` **className**: `string`
#### Inherited from
IPluginBaseConfig.className
#### Defined in
[types/plugin.ts:6](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L6)
___
### container
• `Optional` **container**: `string` \| `HTMLDivElement`
#### Inherited from
IPluginBaseConfig.container
#### Defined in
[types/plugin.ts:5](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L5)
___
### getContent
• **getContent**: (`graph?`: [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\>) => `string` \| `HTMLDivElement`
#### Type declaration
▸ (`graph?`): `string` \| `HTMLDivElement`
##### Parameters
| Name | Type |
| :------ | :------ |
| `graph?` | [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\> |
##### Returns
`string` \| `HTMLDivElement`
#### Defined in
[stdlib/plugin/toolbar/index.ts:14](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L14)
___
### graph
• `Optional` **graph**: [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\>
#### Inherited from
IPluginBaseConfig.graph
#### Defined in
[types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7)
___
### handleClick
• `Optional` **handleClick**: (`code`: `string`, `graph`: [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\>) => `void`
#### Type declaration
▸ (`code`, `graph`): `void`
toolbar config
##### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `code` | `string` | toolbar item code |
| `graph` | [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\> | Graph Instance |
##### Returns
`void`
#### Defined in
[stdlib/plugin/toolbar/index.ts:13](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L13)
___
### maxZoom
• **maxZoom**: `number`
#### Defined in
[stdlib/plugin/toolbar/index.ts:17](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L17)
___
### minZoom
• **minZoom**: `number`
#### Defined in
[stdlib/plugin/toolbar/index.ts:16](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L16)
___
### zoomSensitivity
• **zoomSensitivity**: `number`
#### Defined in
[stdlib/plugin/toolbar/index.ts:15](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L15)

134
packages/site/docs/apis/interfaces/plugins-ToolbarConfig.zh.md
View File

@ -1,134 +0,0 @@
[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [插件](../modules/plugins.zh.md ) / 工具栏配置
# 接口：工具栏配置
[插件](../modules/plugins.zh.md).ToolbarConfig
＃＃ 等级制度
- `IPluginBaseConfig`
↳ **`工具栏配置`**
＃＃ 特性
＃＃＃ 班级名称
• `可选` **类名**：`字符串`
####继承自
IPluginBaseConfig.className
#### 定义于
[types/plugin.ts:6](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L6)
___
＃＃＃ 容器
• `可选` **容器**：`字符串` \| `HTMLDivElement`
####继承自
IPluginBaseConfig.container
#### 定义于
[types/plugin.ts:5](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L5)
___
### 获取内容
• **getContent**: (`graph?`: [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>) => `string` \| `HTMLDivElement`
#### 类型声明
▸ (`图?`): `字符串` \| `HTMLDivElement`
＃＃＃＃＃ 参数
| 名称 | 类型 |
| :------ | :------ |
| `图？` | [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> |
##### 返回
`字符串` \| `HTMLDivElement`
#### 定义于
[stdlib/plugin/toolbar/index.ts:14](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L14)
___
### 图表
• `可选` **graph**: [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>
####继承自
IPluginBaseConfig.graph
#### 定义于
[types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7)
___
### 处理点击
• `可选` **handleClick**: (`code`: `string`, `graph`: [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>) => `无效`
#### 类型声明
▸ (`代码`, `图表`): `void`
工具栏配置
＃＃＃＃＃ 参数
| 名称 | 类型 | 描述 |
| :------ | :------ | :------ |
| `代码` | `字符串` | 工具栏项目代码|
| `图` | [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> | 图实例|
##### 返回
`无效`
#### 定义于
[stdlib/plugin/toolbar/index.ts:13](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L13)
___
### 最大缩放
• **maxZoom**：`数量`
#### 定义于
[stdlib/plugin/toolbar/index.ts:17](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L17)
___
### 最小缩放
• **minZoom**：`数字`
#### 定义于
[stdlib/plugin/toolbar/index.ts:16](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L16)
___
### 缩放灵敏度
• **缩放灵敏度**：`数字`
#### 定义于
[stdlib/plugin/toolbar/index.ts:15](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/toolbar/index.ts#L15)

161
packages/site/docs/apis/interfaces/plugins-TooltipConfig.en.md
View File

@ -1,161 +0,0 @@
[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [plugins](../modules/plugins.en.md) / TooltipConfig
# Interface: TooltipConfig
[plugins](../modules/plugins.en.md).TooltipConfig
## Hierarchy
- `IPluginBaseConfig`
↳ **`TooltipConfig`**
## Properties
### className
• `Optional` **className**: `string`
#### Inherited from
IPluginBaseConfig.className
#### Defined in
[types/plugin.ts:6](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L6)
___
### container
• `Optional` **container**: `string` \| `HTMLDivElement`
#### Inherited from
IPluginBaseConfig.container
#### Defined in
[types/plugin.ts:5](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L5)
___
### fixToNode
• `Optional` **fixToNode**: [`number`, `number`] \| `Placement`
#### Defined in
[stdlib/plugin/tooltip/index.ts:66](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L66)
___
### getContent
• `Optional` **getContent**: (`evt?`: [`IG6GraphEvent`](types-IG6GraphEvent.en.md)) => `string` \| `HTMLDivElement` \| `Promise`<`string` \| `HTMLDivElement`\>
#### Type declaration
▸ (`evt?`): `string` \| `HTMLDivElement` \| `Promise`<`string` \| `HTMLDivElement`\>
##### Parameters
| Name | Type |
| :------ | :------ |
| `evt?` | [`IG6GraphEvent`](types-IG6GraphEvent.en.md) |
##### Returns
`string` \| `HTMLDivElement` \| `Promise`<`string` \| `HTMLDivElement`\>
#### Defined in
[stdlib/plugin/tooltip/index.ts:57](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L57)
___
### graph
• `Optional` **graph**: [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\>
#### Inherited from
IPluginBaseConfig.graph
#### Defined in
[types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7)
___
### itemTypes
• `Optional` **itemTypes**: (``"node"`` \| ``"edge"`` \| ``"combo"`` \| ``"canvas"``)[]
#### Defined in
[stdlib/plugin/tooltip/index.ts:64](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L64)
___
### loadingContent
• `Optional` **loadingContent**: `string` \| `HTMLDivElement`
#### Defined in
[stdlib/plugin/tooltip/index.ts:67](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L67)
___
### offsetX
• `Optional` **offsetX**: `number`
#### Defined in
[stdlib/plugin/tooltip/index.ts:60](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L60)
___
### offsetY
• `Optional` **offsetY**: `number`
#### Defined in
[stdlib/plugin/tooltip/index.ts:61](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L61)
___
### shouldBegin
• `Optional` **shouldBegin**: (`evt?`: [`IG6GraphEvent`](types-IG6GraphEvent.en.md)) => `boolean`
#### Type declaration
▸ (`evt?`): `boolean`
##### Parameters
| Name | Type |
| :------ | :------ |
| `evt?` | [`IG6GraphEvent`](types-IG6GraphEvent.en.md) |
##### Returns
`boolean`
#### Defined in
[stdlib/plugin/tooltip/index.ts:62](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L62)
___
### trigger
• `Optional` **trigger**: ``"click"`` \| ``"pointerenter"``
#### Defined in
[stdlib/plugin/tooltip/index.ts:65](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L65)

161
packages/site/docs/apis/interfaces/plugins-TooltipConfig.zh.md
View File

@ -1,161 +0,0 @@
[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [插件](../modules/plugins.zh.md ) / 工具提示配置
# 接口：TooltipConfig
[插件](../modules/plugins.zh.md).TooltipConfig
＃＃ 等级制度
- `IPluginBaseConfig`
↳ **`工具提示配置`**
＃＃ 特性
＃＃＃ 班级名称
• `可选` **类名**：`字符串`
####继承自
IPluginBaseConfig.className
#### 定义于
[types/plugin.ts:6](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L6)
___
＃＃＃ 容器
• `可选` **容器**：`字符串` \| `HTMLDivElement`
####继承自
IPluginBaseConfig.container
#### 定义于
[types/plugin.ts:5](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L5)
___
### 修复到节点
• `可选` **fixToNode**: [`number`, `number`] \| `放置`
#### 定义于
[stdlib/plugin/tooltip/index.ts:66](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L66)
___
### 获取内容
• `可选` **getContent**: (`evt?`: [`IG6GraphEvent`](types-IG6GraphEvent.zh.md)) => `string` \| `HTMLDivElement` \| `Promise`<`字符串` \| `HTMLDivElement`\>
#### 类型声明
▸ (`evt?`): `字符串` \| `HTMLDivElement` \| `Promise`<`字符串` \| `HTMLDivElement`\>
＃＃＃＃＃ 参数
| 名称 | 类型 |
| :------ | :------ |
| `事件？` | [`IG6GraphEvent`](types-IG6GraphEvent.zh.md) |
##### 返回
`字符串` \| `HTMLDivElement` \| `Promise`<`字符串` \| `HTMLDivElement`\>
#### 定义于
[stdlib/plugin/tooltip/index.ts:57](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L57)
___
### 图表
• `可选` **graph**: [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>
####继承自
IPluginBaseConfig.graph
#### 定义于
[types/plugin.ts:7](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/plugin.ts#L7)
___
### 项目类型
• `可选` **itemTypes**: (``"node"`` \| ``"edge"`` \| ``"combo"`` \| ``"canvas"``)[]
#### 定义于
[stdlib/plugin/tooltip/index.ts:64](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L64)
___
### 加载内容
• `可选` **loadingContent**：`字符串` \| `HTMLDivElement`
#### 定义于
[stdlib/plugin/tooltip/index.ts:67](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L67)
___
### 偏移X
• `可选` **offsetX**：`数字`
#### 定义于
[stdlib/plugin/tooltip/index.ts:60](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L60)
___
### 偏移Y
• `可选` **offsetY**：`数字`
#### 定义于
[stdlib/plugin/tooltip/index.ts:61](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L61)
___
### 应该开始
• `可选` **shouldBegin**: (`evt?`: [`IG6GraphEvent`](types-IG6GraphEvent.zh.md)) => `boolean`
#### 类型声明
▸ (`evt?`): `布尔值`
＃＃＃＃＃ 参数
| 名称 | 类型 |
| :------ | :------ |
| `事件？` | [`IG6GraphEvent`](types-IG6GraphEvent.zh.md) |
##### 返回
`布尔值`
#### 定义于
[stdlib/plugin/tooltip/index.ts:62](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L62)
___
＃＃＃ 扳机
• `可选` **触发**：``"点击"`` \| ``“指针输入器”``
#### 定义于
[stdlib/plugin/tooltip/index.ts:65](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/stdlib/plugin/tooltip/index.ts#L65)

122
packages/site/docs/apis/interfaces/plugins/FisheyeConfig.en.md
View File

@ -6,6 +6,22 @@ title: FisheyeConfig
[plugins](../../modules/plugins.en.md).FisheyeConfig [plugins](../../modules/plugins.en.md).FisheyeConfig
This is an interface named `FisheyeConfig`, which extends the `IPluginBaseConfig` interface. It contains the following properties:
- `trigger`: The trigger method, which can be `'mousemove'`, `'click'`, or `'drag'`.
- `d`: A number representing the magnification factor of the fisheye.
- `r`: A number representing the radius of the fisheye.
- `delegateStyle`: The shape style.
- `showLabel`: A boolean indicating whether to show the label.
- `scaleRBy`: Can be `'wheel'`, `'drag'`, `'unset'`, or `undefined`, representing the scaling method for the fisheye radius.
- `scaleDBy`: Can be `'wheel'`, `'drag'`, `'unset'`, or `undefined`, representing the scaling method for the fisheye magnification factor.
- `maxR`: A number representing the maximum value of the fisheye radius.
- `minR`: A number representing the minimum value of the fisheye radius.
- `maxD`: A number representing the maximum value of the fisheye magnification factor.
- `minD`: A number representing the minimum value of the fisheye magnification factor.
- `throttle`: A number representing the throttle time (in milliseconds).
- `showDPercent`: A boolean indicating whether to show the percentage of the fisheye magnification factor.
## Hierarchy ## Hierarchy
- `IPluginBaseConfig` - `IPluginBaseConfig`
@ -24,9 +40,9 @@ IPluginBaseConfig.className
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L6) [packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L6)
___ ---
### container ### container
@ -38,29 +54,43 @@ IPluginBaseConfig.container
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L5) [packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L5)
___ ---
### d ### d
• `Optional` **d**: `number` • `Optional` **d**: `number`
A number representing the magnification factor of the fisheye.
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/fisheye/index.ts:13](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.ts#L13) [packages/g6/src/stdlib/plugin/fisheye/index.ts:30](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L30)
___ ---
### delegateStyle ### delegateStyle
• `Optional` **delegateStyle**: `Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `animates?`: `IAnimates` ; `lod?`: `number` ; `visible?`: `boolean` }\> • `Optional` **delegateStyle**: `Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `animates?`: `IAnimates` ; `lod?`: `number` ; `visible?`: `boolean` }\>
The shape style
**`Default`**
`{
stroke: '#000',
strokeOpacity: 0.8,
lineWidth: 2,
fillOpacity: 0.1,
fill: '#ccc'
}`
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/fisheye/index.ts:15](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.ts#L15) [packages/g6/src/stdlib/plugin/fisheye/index.ts:47](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L47)
___ ---
### graph ### graph
@ -72,114 +102,136 @@ IPluginBaseConfig.graph
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L7)
___ ---
### maxD ### maxD
• `Optional` **maxD**: `number` • `Optional` **maxD**: `number`
A number representing the maximum value of the fisheye magnification factor.
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/fisheye/index.ts:21](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.ts#L21) [packages/g6/src/stdlib/plugin/fisheye/index.ts:59](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L59)
___ ---
### maxR ### maxR
• `Optional` **maxR**: `number` • `Optional` **maxR**: `number`
A number representing the maximum value of the fisheye radius.
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/fisheye/index.ts:19](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.ts#L19) [packages/g6/src/stdlib/plugin/fisheye/index.ts:55](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L55)
___ ---
### minD ### minD
• `Optional` **minD**: `number` • `Optional` **minD**: `number`
A number representing the minimum value of the fisheye magnification factor.
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/fisheye/index.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.ts#L22) [packages/g6/src/stdlib/plugin/fisheye/index.ts:61](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L61)
___ ---
### minR ### minR
• `Optional` **minR**: `number` • `Optional` **minR**: `number`
A number representing the minimum value of the fisheye radius.
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/fisheye/index.ts:20](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.ts#L20) [packages/g6/src/stdlib/plugin/fisheye/index.ts:57](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L57)
___ ---
### r ### r
• `Optional` **r**: `number` • `Optional` **r**: `number`
A number representing the radius of the fisheye.
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/fisheye/index.ts:14](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.ts#L14) [packages/g6/src/stdlib/plugin/fisheye/index.ts:32](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L32)
___ ---
### scaleDBy ### scaleDBy
• `Optional` **scaleDBy**: ``"unset"`` \| ``"drag"`` \| ``"wheel"`` • `Optional` **scaleDBy**: `"unset"` \| `"drag"` \| `"wheel"`
Can be `'wheel'`, `'drag'`, `'unset'`, or `undefined`, representing the scaling method for the fisheye magnification factor.
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/fisheye/index.ts:18](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.ts#L18) [packages/g6/src/stdlib/plugin/fisheye/index.ts:53](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L53)
___ ---
### scaleRBy ### scaleRBy
• `Optional` **scaleRBy**: ``"unset"`` \| ``"drag"`` \| ``"wheel"`` • `Optional` **scaleRBy**: `"unset"` \| `"drag"` \| `"wheel"`
Can be `'wheel'`, `'drag'`, `'unset'`, or `undefined`, representing the scaling method for the fisheye radius.
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/fisheye/index.ts:17](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.ts#L17) [packages/g6/src/stdlib/plugin/fisheye/index.ts:51](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L51)
___ ---
### showDPercent ### showDPercent
• `Optional` **showDPercent**: `boolean` • `Optional` **showDPercent**: `boolean`
A boolean indicating whether to show the percentage of the fisheye magnification factor.
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/fisheye/index.ts:24](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.ts#L24) [packages/g6/src/stdlib/plugin/fisheye/index.ts:65](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L65)
___ ---
### showLabel ### showLabel
• `Optional` **showLabel**: `boolean` • `Optional` **showLabel**: `boolean`
A boolean indicating whether to show the label.
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/fisheye/index.ts:16](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.ts#L16) [packages/g6/src/stdlib/plugin/fisheye/index.ts:49](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L49)
___ ---
### throttle ### throttle
• `Optional` **throttle**: `number` • `Optional` **throttle**: `number`
A number representing the throttle time (in milliseconds).
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/fisheye/index.ts:23](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.ts#L23) [packages/g6/src/stdlib/plugin/fisheye/index.ts:63](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L63)
___ ---
### trigger ### trigger
• `Optional` **trigger**: ``"click"`` \| ``"drag"`` \| ``"mousemove"`` • `Optional` **trigger**: `"click"` \| `"drag"` \| `"mousemove"`
The trigger method, which can be `'mousemove'`, `'click'`, or `'drag'`.
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/fisheye/index.ts:12](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.ts#L12) [packages/g6/src/stdlib/plugin/fisheye/index.ts:28](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L28)

230
packages/site/docs/apis/interfaces/plugins/FisheyeConfig.zh.md
View File

@ -2,184 +2,232 @@
title: FisheyeConfig title: FisheyeConfig
--- ---
[概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../. ./modules/plugins.zh.md) / FisheyeConfig [概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../../modules/plugins.zh.md) / FisheyeConfig
[插件](../../modules/plugins.zh.md).FisheyeConfig [插件](../../modules/plugins.zh.md).FisheyeConfig
＃＃ 等级制度 这是一个名为`FisheyeConfig`的接口，它扩展了`IPluginBaseConfig`接口。它包含以下属性：
- `IPluginBaseConfig` - `trigger`：触发方法，可以是`'mousemove'`、`'click'`或`'drag'`。
- `d`：表示鱼眼放大倍数的数字。
- `r`：表示鱼眼半径的数字。
- `delegateStyle`：形状样式。
- `showLabel`：一个布尔值，表示是否显示标签。
- `scaleRBy`：可以是`'wheel'`、`'drag'`、`'unset'`或`undefined`，表示鱼眼半径的缩放方法。
- `scaleDBy`：可以是`'wheel'`、`'drag'`、`'unset'`或`undefined`，表示鱼眼放大倍数的缩放方法。
- `maxR`：表示鱼眼半径最大值的数字。
- `minR`：表示鱼眼半径最小值的数字。
- `maxD`：表示鱼眼放大倍数最大值的数字。
- `minD`：表示鱼眼放大倍数最小值的数字。
- `throttle`：表示节流时间（以毫秒为单位）的数字。
- `showDPerczht`: 一个布尔值，表示是否显示鱼眼放大倍数的百分比。
↳ **`FisheyeConfig`** ## 层次结构
＃＃ 特性 - `IPluginBaseConfig`
＃＃＃ 班级名称 ↳ **FisheyeConfig**
• `可选` **类名**：`字符串` ## 属性
####继承自 ### className
IPluginBaseConfig.className • 可选 **className**：字符串
#### 定义于 #### 继承自
[packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L6) IPluginBaseConfig.className
___ #### 定义在
＃＃＃ 容器 [packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L6)
• `可选` **容器**：`字符串` \| `HTMLDivElement` ---
####继承自 ### container
IPluginBaseConfig.container • 可选 **container**：字符串 | HTMLDivElemzht
#### 定义于 #### 继承自
[packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L5) IPluginBaseConfig.container
___ #### 定义在
### d [packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L5)
• `可选` **d**：`数字` ---
#### 定义于 ### d
[packages/g6/src/stdlib/plugin/fisheye/index.ts:13](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.html ts#L13) • 可选 **d**：数字
___ 表示鱼眼放大倍数的数字。
### 委托样式 #### 定义在
• `可选` **delegateStyle**：`Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `动画？`: `IAnimates` ; `lod?`: `数字`; `可见？`: `布尔值` }\> [packages/g6/src/stdlib/plugin/fisheye/index.ts:30](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L30)
#### 定义于 ---
[packages/g6/src/stdlib/plugin/fisheye/index.ts:15](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index. ts#L15) ### delegateStyle
___ • 可选 **delegateStyle**：部分<圆形样式属性 & 矩形样式属性 & 椭圆样式属性 & 多边形样式属性 & 线条样式属性 & 折线样式属性 & 文本样式属性 & 图像样式属性 & 路径样式属性 & 球体几何属性 & 立方体几何属性 & 平面几何属性 & {动画？: IAnimates; lod？: 数字; 可见？: 布尔}\>
### 图表 形状样式。
• `可选` **graph**: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> **默认**
####继承自 `{
stroke: '#000',
strokeOpacity: 0.8,
lineWidth: 2,
fillOpacity: 0.1,
fill: '#ccc'
}`
IPluginBaseConfig.graph #### 定义在
#### 定义于 [packages/g6/src/stdlib/plugin/fisheye/index.ts:47](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L47)
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) ---
___ ### graph
### 最大D • 可选 **graph**：[`IGraph`](../graph/IGraph.zh.md)<行为注册表, 主题注册表\>
• `可选` **maxD**：`数量` #### 继承自
#### 定义于 IPluginBaseConfig.graph
[packages/g6/src/stdlib/plugin/fisheye/index.ts:21](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index. ts#L21) #### 定义在
___ [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L7)
### 最大R ---
• `可选` **maxR**：`数量` ### maxD
#### 定义于 • 可选 **maxD**：数字
[packages/g6/src/stdlib/plugin/fisheye/index.ts:19](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.html ts#L19) 表示鱼眼放大倍数最大值的数字。
___ #### 定义在
＃＃＃ 头脑 [packages/g6/src/stdlib/plugin/fisheye/index.ts:59](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L59)
• `可选` **minD**：`数量` ---
#### 定义于 ### maxR
[packages/g6/src/stdlib/plugin/fisheye/index.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index. ts#L22) • 可选 **maxR**：数字
___ 表示鱼眼半径最大值的数字。
### 最小R #### 定义在
• `可选` **minR**：`数字` [packages/g6/src/stdlib/plugin/fisheye/index.ts:55](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L55)
#### 定义于 ---
[packages/g6/src/stdlib/plugin/fisheye/index.ts:20](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.ts) ts#L20) ### minD
___ • 可选 **minD**：数字
### r 表示鱼眼放大倍数最小值的数字。
• `可选` **r**：`数字` #### 定义在
#### 定义于 [packages/g6/src/stdlib/plugin/fisheye/index.ts:61](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L61)
[packages/g6/src/stdlib/plugin/fisheye/index.ts:14](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.html ts#L14) ---
___ ### minR
### 缩放DBBy • 可选 **minR**：数字
• `可选` **scaleDBy**: ``"unset"`` \| ``“拖动”`` \| ``“轮子”`` 表示鱼眼半径最小值的数字。
#### 定义于 #### 定义在
[packages/g6/src/stdlib/plugin/fisheye/index.ts:18](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.html ts#L18) [packages/g6/src/stdlib/plugin/fisheye/index.ts:57](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L57)
___ ---
### 缩放RBy ### r
• `可选` **scaleRBy**: ``"unset"`` \| ``“拖动”`` \| ``“轮子”`` • 可选 **r**：数字
#### 定义于 表示鱼眼半径的数字。
[packages/g6/src/stdlib/plugin/fisheye/index.ts:17](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index. ts#L17) #### 定义在
___ [packages/g6/src/stdlib/plugin/fisheye/index.ts:32](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L32)
### 显示DPercent ---
• `可选` **showDPercent**：`布尔值` ### scaleDBy
#### 定义于 • 可选 **scaleDBy**：`'drag'` \| `'unset'` \| `'wheel'` \| `undefined`
[packages/g6/src/stdlib/plugin/fisheye/index.ts:24](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.html ts#L24) 可以是`'wheel'`、`'drag'`、`'unset'`或`undefined`，表示鱼眼放大倍数的缩放方法。
___ #### 定义在
### 显示标签 [packages/g6/src/stdlib/plugin/fisheye/index.ts:43](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L43)
• `可选` **showLabel**：`布尔值` ---
#### 定义于 ### scaleRBy
[packages/g6/src/stdlib/plugin/fisheye/index.ts:16](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index.html ts#L16) • 可选 **scaleRBy**：`'drag'` \| `'unset'` \| `'wheel'` \| `undefined`
___ 可以是`'wheel'`、`'drag'`、`'unset'`或`undefined`，表示鱼眼半径的缩放方法。
###油门 #### 定义在
• `可选` **节流阀**：`数量` [packages/g6/src/stdlib/plugin/fisheye/index.ts:39](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L39)
#### 定义于 ---
[packages/g6/src/stdlib/plugin/fisheye/index.ts:23](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index. ts#L23) ### showDPerczht
___ • 可选 **showDPerczht**：布尔值
＃＃＃ 扳机 一个布尔值，表示是否显示鱼眼放大倍数的百分比。
• `可选` **触发**：``"点击"`` \| ``“拖动”`` \| ``“鼠标移动”`` #### 定义在
#### 定义于 [packages/g6/src/stdlib/plugin/fisheye/index.ts:63](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L63)
[packages/g6/src/stdlib/plugin/fisheye/index.ts:12](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/fisheye/index. ts#L12) ---
### showLabel
• 可选 **showLabel**：布尔值
一个布尔值，表示是否显示标签。
#### 定义在
[packages/g6/src/stdlib/plugin/fisheye/index.ts:35](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L35)
---
### throttle
• 可选 **throttle**：数字
表示节流时间（以毫秒为单位）的数字。
#### 定义在
[packages/g6/src/stdlib/plugin/fisheye/index.ts:65](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/fisheye/index.ts#L65)
---
### trigger
• 可选 **trigger**：`'click'` \| `'drag'` \| `'mousemove'`
触发方法，可以是`'mousemove'`

23
packages/site/docs/apis/interfaces/plugins/GridConfig.en.md
View File

@ -6,6 +6,11 @@ title: GridConfig
[plugins](../../modules/plugins.en.md).GridConfig [plugins](../../modules/plugins.en.md).GridConfig
This is an interface named `GridConfig`, which extends the `IPluginBaseConfig` interface. It contains the following properties:
- `img`: A string representing the background image of the grid.
- `follow`: A boolean indicating whether the grid follows the view movement.
## Hierarchy ## Hierarchy
- `IPluginBaseConfig` - `IPluginBaseConfig`
@ -24,9 +29,9 @@ IPluginBaseConfig.className
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L6) [packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L6)
___ ---
### container ### container
@ -38,9 +43,9 @@ IPluginBaseConfig.container
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L5) [packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L5)
___ ---
### follow ### follow
@ -48,9 +53,9 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/grid/index.ts:12](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/grid/index.ts#L12) [packages/g6/src/stdlib/plugin/grid/index.ts:19](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/grid/index.ts#L19)
___ ---
### graph ### graph
@ -62,9 +67,9 @@ IPluginBaseConfig.graph
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L7)
___ ---
### img ### img
@ -72,4 +77,4 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/grid/index.ts:11](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/grid/index.ts#L11) [packages/g6/src/stdlib/plugin/grid/index.ts:18](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/grid/index.ts#L18)

77
packages/site/docs/apis/interfaces/plugins/GridConfig.zh.md
View File

@ -2,74 +2,79 @@
title: GridConfig title: GridConfig
--- ---
[概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../. ./modules/plugins.zh.md) / GridConfig [概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../../modules/plugins.zh.md) / GridConfig
[插件](../../modules/plugins.zh.md).GridConfig [插件](../../modules/plugins.zh.md).GridConfig
＃＃ 等级制度 这是一个名为`GridConfig`的接口，它扩展了`IPluginBaseConfig`接口。它包含以下属性：
- `IPluginBaseConfig` - `img`：表示网格背景图像的字符串。
- `follow`：一个布尔值，表示网格是否跟随视图移动。
↳ **`GridConfig`** ## 层次结构
＃＃ 特性 - `IPluginBaseConfig`
＃＃＃ 班级名称 ↳ **`GridConfig`**
• `可选` **类名**：`字符串` ## 属性
####继承自 ### className
IPluginBaseConfig.className • 可选 **className**：字符串
#### 定义于 #### 继承自
[packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L6) IPluginBaseConfig.className
___ #### 定义在
＃＃＃ 容器 [packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L6)
• `可选` **容器**：`字符串` \| `HTMLDivElement` ---
####继承自 ### container
IPluginBaseConfig.container • 可选 **container**：字符串 | HTMLDivElemzht
#### 定义于 #### 继承自
[packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L5) IPluginBaseConfig.container
___ #### 定义在
＃＃＃ 跟随 [packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L5)
• `可选` **遵循**：`布尔值` ---
#### 定义于 ### follow
[packages/g6/src/stdlib/plugin/grid/index.ts:12](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/grid/index.ts) ts#L12) • 可选 **follow**：布尔值
___ #### 定义在
### 图表 [packages/g6/src/stdlib/plugin/grid/index.ts:19](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/grid/index.ts#L19)
• `可选` **graph**: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> ---
####继承自 ### graph
IPluginBaseConfig.graph • 可选 **graph**：[`IGraph`](../graph/IGraph.zh.md)<行为注册表, 主题注册表\>
#### 定义于 #### 继承自
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) IPluginBaseConfig.graph
___ #### 定义在
### 图片 [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L7)
• `可选` **img**：`字符串` ---
#### 定义于 ### img
[packages/g6/src/stdlib/plugin/grid/index.ts:11](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/grid/index.ts) ts#L11) • 可选 **img**：字符串
#### 定义在
[packages/g6/src/stdlib/plugin/grid/index.ts:18](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/grid/index.ts#L18)

23
packages/site/docs/apis/interfaces/plugins/HistoryConfig.en.md
View File

@ -6,6 +6,11 @@ title: HistoryConfig
[plugins](../../modules/plugins.en.md).HistoryConfig [plugins](../../modules/plugins.en.md).HistoryConfig
The `HistoryConfig` interface contains two properties: `enableStack` and `stackCfg`.
- `enableStack` is an optional boolean value that indicates whether to enable the stack.
- `stackCfg` is a required `StackCfg` type, representing the stack configuration.
## Hierarchy ## Hierarchy
- `IPluginBaseConfig` - `IPluginBaseConfig`
@ -24,9 +29,9 @@ IPluginBaseConfig.className
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L6) [packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L6)
___ ---
### container ### container
@ -38,9 +43,9 @@ IPluginBaseConfig.container
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L5) [packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L5)
___ ---
### enableStack ### enableStack
@ -48,9 +53,9 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/history/index.ts:8](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/history/index.ts#L8) [packages/g6/src/stdlib/plugin/history/index.ts:15](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/history/index.ts#L15)
___ ---
### graph ### graph
@ -62,9 +67,9 @@ IPluginBaseConfig.graph
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L7)
___ ---
### stackCfg ### stackCfg
@ -72,4 +77,4 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/history/index.ts:9](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/history/index.ts#L9) [packages/g6/src/stdlib/plugin/history/index.ts:16](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/history/index.ts#L16)

77
packages/site/docs/apis/interfaces/plugins/HistoryConfig.zh.md
View File

@ -2,74 +2,79 @@
title: HistoryConfig title: HistoryConfig
--- ---
[概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../. ./modules/plugins.zh.md) / HistoryConfig [概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../../modules/plugins.zh.md) / HistoryConfig
[插件](../../modules/plugins.zh.md).HistoryConfig [插件](../../modules/plugins.zh.md).HistoryConfig
＃＃ 等级制度 `HistoryConfig` 接口包含两个属性：`enableStack` 和 `stackCfg`。
- `IPluginBaseConfig` - `enableStack` 是一个可选的布尔值，表示是否启用堆栈。
- `stackCfg` 是一个必需的 `StackCfg` 类型，表示堆栈配置。
↳ **`历史配置`** ## 层次结构
＃＃ 特性 - `IPluginBaseConfig`
＃＃＃ 班级名称 ↳ **`HistoryConfig`**
• `可选` **类名**：`字符串` ## 属性
####继承自 ### className
IPluginBaseConfig.className • `Optional` **className**: `string`
#### 定义于 #### 继承自
[packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L6) IPluginBaseConfig.className
___ #### 定义在
＃＃＃ 容器 [packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L6)
• `可选` **容器**：`字符串` \| `HTMLDivElement` ---
####继承自 ### container
IPluginBaseConfig.container • `Optional` **container**: `string` \| `HTMLDivElement`
#### 定义于 #### 继承自
[packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L5) IPluginBaseConfig.container
___ #### 定义在
### 启用堆栈 [packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L5)
• `可选` **enableStack**：`布尔值` ---
#### 定义于 ### enableStack
[packages/g6/src/stdlib/plugin/history/index.ts:8](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/history/index.ts) ts#L8) • `Optional` **enableStack**: `boolean`
___ #### 定义在
### 图表 [packages/g6/src/stdlib/plugin/history/index.ts:15](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/history/index.ts#L15)
• `可选` **graph**: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> ---
####继承自 ### graph
IPluginBaseConfig.graph • `Optional` **graph**: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>
#### 定义于 #### 继承自
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) IPluginBaseConfig.graph
___ #### 定义在
### 堆栈配置 [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L7)
• **stackCfg**：`StackCfg` ---
#### 定义于 ### stackCfg
[packages/g6/src/stdlib/plugin/history/index.ts:9](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/history/index. ts#L9) • **stackCfg**: `StackCfg`
#### 定义在
[packages/g6/src/stdlib/plugin/history/index.ts:16](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/history/index.ts#L16)

20
packages/site/docs/apis/interfaces/plugins/LegendConfig.en.md
View File

@ -20,7 +20,7 @@ title: LegendConfig
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/legend/index.ts:55](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts#L55) [packages/g6/src/stdlib/plugin/legend/index.ts:55](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/legend/index.ts#L55)
___ ___
@ -34,7 +34,7 @@ IPluginBaseConfig.className
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/legend/index.ts:47](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts#L47) [packages/g6/src/stdlib/plugin/legend/index.ts:47](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/legend/index.ts#L47)
___ ___
@ -48,7 +48,7 @@ IPluginBaseConfig.container
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/legend/index.ts:45](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts#L45) [packages/g6/src/stdlib/plugin/legend/index.ts:45](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/legend/index.ts#L45)
___ ___
@ -58,7 +58,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/legend/index.ts:61](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts#L61) [packages/g6/src/stdlib/plugin/legend/index.ts:61](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/legend/index.ts#L61)
___ ___
@ -72,7 +72,7 @@ IPluginBaseConfig.graph
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L7)
___ ___
@ -82,7 +82,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/legend/index.ts:57](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts#L57) [packages/g6/src/stdlib/plugin/legend/index.ts:57](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/legend/index.ts#L57)
___ ___
@ -92,7 +92,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/legend/index.ts:59](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts#L59) [packages/g6/src/stdlib/plugin/legend/index.ts:59](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/legend/index.ts#L59)
___ ___
@ -102,7 +102,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/legend/index.ts:51](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts#L51) [packages/g6/src/stdlib/plugin/legend/index.ts:51](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/legend/index.ts#L51)
___ ___
@ -112,7 +112,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/legend/index.ts:53](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts#L53) [packages/g6/src/stdlib/plugin/legend/index.ts:53](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/legend/index.ts#L53)
___ ___
@ -122,4 +122,4 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/legend/index.ts:49](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts#L49) [packages/g6/src/stdlib/plugin/legend/index.ts:49](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/legend/index.ts#L49)

122
packages/site/docs/apis/interfaces/plugins/LegendConfig.zh.md
View File

@ -2,124 +2,124 @@
title: LegendConfig title: LegendConfig
--- ---
[概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../. ./modules/plugins.zh.md) / LegendConfig [概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../../modules/plugins.zh.md) / LegendConfig
[插件](../../modules/plugins.zh.md).LegendConfig [插件](../../modules/plugins.zh.md).LegendConfig
＃＃ 等级制度 ## 层次结构
- `IPluginBaseConfig` - `IPluginBaseConfig`
↳ **`图例配置`** ↳ **`LegendConfig`**
＃＃ 特性 ## 属性
### 活动状态 ### activeState
• `可选` **activeState**：`字符串` • `Optional` **activeState**: `string`
#### 定义于 #### 定义在
[packages/g6/src/stdlib/plugin/legend/index.ts:55](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts) ts#L55) [packages/g6/src/stdlib/plugin/legend/index.ts:55](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/legend/index.ts#L55)
___ ---
＃＃＃ 班级名称 ### className
• `可选` **类名**：`字符串` • `Optional` **className**: `string`
#### 覆盖 #### 覆盖
IPluginBaseConfig.className IPluginBaseConfig.className
#### 定义于 #### 定义在
[packages/g6/src/stdlib/plugin/legend/index.ts:47](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts) ts#L47) [packages/g6/src/stdlib/plugin/legend/index.ts:47](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/legend/index.ts#L47)
___ ---
＃＃＃ 容器 ### container
• `可选` **容器**：`HTMLDivElement` • `Optional` **container**: `HTMLDivElement`
#### 覆盖 #### 覆盖
IPluginBaseConfig.container IPluginBaseConfig.container
#### 定义于 #### 定义在
[packages/g6/src/stdlib/plugin/legend/index.ts:45](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts) ts#L45) [packages/g6/src/stdlib/plugin/legend/index.ts:45](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/legend/index.ts#L45)
___ ---
＃＃＃ 边缘 ### edge
• `可选` **边缘**：`ItemLegendConfig` • `Optional` **edge**: `ItemLegendConfig`
#### 定义于 #### 定义在
[packages/g6/src/stdlib/plugin/legend/index.ts:61](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts) ts#L61) [packages/g6/src/stdlib/plugin/legend/index.ts:61](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/legend/index.ts#L61)
___ ---
### 图表 ### graph
• `可选` **graph**: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> • `Optional` **graph**: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>
####继承自 #### 继承自
IPluginBaseConfig.graph IPluginBaseConfig.graph
#### 定义于 #### 定义在
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L7)
___ ---
### 非活动状态 ### inactiveState
• `可选` **inactiveState**：`字符串` • `Optional` **inactiveState**: `string`
#### 定义于 #### 定义在
[packages/g6/src/stdlib/plugin/legend/index.ts:57](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts) ts#L57) [packages/g6/src/stdlib/plugin/legend/index.ts:57](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/legend/index.ts#L57)
___ ---
### 节点 ### node
• `可选` **节点**：`ItemLegendConfig` • `Optional` **node**: `ItemLegendConfig`
#### 定义于 #### 定义在
[packages/g6/src/stdlib/plugin/legend/index.ts:59](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts) ts#L59) [packages/g6/src/stdlib/plugin/legend/index.ts:59](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/legend/index.ts#L59)
___ ---
＃＃＃ 方向 ### orientation
• `可选` **方向**：``"水平"`` \| ``“垂直”`` • `Optional` **orientation**: `"horizontal"` \| `"vertical"`
#### 定义于 #### 定义在
[packages/g6/src/stdlib/plugin/legend/index.ts:51](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts) ts#L51) [packages/g6/src/stdlib/plugin/legend/index.ts:51](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/legend/index.ts#L51)
___ ---
### 选定状态 ### selectedState
• `可选` **selectedState**：`字符串` • `Optional` **selectedState**: `string`
#### 定义于 #### 定义在
[packages/g6/src/stdlib/plugin/legend/index.ts:53](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.ts) ts#L53) [packages/g6/src/stdlib/plugin/legend/index.ts:53](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/stdlib/plugin/legend/index.ts#L53)
___ ---
＃＃＃ 尺寸 ### size
• `可选` **尺寸**：``"fit-content"`` \| [`字符串`\| `数字`、`字符串` \| `数字`] • `Optional` **size**: `"fit-content"` \| [`string` \| `number`, `string` \| `number`]
#### 定义于 #### 定义在
[packages/g6/src/stdlib/plugin/legend/index.ts:49](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/legend/index.html ts#L49) [packages/g6/src/stdlib/plugin/legend/index.ts:49](https://github.com/antvis/G6/blob

39
packages/site/docs/apis/interfaces/plugins/MenuConfig.en.md
View File

@ -6,6 +6,19 @@ title: MenuConfig
[plugins](../../modules/plugins.en.md).MenuConfig [plugins](../../modules/plugins.en.md).MenuConfig
The `MenuConfig` interface contains the following properties:
- `handleMenuClick`: An optional function for handling menu click events. It takes two arguments: `target` (of type HTMLElement) and `item` (of type Item), and has no return value.
- `getContent`: An optional function for getting the content of the menu. It takes an optional argument of type `IG6GraphEvent`, and returns a value of type HTMLDivElement, string, or Promise (resolving to HTMLDivElement or string).
- `offsetX`: An optional number representing the offset of the menu in the X direction.
- `offsetY`: An optional number representing the offset of the menu in the Y direction.
- `shouldBegin`: An optional function for determining whether the menu should be displayed. It takes an optional argument of type `IG6GraphEvent`, and returns a boolean value.
- `itemTypes`: An optional array of strings representing the types of items for which the menu is allowed to be displayed.
- `trigger`: An optional string, either 'click' or 'contextmenu', representing the event type that triggers the display of the menu.
- `onHide`: An optional function to be executed when the menu is hidden. It takes no arguments and returns a boolean value.
- `loadingContent`: An optional HTMLDivElement or string representing the loading DOM.
- `liHoverStyle`: An optional object representing the style of li elements when hovered over. It can contain any number of key-value pairs, where the key is a style name and the value is a string.
## Hierarchy ## Hierarchy
- `IPluginBaseConfig` - `IPluginBaseConfig`
@ -24,7 +37,7 @@ IPluginBaseConfig.className
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L6) [packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L6)
___ ___
@ -38,7 +51,7 @@ IPluginBaseConfig.container
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L5) [packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L5)
___ ___
@ -62,7 +75,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/menu/index.ts:41](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts#L41) [packages/g6/src/stdlib/plugin/menu/index.ts:54](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L54)
___ ___
@ -76,7 +89,7 @@ IPluginBaseConfig.graph
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L7)
___ ___
@ -101,7 +114,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/menu/index.ts:39](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts#L39) [packages/g6/src/stdlib/plugin/menu/index.ts:52](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L52)
___ ___
@ -111,7 +124,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/menu/index.ts:47](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts#L47) [packages/g6/src/stdlib/plugin/menu/index.ts:60](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L60)
___ ___
@ -125,7 +138,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/menu/index.ts:52](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts#L52) [packages/g6/src/stdlib/plugin/menu/index.ts:65](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L65)
___ ___
@ -135,7 +148,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/menu/index.ts:51](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts#L51) [packages/g6/src/stdlib/plugin/menu/index.ts:64](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L64)
___ ___
@ -145,7 +158,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/menu/index.ts:44](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts#L44) [packages/g6/src/stdlib/plugin/menu/index.ts:57](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L57)
___ ___
@ -155,7 +168,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/menu/index.ts:45](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts#L45) [packages/g6/src/stdlib/plugin/menu/index.ts:58](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L58)
___ ___
@ -173,7 +186,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/menu/index.ts:49](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts#L49) [packages/g6/src/stdlib/plugin/menu/index.ts:62](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L62)
___ ___
@ -197,7 +210,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/menu/index.ts:46](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts#L46) [packages/g6/src/stdlib/plugin/menu/index.ts:59](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L59)
___ ___
@ -207,4 +220,4 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/menu/index.ts:48](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts#L48) [packages/g6/src/stdlib/plugin/menu/index.ts:61](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L61)

223
packages/site/docs/apis/interfaces/plugins/MenuConfig.zh.md
View File

@ -2,209 +2,210 @@
title: MenuConfig title: MenuConfig
--- ---
[概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../. ./modules/plugins.zh.md) / 菜单配置 [概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../../modules/plugins.zh.md) / MenuConfig
[插件](../../modules/plugins.zh.md).MenuConfig [插件](../../modules/plugins.zh.md).MenuConfig
＃＃ 等级制度 `MenuConfig` 接口包含以下属性：
- `IPluginBaseConfig` - `handleMenuClick`：用于处理菜单点击事件的可选函数。它接受两个参数：`target`（类型为 HTMLElement）和 `item`（类型为 Item），并且没有返回值。
- `getContent`：用于获取菜单内容的可选函数。它接受一个可选的 `IG6GraphEvent` 类型参数，并返回 HTMLDivElement、string 或 Promise（解析为 HTMLDivElement 或 string）类型的值。
- `offsetX`：表示菜单在 X 方向上的偏移量的可选数字。
- `offsetY`：表示菜单在 Y 方向上的偏移量的可选数字。
- `shouldBegin`：用于确定是否应显示菜单的可选函数。它接受一个可选的 `IG6GraphEvent` 类型参数，并返回布尔值。
- `itemTypes`：表示允许显示菜单的项目类型的可选字符串数组。
- `trigger`：一个可选字符串，为 'click' 或 'contextmenu'，表示触发菜单显示的事件类型。
- `onHide`：当菜单隐藏时执行的可选函数。它不接受任何参数并返回布尔值。
- `loadingContent`：表示加载 DOM 的可选 HTMLDivElement 或字符串。
- `liHoverStyle`：表示鼠标悬停在 li 元素上时的样式的可选对象。它可以包含任意数量的键值对，其中键是样式名称，值是字符串。
↳ **`菜单配置`** ## 层次结构
＃＃ 特性 - `IPluginBaseConfig`
＃＃＃ 班级名称 ↳ **`MenuConfig`**
• `可选` **类名**：`字符串` ## 属性
####继承自 ### className
IPluginBaseConfig.className • `Optional` **className**: `string`
#### 定义于 #### 继承自
[packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L6) IPluginBaseConfig.className
___ #### 定义在
＃＃＃ 容器 [packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L6)
• `可选` **容器**：`字符串` \| `HTMLDivElement` ---
####继承自 ### container
IPluginBaseConfig.container • `Optional` **container**: `string` \| `HTMLDivElement`
#### 定义于 #### 继承自
[packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L5) IPluginBaseConfig.container
___ #### 定义在
### 获取内容 [packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L5)
• `可选` **getContent**: (`evt?`: [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md)) => `string` \| `HTMLDivElement` \| `Promise`<`字符串` \| `HTMLDivElement`\> ---
#### 类型声明 ### getContent
▸ (`evt?`): `字符串` \| `HTMLDivElement` \| `Promise`<`字符串` \| `HTMLDivElement`\> • `Optional` **getContent**: (`evt?`: [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md)) => `string` \| `HTMLDivElement` \| `Promise`<`string` \| `HTMLDivElement`\>
＃＃＃＃＃ 参数 #### 类型声明
| 名称 | 类型 | ▸ (`evt?`): `string` \| `HTMLDivElement` \| `Promise`<`string` \| `HTMLDivElement`\>
| :------ | :------ |
| `事件？` | [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md) |
##### 返回 ##### 参数
`字符串` \| `HTMLDivElement` \| `Promise`<`字符串` \| `HTMLDivElement`\> | 名称 | 类型 |
| :----- | :-------------------------------------------------- |
| `evt?` | [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md) |
#### 定义于 ##### 返回
[packages/g6/src/stdlib/plugin/menu/index.ts:41](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts) ts#L41) 帮您翻译
___ ##### 参数
### 图表 | 名称 | 类型 |
| :----- | :-------------------------------------------------- |
| `evt?` | [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md) |
• `可选` **graph**: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> ##### 返回
####继承自 `string` \| `HTMLDivElement` \| `Promise`<`string` \| `HTMLDivElement`\>
IPluginBaseConfig.graph #### 定义在
#### 定义于 [packages/g6/src/stdlib/plugin/menu/index.ts:54](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L54)
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) ---
___ ### graph
### 处理菜单点击 • `Optional` **graph**: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>
• `可选` **handleMenuClick**: (`target`: `HTMLElement`, `item`: `default`) => `void` #### 继承自
#### 类型声明 IPluginBaseConfig.graph
▸ (`目标`, `项目`): `void` #### 定义在
＃＃＃＃＃ 参数 [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L7)
| 名称 | 类型 | ---
| :------ | :------ |
| `目标` | `HTMLElement` |
| `项目` | `默认` |
##### 返回 ### handleMenuClick
`无效` • `Optional` **handleMenuClick**: (`target`: `HTMLElement`, `item`: `default`) => `void`
#### 定义于 #### 类型声明
[packages/g6/src/stdlib/plugin/menu/index.ts:39](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts) ts#L39) ▸ (`target`, `item`): `void`
___ ##### 参数
### 项目类型 | 名称 | 类型 |
| :------- | :------------ |
| `target` | `HTMLElement` |
| `item` | `default` |
• `可选` **itemTypes**：`string`[] ##### 返回
#### 定义于 `void`
[packages/g6/src/stdlib/plugin/menu/index.ts:47](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts) ts#L47) #### 定义在
___ [packages/g6/src/stdlib/plugin/menu/index.ts:52](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L52)
### liHoverStyle ---
• `可选` **liHoverStyle**：`对象` ### itemTypes
#### 索引签名 • `Optional` **itemTypes**: `string`[]
▪ [key: `string`]: `string` #### 定义在
#### 定义于 [packages/g6/src/stdlib/plugin/menu/index.ts:60](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L60)
[packages/g6/src/stdlib/plugin/menu/index.ts:52](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts) ts#L52) ---
___ ### liHoverStyle
### 加载内容 • `Optional` **liHoverStyle**: `Object`
• `可选` **loadingContent**：`字符串` \| `HTMLDivElement` #### 索引签名
#### 定义于 ▪ [key: `string`]: `string`
[packages/g6/src/stdlib/plugin/menu/index.ts:51](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts) ts#L51) #### 定义在
___ [packages/g6/src/stdlib/plugin/menu/index.ts:65](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L65)
### 偏移X ---
• `可选` **offsetX**：`数字` ### loadingContent
#### 定义于 • `Optional` **loadingContent**: `string` \| `HTMLDivElement`
[packages/g6/src/stdlib/plugin/menu/index.ts:44](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts) ts#L44) #### 定义在
___ [packages/g6/src/stdlib/plugin/menu/index.ts:64](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L64)
### 偏移Y ---
• `可选` **offsetY**：`数字` ### offsetX
#### 定义于 • `Optional` **offsetX**: `number`
[packages/g6/src/stdlib/plugin/menu/index.ts:45](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts) ts#L45) #### 定义在
___ [packages/g6/src/stdlib/plugin/menu/index.ts:57](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L57)
### 隐藏 ---
• `可选` **onHide**: () => `boolean` ### offsetY
#### 类型声明 • `Optional` **offsetY**: `number`
▸ (): `布尔值` #### 定义在
##### 返回 [packages/g6/src/stdlib/plugin/menu/index.ts:58](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L58)
`布尔值` ---
#### 定义于 ### onHide
[packages/g6/src/stdlib/plugin/menu/index.ts:49](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts) ts#L49) • `Optional` **onHide**: () => `boolean`
___ #### 类型声明
### 应该开始 ▸ (): `boolean`
• `可选` **shouldBegin**: (`evt?`: [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md)) => `boolean` ##### 返回
#### 类型声明 `boolean`
▸ (`evt?`): `布尔值` #### 定义在
＃＃＃＃＃ 参数 [packages/g6/src/stdlib/plugin/menu/index.ts:62](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/menu/index.ts#L62)
| 名称 | 类型 | ---
| :------ | :------ |
| `事件？` | [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md) |
##### 返回 ### shouldBegin
`布尔值` • `Optional` **shouldBegin**: (`evt?`: [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md)) => `boolean`
#### 定义于 #### 类型声明
[packages/g6/src/stdlib/plugin/menu/index.ts:46](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts) ts#L46) ▸ (`evt?`): `boolean`
___ ##### 参数
＃＃＃ 扳机
• `可选` **触发**：``"contextmenu"`` \| ``“点击”``
#### 定义于
[packages/g6/src/stdlib/plugin/menu/index.ts:48](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/menu/index.ts) ts#L48)

38
packages/site/docs/apis/interfaces/plugins/MiniMapConfig.en.md
View File

@ -18,13 +18,15 @@ title: MiniMapConfig
• `Optional` **className**: `string` • `Optional` **className**: `string`
Class name of minimap
#### Overrides #### Overrides
IPluginBaseConfig.className IPluginBaseConfig.className
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/minimap/index.ts:19](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts#L19) [packages/g6/src/stdlib/plugin/minimap/index.ts:21](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L21)
___ ___
@ -32,13 +34,15 @@ ___
• `Optional` **container**: `HTMLDivElement` • `Optional` **container**: `HTMLDivElement`
Container for minimap
#### Overrides #### Overrides
IPluginBaseConfig.container IPluginBaseConfig.container
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/minimap/index.ts:26](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts#L26) [packages/g6/src/stdlib/plugin/minimap/index.ts:35](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L35)
___ ___
@ -46,9 +50,11 @@ ___
• `Optional` **delegateStyle**: `Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `animates?`: `IAnimates` ; `lod?`: `number` ; `visible?`: `boolean` }\> • `Optional` **delegateStyle**: `Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `animates?`: `IAnimates` ; `lod?`: `number` ; `visible?`: `boolean` }\>
Style of delegate shape
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/minimap/index.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts#L22) [packages/g6/src/stdlib/plugin/minimap/index.ts:27](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L27)
___ ___
@ -62,7 +68,7 @@ IPluginBaseConfig.graph
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L7)
___ ___
@ -70,9 +76,11 @@ ___
• `Optional` **hideEdge**: `boolean` • `Optional` **hideEdge**: `boolean`
Whether to hide edges on minimap to enhance performance
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/minimap/index.ts:25](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts#L25) [packages/g6/src/stdlib/plugin/minimap/index.ts:33](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L33)
___ ___
@ -80,9 +88,11 @@ ___
• `Optional` **mode**: ``"keyShape"`` \| ``"default"`` \| ``"delegate"`` • `Optional` **mode**: ``"keyShape"`` \| ``"default"`` \| ``"delegate"``
Mode of minimap
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/minimap/index.ts:20](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts#L20) [packages/g6/src/stdlib/plugin/minimap/index.ts:23](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L23)
___ ___
@ -90,9 +100,11 @@ ___
• `Optional` **padding**: `number` • `Optional` **padding**: `number`
Padding of minimap
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/minimap/index.ts:24](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts#L24) [packages/g6/src/stdlib/plugin/minimap/index.ts:31](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L31)
___ ___
@ -100,9 +112,11 @@ ___
• `Optional` **refresh**: `boolean` • `Optional` **refresh**: `boolean`
Whether to refresh minimap
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/minimap/index.ts:23](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts#L23) [packages/g6/src/stdlib/plugin/minimap/index.ts:29](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L29)
___ ___
@ -110,9 +124,11 @@ ___
• `Optional` **size**: `number`[] • `Optional` **size**: `number`[]
Size of minimap
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/minimap/index.ts:21](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts#L21) [packages/g6/src/stdlib/plugin/minimap/index.ts:25](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L25)
___ ___
@ -120,6 +136,8 @@ ___
• `Optional` **viewportClassName**: `string` • `Optional` **viewportClassName**: `string`
Class name of viewport
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/minimap/index.ts:18](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts#L18) [packages/g6/src/stdlib/plugin/minimap/index.ts:19](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L19)

140
packages/site/docs/apis/interfaces/plugins/MiniMapConfig.zh.md
View File

@ -2,124 +2,142 @@
title: MiniMapConfig title: MiniMapConfig
--- ---
[概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../. ./modules/plugins.zh.md) / MiniMapConfig [概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../../modules/plugins.zh.md) / MiniMapConfig
[插件](../../modules/plugins.zh.md).MiniMapConfig [插件](../../modules/plugins.zh.md).MiniMapConfig
＃＃ 等级制度 ## 层次结构
- `IPluginBaseConfig` - `IPluginBaseConfig`
↳ **`MiniMapConfig`** ↳ **`MiniMapConfig`**
＃＃ 特性 ## 属性
＃＃＃ 班级名称 ### className
• `可选` **类名**：`字符串` • 可选 **className**：字符串
#### 覆盖 minimap 的类名
IPluginBaseConfig.className #### 覆盖
#### 定义于 IPluginBaseConfig.className
[packages/g6/src/stdlib/plugin/minimap/index.ts:19](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts) ts#L19) #### 定义在
___ [packages/g6/src/stdlib/plugin/minimap/index.ts:21](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L21)
＃＃＃ 容器 ---
• `可选` **容器**：`HTMLDivElement` ### container
#### 覆盖 • 可选 **container**：HTMLDivElement
IPluginBaseConfig.container minimap 的容器
#### 定义于 #### 覆盖
[packages/g6/src/stdlib/plugin/minimap/index.ts:26](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts) ts#L26) IPluginBaseConfig.container
___ #### 定义在
### 委托样式 [packages/g6/src/stdlib/plugin/minimap/index.ts:35](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L35)
• `可选` **delegateStyle**：`Partial`<`CircleStyleProps` & `RectStyleProps` & `EllipseStyleProps` & `PolygonStyleProps` & `LineStyleProps` & `PolylineStyleProps` & `TextStyleProps` & `ImageStyleProps` & `PathStyleProps` & `SphereGeometryProps` & `CubeGeometryProps` & `PlaneGeometryProps` & { `动画？`: `IAnimates` ; `lod?`: `数字`; `可见？`: `布尔值` }\> ---
#### 定义于 ### delegateStyle
[packages/g6/src/stdlib/plugin/minimap/index.ts:22](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts) ts#L22) • 可选 **delegateStyle**：部分<圆形样式属性 & 矩形样式属性 & 椭圆样式属性 & 多边形样式属性 & 线条样式属性 & 折线样式属性 & 文本样式属性 & 图像样式属性 & 路径样式属性 & 球体几何属性 & 立方体几何属性 & 平面几何属性 & {动画？: IAnimates; lod？: 数字; 可见？: 布尔}\>
___ 代理形状的样式。
### 图表 #### 定义在
• `可选` **graph**: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> [packages/g6/src/stdlib/plugin/minimap/index.ts:27](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L27)
####继承自 ---
IPluginBaseConfig.graph ### graph
#### 定义于 • 可选 **graph**：[`IGraph`](../graph/IGraph.zh.md)<行为注册表, 主题注册表\>
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) #### 继承自
___ IPluginBaseConfig.graph
### 隐藏边缘 #### 定义在
• `可选` **hideEdge**：`布尔值` [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L7)
#### 定义于 ---
[packages/g6/src/stdlib/plugin/minimap/index.ts:25](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts) ts#L25) ### hideEdge
___ • 可选 **hideEdge**：布尔值
＃＃＃ 模式 是否在 minimap 上隐藏边缘以提高性能。
• `可选` **模式**：``"keyShape"`` \| ``“默认”`` \| ``“代表”`` #### 定义在
#### 定义于 [packages/g6/src/stdlib/plugin/minimap/index.ts:33](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L33)
[packages/g6/src/stdlib/plugin/minimap/index.ts:20](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts) ts#L20) ---
___ ### mode
### 填充 • 可选 **mode**：`"keyShape"` | `"default"` | `"delegate"`
• `可选` **填充**：`数字` minimap 的模式。
#### 定义于 #### 定义在
[packages/g6/src/stdlib/plugin/minimap/index.ts:24](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts) ts#L24) [packages/g6/src/stdlib/plugin/minimap/index.ts:23](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L23)
___ ---
＃＃＃ 刷新 ### padding
• `可选` **刷新**：`布尔值` • 可选 **padding**：数字
#### 定义于 minimap 的填充。
[packages/g6/src/stdlib/plugin/minimap/index.ts:23](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts) ts#L23) #### 定义在
___ [packages/g6/src/stdlib/plugin/minimap/index.ts:31](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L31)
＃＃＃ 尺寸 ---
• `可选` **尺寸**：`数量`[] ### refresh
#### 定义于 • 可选 **refresh**：布尔值
[packages/g6/src/stdlib/plugin/minimap/index.ts:21](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts) ts#L21) 是否刷新 minimap。
___ #### 定义在
### 视口类名 [packages/g6/src/stdlib/plugin/minimap/index.ts:29](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L29)
• `可选` **viewportClassName**：`string` ---
#### 定义于 ### size
[packages/g6/src/stdlib/plugin/minimap/index.ts:18](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/minimap/index.ts) ts#L18) • 可选 **size**：数字[]
minimap 的大小。
#### 定义在
[packages/g6/src/stdlib/plugin/minimap/index.ts:25](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L25)
---
### viewportClassName
• 可选 **viewportClassName**：字符串
视口的类名。
#### 定义在
[packages/g6/src/stdlib/plugin/minimap/index.ts:19](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/minimap/index.ts#L19)

42
packages/site/docs/apis/interfaces/plugins/ToolbarConfig.en.md
View File

@ -6,6 +6,14 @@ title: ToolbarConfig
[plugins](../../modules/plugins.en.md).ToolbarConfig [plugins](../../modules/plugins.en.md).ToolbarConfig
The `ToolbarConfig` interface contains the following properties:
- `handleClick`: An optional function for handling clicks on the toolbar. It takes two arguments: `code` (of type string) and `graph` (of type IGraph), and has no return value.
- `getContent`: A required function for getting the content of the toolbar. It takes an optional argument of type `IGraph`, and returns a value of type HTMLDivElement or string.
- `zoomSensitivity`: An optional number representing the zoom sensitivity of the toolbar. The default value is 10.
- `minZoom`: An optional number representing the minimum zoom ratio of the toolbar. The default value is 0.00001.
- `maxZoom`: An optional number representing the maximum zoom ratio of the toolbar. The default value is 1000.
## Hierarchy ## Hierarchy
- `IPluginBaseConfig` - `IPluginBaseConfig`
@ -24,7 +32,7 @@ IPluginBaseConfig.className
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L6) [packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L6)
___ ___
@ -38,7 +46,7 @@ IPluginBaseConfig.container
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L5) [packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L5)
___ ___
@ -50,6 +58,8 @@ ___
▸ (`graph?`): `string` \| `HTMLDivElement` ▸ (`graph?`): `string` \| `HTMLDivElement`
Function for getting content of toolbar
##### Parameters ##### Parameters
| Name | Type | | Name | Type |
@ -62,7 +72,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/toolbar/index.ts:14](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/toolbar/index.ts#L14) [packages/g6/src/stdlib/plugin/toolbar/index.ts:20](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/toolbar/index.ts#L20)
___ ___
@ -76,7 +86,7 @@ IPluginBaseConfig.graph
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L7)
___ ___
@ -88,14 +98,14 @@ ___
▸ (`code`, `graph`): `void` ▸ (`code`, `graph`): `void`
toolbar config Function for handling clicks on toolbar
##### Parameters ##### Parameters
| Name | Type | Description | | Name | Type |
| :------ | :------ | :------ | | :------ | :------ |
| `code` | `string` | toolbar item code | | `code` | `string` |
| `graph` | [`IGraph`](../graph/IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\> | Graph Instance | | `graph` | [`IGraph`](../graph/IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\> |
##### Returns ##### Returns
@ -103,7 +113,7 @@ toolbar config
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/toolbar/index.ts:13](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/toolbar/index.ts#L13) [packages/g6/src/stdlib/plugin/toolbar/index.ts:18](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/toolbar/index.ts#L18)
___ ___
@ -111,9 +121,11 @@ ___
• **maxZoom**: `number` • **maxZoom**: `number`
Maximum zoom ratio of toolbar
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/toolbar/index.ts:17](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/toolbar/index.ts#L17) [packages/g6/src/stdlib/plugin/toolbar/index.ts:26](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/toolbar/index.ts#L26)
___ ___
@ -121,9 +133,11 @@ ___
• **minZoom**: `number` • **minZoom**: `number`
Minimum zoom ratio of toolbar
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/toolbar/index.ts:16](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/toolbar/index.ts#L16) [packages/g6/src/stdlib/plugin/toolbar/index.ts:24](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/toolbar/index.ts#L24)
___ ___
@ -131,6 +145,8 @@ ___
• **zoomSensitivity**: `number` • **zoomSensitivity**: `number`
Zoom sensitivity of toolbar
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/toolbar/index.ts:15](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/toolbar/index.ts#L15) [packages/g6/src/stdlib/plugin/toolbar/index.ts:22](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/toolbar/index.ts#L22)

160
packages/site/docs/apis/interfaces/plugins/ToolbarConfig.zh.md
View File

@ -1,136 +1,154 @@
--- 帮您翻译
title: ToolbarConfig
--- ---
[概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../. ./modules/plugins.zh.md) / ToolbarConfig ## 标题: ToolbarConfig
[插件](../../modules/plugins.zh.md).ToolbarConfig [概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../../modules/plugins.zh.md) / ToolbarConfig
＃＃ 等级制度 [插件](../../modules/plugins.zh.md).ToolbarConfig
- `IPluginBaseConfig` `ToolbarConfig` 接口包含以下属性：
↳ **`工具栏配置`** - `handleClick`：用于处理工具栏上的点击的可选函数。它接受两个参数：`code`（类型为 string）和 `graph`（类型为 IGraph），并且没有返回值。
- `getContent`：用于获取工具栏内容的必需函数。它接受一个可选的 `IGraph` 类型参数，并返回 HTMLDivElement 或 string 类型的值。
- `zoomSensitivity`：表示工具栏的缩放灵敏度的可选数字。默认值为 10。
- `minZoom`：表示工具栏的最小缩放比例的可选数字。默认值为 0.00001。
- `maxZoom`：表示工具栏的最大缩放比例的可选数字。默认值为 1000。
＃＃ 特性 ## 层次结构
＃＃＃ 班级名称 - `IPluginBaseConfig`
• `可选` **类名**：`字符串` ↳ **`ToolbarConfig`**
####继承自 ## 属性
IPluginBaseConfig.className ### className
#### 定义于 • `Optional` **className**: `string`
[packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L6) #### 继承自
___ IPluginBaseConfig.className
＃＃＃ 容器 #### 定义在
• `可选` **容器**：`字符串` \| `HTMLDivElement` [packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L6)
####继承自 ---
IPluginBaseConfig.container ### container
#### 定义于 • `Optional` **container**: `string` \| `HTMLDivElement`
[packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L5) #### 继承自
___ IPluginBaseConfig.container
### 获取内容 #### 定义在
• **getContent**: (`graph?`: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>) => `string` \| `HTMLDivElement` [packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L5)
#### 类型声明 ---
▸ (`图?`): `字符串` \| `HTMLDivElement` ### getContent
＃＃＃＃＃ 参数 • **getContent**: (`graph?`: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>) => `string` \| `HTMLDivElement`
| 名称 | 类型 | #### 类型声明
| :------ | :------ |
| `图？` | [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> |
##### 返回 ▸ (`graph?`): `string` \| `HTMLDivElement`
`字符串` \| `HTMLDivElement` 用于获取工具栏内容的函数
#### 定义于 ##### 参数
[packages/g6/src/stdlib/plugin/toolbar/index.ts:14](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/toolbar/index.ts) ts#L14) | 名称 | 类型 |
| :------- | :---------------------------------------------------------------------- |
| `graph?` | [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> |
___ ##### 返回
### 图表 `string` \| `HTMLDivElement`
• `可选` **graph**: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> #### 定义在
####继承自 [packages/g6/src/stdlib/plugin/toolbar/index.ts:20](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/toolbar/index.ts#L20)
IPluginBaseConfig.graph ---
#### 定义于 ### graph
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) • `Optional` **graph**: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>
___ #### 继承自
### 处理点击 IPluginBaseConfig.graph
• `可选` **handleClick**: (`code`: `string`, `graph`: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> ) => `无效` #### 定义在
#### 类型声明 [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L7)
▸ (`代码`, `图表`): `void` ---
工具栏配置 ### handleClick
＃＃＃＃＃ 参数 • `Optional` **handleClick**: (`code`: `string`, `graph`: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>) => `void`
| 名称 | 类型 | 描述 | #### 类型声明
| :------ | :------ | :------ |
| `代码` | `字符串` | 工具栏项目代码|
| `图` | [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> | 图实例|
##### 返回 ▸ (`code`, `graph`): `void`
`无效` 用于处理工具栏上点击的函数
#### 定义于 ##### 参数
[packages/g6/src/stdlib/plugin/toolbar/index.ts:13](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/toolbar/index.ts) ts#L13) | 名称 | 类型 |
| :------ | :---------------------------------------------------------------------- |
| `code` | `string` |
| `graph` | [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> |
___ ##### 返回
### 最大缩放 `void`
• **maxZoom**：`数量` #### 定义在
#### 定义于 [packages/g6/src/stdlib/plugin/toolbar/index.ts:18](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/toolbar/index.ts#L18)
[packages/g6/src/stdlib/plugin/toolbar/index.ts:17](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/toolbar/index.ts) ts#L17) ---
___ ### maxZoom
### 最小缩放 • **maxZoom**: `number`
• **minZoom**：`数字` 工具栏的最大缩放比例
#### 定义于 #### 定义在
[packages/g6/src/stdlib/plugin/toolbar/index.ts:16](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/toolbar/index.ts) ts#L16) [packages/g6/src/stdlib/plugin/toolbar/index.ts:26](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/toolbar/index.ts#L26)
___ ---
### 缩放灵敏度 ### minZoom
• **缩放灵敏度**：`数字` • **minZoom**: `number`
#### 定义于 工具栏的最小缩放比例
[packages/g6/src/stdlib/plugin/toolbar/index.ts:15](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/toolbar/index.ts) ts#L15) #### 定义在
[packages/g6/src/stdlib/plugin/toolbar/index.ts:24](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/toolbar/index.ts#L24)
---
### zoomSensitivity
• **zoomSensitivity**: `number`
工具栏的缩放灵敏度
#### 定义在
[packages/g6/src/stdlib/plugin/toolbar/index.ts:22](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/toolbar/index.ts#L22)

49
packages/site/docs/apis/interfaces/plugins/TooltipConfig.en.md
View File

@ -6,6 +6,17 @@ title: TooltipConfig
[plugins](../../modules/plugins.en.md).TooltipConfig [plugins](../../modules/plugins.en.md).TooltipConfig
The `TooltipConfig` interface contains the following properties:
- `getContent`: An optional function for getting the content of the tooltip. It takes an optional argument of type `IG6GraphEvent`, and returns a value of type HTMLDivElement, string, or Promise (resolving to HTMLDivElement or string).
- `offsetX`: An optional number representing the offset of the tooltip in the X direction.
- `offsetY`: An optional number representing the offset of the tooltip in the Y direction.
- `shouldBegin`: An optional function for determining whether the tooltip should be displayed. It takes an optional argument of type `IG6GraphEvent`, and returns a boolean value.
- `itemTypes`: An optional array of strings representing the types of items for which the tooltip is allowed to be displayed. The possible values are 'node', 'edge', 'combo', and 'canvas'.
- `trigger`: An optional string, either 'pointerenter' or 'click', representing the event type that triggers the display of the tooltip.
- `fixToNode`: An optional array of two numbers, a string representing a placement, or undefined, representing how to fix the tooltip to a node.
- `loadingContent`: An optional HTMLDivElement or string representing the loading DOM.
## Hierarchy ## Hierarchy
- `IPluginBaseConfig` - `IPluginBaseConfig`
@ -24,7 +35,7 @@ IPluginBaseConfig.className
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L6) [packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L6)
___ ___
@ -38,7 +49,7 @@ IPluginBaseConfig.container
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L5) [packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L5)
___ ___
@ -46,9 +57,11 @@ ___
• `Optional` **fixToNode**: [`number`, `number`] \| `Placement` • `Optional` **fixToNode**: [`number`, `number`] \| `Placement`
How to fix tooltip to node
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/tooltip/index.ts:66](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.ts#L66) [packages/g6/src/stdlib/plugin/tooltip/index.ts:85](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L85)
___ ___
@ -60,6 +73,8 @@ ___
▸ (`evt?`): `string` \| `HTMLDivElement` \| `Promise`<`string` \| `HTMLDivElement`\> ▸ (`evt?`): `string` \| `HTMLDivElement` \| `Promise`<`string` \| `HTMLDivElement`\>
Function for getting tooltip content
##### Parameters ##### Parameters
| Name | Type | | Name | Type |
@ -72,7 +87,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/tooltip/index.ts:57](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.ts#L57) [packages/g6/src/stdlib/plugin/tooltip/index.ts:71](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L71)
___ ___
@ -86,7 +101,7 @@ IPluginBaseConfig.graph
#### Defined in #### Defined in
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L7)
___ ___
@ -94,9 +109,11 @@ ___
• `Optional` **itemTypes**: (``"node"`` \| ``"edge"`` \| ``"combo"`` \| ``"canvas"``)[] • `Optional` **itemTypes**: (``"node"`` \| ``"edge"`` \| ``"combo"`` \| ``"canvas"``)[]
Types of items for which tooltip is allowed to be displayed
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/tooltip/index.ts:64](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.ts#L64) [packages/g6/src/stdlib/plugin/tooltip/index.ts:81](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L81)
___ ___
@ -104,9 +121,11 @@ ___
• `Optional` **loadingContent**: `string` \| `HTMLDivElement` • `Optional` **loadingContent**: `string` \| `HTMLDivElement`
Loading DOM
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/tooltip/index.ts:67](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.ts#L67) [packages/g6/src/stdlib/plugin/tooltip/index.ts:87](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L87)
___ ___
@ -114,9 +133,11 @@ ___
• `Optional` **offsetX**: `number` • `Optional` **offsetX**: `number`
Offset of tooltip in X direction
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/tooltip/index.ts:60](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.ts#L60) [packages/g6/src/stdlib/plugin/tooltip/index.ts:75](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L75)
___ ___
@ -124,9 +145,11 @@ ___
• `Optional` **offsetY**: `number` • `Optional` **offsetY**: `number`
Offset of tooltip in Y direction
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/tooltip/index.ts:61](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.ts#L61) [packages/g6/src/stdlib/plugin/tooltip/index.ts:77](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L77)
___ ___
@ -138,6 +161,8 @@ ___
▸ (`evt?`): `boolean` ▸ (`evt?`): `boolean`
Determine whether to display tooltip
##### Parameters ##### Parameters
| Name | Type | | Name | Type |
@ -150,7 +175,7 @@ ___
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/tooltip/index.ts:62](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.ts#L62) [packages/g6/src/stdlib/plugin/tooltip/index.ts:79](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L79)
___ ___
@ -158,6 +183,8 @@ ___
• `Optional` **trigger**: ``"click"`` \| ``"pointerenter"`` • `Optional` **trigger**: ``"click"`` \| ``"pointerenter"``
Event type that triggers display of tooltip
#### Defined in #### Defined in
[packages/g6/src/stdlib/plugin/tooltip/index.ts:65](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.ts#L65) [packages/g6/src/stdlib/plugin/tooltip/index.ts:83](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L83)

187
packages/site/docs/apis/interfaces/plugins/TooltipConfig.zh.md
View File

@ -2,162 +2,185 @@
title: TooltipConfig title: TooltipConfig
--- ---
[概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../. ./modules/plugins.zh.md) / TooltipConfig [概述 - v5.0.0-alpha.9](../../README.zh.md) / [模块](../../modules.zh.md) / [插件](../../modules/plugins.zh.md) / TooltipConfig
[插件](../../modules/plugins.zh.md).TooltipConfig [插件](../../modules/plugins.zh.md).TooltipConfig
＃＃ 等级制度 `TooltipConfig`接口包含以下属性：
- `IPluginBaseConfig` - `getContent`：一个可选的函数，用于获取工具提示的内容。它接受一个可选的类型为`IG6GraphEvent`的参数，并返回类型为 HTMLDivElement、字符串或 Promise（解析为 HTMLDivElement 或字符串）的值。
- `offsetX`：一个可选的数字，表示工具提示在 X 方向上的偏移量。
- `offsetY`：一个可选的数字，表示工具提示在 Y 方向上的偏移量。
- `shouldBegin`：一个可选的函数，用于确定是否应显示工具提示。它接受一个可选的类型为`IG6GraphEvent`的参数，并返回一个布尔值。
- `itemTypes`：一个可选的字符串数组，表示允许显示工具提示的项目类型。可能的值为'node'、'edge'、'combo'和'canvas'。
- `trigger`：一个可选的字符串，可以是'pointerenter'或'click'，表示触发显示工具提示的事件类型。
- `fixToNode`：一个可选的由两个数字、表示位置的字符串或未定义组成的数组，表示如何将工具提示固定到节点上。
- `loadingContent`：一个可选的 HTMLDivElement 或字符串，表示加载 DOM。
↳ **`工具提示配置`** ## 层次结构
＃＃ 特性 - `IPluginBaseConfig`
＃＃＃ 班级名称 ↳ **`TooltipConfig`**
• `可选` **类名**：`字符串` ## 属性
####继承自 ### className
IPluginBaseConfig.className • 可选 **className**：字符串
#### 定义于 #### 继承自
[packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L6) IPluginBaseConfig.className
___ #### 定义在
＃＃＃ 容器 [packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L6)
• `可选` **容器**：`字符串` \| `HTMLDivElement` ---
####继承自 ### container
IPluginBaseConfig.container • 可选 **container**：字符串 | HTMLDivElement
#### 定义于 #### 继承自
[packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L5) IPluginBaseConfig.container
___ #### 定义在
### 修复到节点 [packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L5)
• `可选` **fixToNode**: [`number`, `number`] \| `放置` ---
#### 定义于 ### fixToNode
[packages/g6/src/stdlib/plugin/tooltip/index.ts:66](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.ts) ts#L66) • 可选 **fixToNode**：[数字, 数字] | 放置方式
___ 如何将工具提示固定到节点上。
### 获取内容 #### 定义在
• `可选` **getContent**: (`evt?`: [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md)) => `string` \| `HTMLDivElement` \| `Promise`<`字符串` \| `HTMLDivElement`\> [packages/g6/src/stdlib/plugin/tooltip/index.ts:85](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L85)
#### 类型声明 ---
▸ (`evt?`): `字符串` \| `HTMLDivElement` \| `Promise`<`字符串` \| `HTMLDivElement`\> ### getContent
＃＃＃＃＃ 参数 • 可选 **getContent**：(`evt?`: [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md)) => 字符串 | HTMLDivElement | Promise<字符串 | HTMLDivElement>
| 名称 | 类型 | #### 类型声明
| :------ | :------ |
| `事件？` | [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md) |
##### 返回 ▸ (`evt?`): 字符串 | HTMLDivElement | Promise<字符串 | HTMLDivElement>
`字符串` \| `HTMLDivElement` \| `Promise`<`字符串` \| `HTMLDivElement`\> 获取工具提示内容的函数。
#### 定义于 ##### 参数
[packages/g6/src/stdlib/plugin/tooltip/index.ts:57](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.ts) ts#L57) | 名称 | 类型 |
| :----- | :-------------------------------------------------- |
| `evt?` | [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md) |
___ ##### 返回值
### 图表 字符串 | HTMLDivElement | Promise<字符串 | HTMLDivElement>
• `可选` **graph**: [`IGraph`](../graph/IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\> #### 定义在
####继承自 [packages/g6/src/stdlib/plugin/tooltip/index.ts:71](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L71)
IPluginBaseConfig.graph ---
#### 定义于 ### graph
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/types/plugin.ts#L7) • 可选 **graph**：[`IGraph`](../graph/IGraph.zh.md)<行为注册表, 主题注册表\>
___ #### 继承自
### 项目类型 IPluginBaseConfig.graph
• `可选` **itemTypes**: (``"node"`` \| ``"edge"`` \| ``"combo"`` \| ``"canvas"``)[] #### 定义在
#### 定义于 [packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/types/plugin.ts#L7)
[packages/g6/src/stdlib/plugin/tooltip/index.ts:64](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.ts) ts#L64) ---
___ ### itemTypes
### 加载内容 • 可选 **itemTypes**：(`"node"` | `"edge"` | `"combo"` | `"canvas"`)[]
• `可选` **loadingContent**：`字符串` \| `HTMLDivElement` 允许显示工具提示的项目类型。
#### 定义于 #### 定义在
[packages/g6/src/stdlib/plugin/tooltip/index.ts:67](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.ts) ts#L67) [packages/g6/src/stdlib/plugin/tooltip/index.ts:81](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L81)
___ ### loadingContent
### 偏移X • `Optional` **loadingContent**: `string` \| `HTMLDivElement`
• `可选` **offsetX**：`数字` 加载 DOM
#### 定义于 #### 定义在
[packages/g6/src/stdlib/plugin/tooltip/index.ts:60](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.ts) ts#L60) [packages/g6/src/stdlib/plugin/tooltip/index.ts:87](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L87)
___ ### offsetX
### 偏移Y • `Optional` **offsetX**: `number`
• `可选` **offsetY**：`数字` 提示工具在 X 方向上的偏移量
#### 定义于 #### 定义在
[packages/g6/src/stdlib/plugin/tooltip/index.ts:61](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.html ts#L61) [packages/g6/src/stdlib/plugin/tooltip/index.ts:75](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L75)
___ ---
### 应该开始 ### offsetY
• `可选` **shouldBegin**: (`evt?`: [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md)) => `boolean` • `Optional` **offsetY**: `number`
#### 类型声明 提示工具在 Y 方向上的偏移量
▸ (`evt?`): `布尔值` #### 定义在
＃＃＃＃＃ 参数 [packages/g6/src/stdlib/plugin/tooltip/index.ts:77](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L77)
| 名称 | 类型 | ---
| :------ | :------ |
| `事件？` | [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md) |
##### 返回 ### shouldBegin
`布尔值` • `Optional` **shouldBegin**: (`evt?`: [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md)) => `boolean`
#### 定义于 #### 类型声明
[packages/g6/src/stdlib/plugin/tooltip/index.ts:62](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.ts) ts#L62) ▸ (`evt?`): `boolean`
___ 确定是否显示提示工具
＃＃＃ 扳机 ##### 参数
• `可选` **触发**：``"点击"`` \| ``“指针输入器”`` | 名称 | 类型 |
| :----- | :-------------------------------------------------- |
| `evt?` | [`IG6GraphEvent`](../behaviors/IG6GraphEvent.zh.md) |
#### 定义于 ##### 返回
[packages/g6/src/stdlib/plugin/tooltip/index.ts:65](https://github.com/antvis/G6/blob/60905f4c6c/packages/g6/src/stdlib/plugin/tooltip/index.ts) ts#L65) `boolean`
#### 定义在
[packages/g6/src/stdlib/plugin/tooltip/index.ts:79](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L79)
---
### trigger
• `Optional` **trigger**: `"click"` \| `"pointerenter"`
触发显示提示工具的事件类型
#### 定义在
[packages/g6/src/stdlib/plugin/tooltip/index.ts:83](https://github.com/antvis/G6/blob/a69acd5592/packages/g6/src/stdlib/plugin/tooltip/index.ts#L83)

35
packages/site/docs/apis/interfaces/types-GraphData.en.md
View File

@ -1,35 +0,0 @@
[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [types](../modules/types.en.md) / GraphData
# Interface: GraphData
[types](../modules/types.en.md).GraphData
## Properties
### combos
• `Optional` **combos**: [`ComboUserModel`](../modules/types.en.md#combousermodel)[]
#### Defined in
[types/data.ts:14](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/data.ts#L14)
___
### edges
• `Optional` **edges**: [`EdgeUserModel`](../modules/types.en.md#edgeusermodel)[]
#### Defined in
[types/data.ts:13](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/data.ts#L13)
___
### nodes
• `Optional` **nodes**: [`NodeUserModel`](../modules/types.en.md#nodeusermodel)[]
#### Defined in
[types/data.ts:12](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/data.ts#L12)

35
packages/site/docs/apis/interfaces/types-GraphData.zh.md
View File

@ -1,35 +0,0 @@
[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [类型](../modules/types.zh.md ) / 图数据
# 接口：图数据
[类型](../modules/types.zh.md).GraphData
＃＃ 特性
###连击
• `可选` **组合**：[`ComboUserModel`](../modules/types.zh.md#combousermodel)[]
#### 定义于
[类型/data.ts:14](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/data.ts#L14)
___
### 边缘
• `可选` **边缘**：[`EdgeUserModel`](../modules/types.zh.md#edgeusermodel)[]
#### 定义于
[类型/data.ts:13](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/data.ts#L13)
___
### 节点
• `可选` **节点**：[`NodeUserModel`](../modules/types.zh.md#nodeusermodel)[]
#### 定义于
[类型/data.ts:12](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/data.ts#L12)

53
packages/site/docs/apis/interfaces/types-IG6GraphEvent.en.md
View File

@ -1,53 +0,0 @@
[Overview - v5.0.0-alpha.9](../README.en.md) / [Modules](../modules.en.md) / [types](../modules/types.en.md) / IG6GraphEvent
# Interface: IG6GraphEvent
[types](../modules/types.en.md).IG6GraphEvent
## Hierarchy
- `Omit`<`FederatedPointerEvent`, ``"currentTarget"``\>
↳ **`IG6GraphEvent`**
## Properties
### currentTarget
• **currentTarget**: [`IGraph`](types-IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\>
#### Defined in
[types/event.ts:42](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L42)
___
### gEvent
• **gEvent**: `Event`
Original event emitted by G
#### Defined in
[types/event.ts:46](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L46)
___
### itemId
• **itemId**: `ID`
#### Defined in
[types/event.ts:44](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L44)
___
### itemType
• **itemType**: ``"node"`` \| ``"edge"`` \| ``"combo"`` \| ``"canvas"``
#### Defined in
[types/event.ts:43](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L43)

53
packages/site/docs/apis/interfaces/types-IG6GraphEvent.zh.md
View File

@ -1,53 +0,0 @@
[概述 - v5.0.0-alpha.9](../README.zh.md) / [模块](../modules.zh.md) / [类型](../modules/types.zh.md ) / IG6GraphEvent
# 接口：IG6GraphEvent
[类型](../modules/types.zh.md).IG6GraphEvent
＃＃ 等级制度
- `省略`<`FederatedPointerEvent`, ``"currentTarget"``\>
↳ **`IG6GraphEvent`**
＃＃ 特性
### 当前目标
• **currentTarget**: [`IGraph`](types-IGraph.zh.md)<`BehaviorRegistry`, `ThemeRegistry`\>
#### 定义于
[类型/event.ts:42](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L42)
___
### gEvent
• **gEvent**：`事件`
G 发出的原始事件
#### 定义于
[类型/event.ts:46](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L46)
___
### 商品编号
• **itemId**：`ID`
#### 定义于
[类型/event.ts:44](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L44)
___
＃＃＃ 物品种类
• **itemType**：``“节点”`` \| ``“边缘”`` \| ``“组合”`` \| ``“画布”``
#### 定义于
[类型/event.ts:43](https://github.com/antvis/G6/blob/c9548251ff/packages/g6/src/types/event.ts#L43)

2293
packages/site/docs/apis/interfaces/types-IGraph.en.md
View File

File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More