2023-08-30 19:46:37 +08:00
|
|
|
---
|
|
|
|
title: FisheyeConfig
|
|
|
|
---
|
|
|
|
|
|
|
|
[Overview - v5.0.0-alpha.9](../../README.en.md) / [Modules](../../modules.en.md) / [plugins](../../modules/plugins.en.md) / FisheyeConfig
|
|
|
|
|
|
|
|
[plugins](../../modules/plugins.en.md).FisheyeConfig
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
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.
|
|
|
|
|
2023-08-30 19:46:37 +08:00
|
|
|
## Hierarchy
|
|
|
|
|
|
|
|
- `IPluginBaseConfig`
|
|
|
|
|
|
|
|
↳ **`FisheyeConfig`**
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
|
|
|
### className
|
|
|
|
|
|
|
|
• `Optional` **className**: `string`
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
IPluginBaseConfig.className
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[packages/g6/src/types/plugin.ts:6](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L6)
|
2023-08-30 19:46:37 +08:00
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
---
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
### container
|
|
|
|
|
|
|
|
• `Optional` **container**: `string` \| `HTMLDivElement`
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
IPluginBaseConfig.container
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[packages/g6/src/types/plugin.ts:5](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L5)
|
2023-08-30 19:46:37 +08:00
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
---
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
### d
|
|
|
|
|
|
|
|
• `Optional` **d**: `number`
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
A number representing the magnification factor of the fisheye.
|
|
|
|
|
2023-08-30 19:46:37 +08:00
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[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)
|
2023-08-30 19:46:37 +08:00
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
---
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
### delegateStyle
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
• `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'
|
|
|
|
}`
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[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)
|
2023-08-30 19:46:37 +08:00
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
---
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
### graph
|
|
|
|
|
|
|
|
• `Optional` **graph**: [`IGraph`](../graph/IGraph.en.md)<`BehaviorRegistry`, `ThemeRegistry`\>
|
|
|
|
|
|
|
|
#### Inherited from
|
|
|
|
|
|
|
|
IPluginBaseConfig.graph
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[packages/g6/src/types/plugin.ts:7](https://github.com/antvis/G6/blob/ef7751dae9/packages/g6/src/types/plugin.ts#L7)
|
2023-08-30 19:46:37 +08:00
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
---
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
### maxD
|
|
|
|
|
|
|
|
• `Optional` **maxD**: `number`
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
A number representing the maximum value of the fisheye magnification factor.
|
|
|
|
|
2023-08-30 19:46:37 +08:00
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[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)
|
2023-08-30 19:46:37 +08:00
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
---
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
### maxR
|
|
|
|
|
|
|
|
• `Optional` **maxR**: `number`
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
A number representing the maximum value of the fisheye radius.
|
|
|
|
|
2023-08-30 19:46:37 +08:00
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[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)
|
2023-08-30 19:46:37 +08:00
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
---
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
### minD
|
|
|
|
|
|
|
|
• `Optional` **minD**: `number`
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
A number representing the minimum value of the fisheye magnification factor.
|
|
|
|
|
2023-08-30 19:46:37 +08:00
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[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)
|
2023-08-30 19:46:37 +08:00
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
---
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
### minR
|
|
|
|
|
|
|
|
• `Optional` **minR**: `number`
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
A number representing the minimum value of the fisheye radius.
|
|
|
|
|
2023-08-30 19:46:37 +08:00
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[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)
|
2023-08-30 19:46:37 +08:00
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
---
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
### r
|
|
|
|
|
|
|
|
• `Optional` **r**: `number`
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
A number representing the radius of the fisheye.
|
|
|
|
|
2023-08-30 19:46:37 +08:00
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[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)
|
2023-08-30 19:46:37 +08:00
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
---
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
### scaleDBy
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
• `Optional` **scaleDBy**: `"unset"` \| `"drag"` \| `"wheel"`
|
|
|
|
|
|
|
|
Can be `'wheel'`, `'drag'`, `'unset'`, or `undefined`, representing the scaling method for the fisheye magnification factor.
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[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)
|
2023-08-30 19:46:37 +08:00
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
---
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
### scaleRBy
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
• `Optional` **scaleRBy**: `"unset"` \| `"drag"` \| `"wheel"`
|
|
|
|
|
|
|
|
Can be `'wheel'`, `'drag'`, `'unset'`, or `undefined`, representing the scaling method for the fisheye radius.
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[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)
|
2023-08-30 19:46:37 +08:00
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
---
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
### showDPercent
|
|
|
|
|
|
|
|
• `Optional` **showDPercent**: `boolean`
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
A boolean indicating whether to show the percentage of the fisheye magnification factor.
|
|
|
|
|
2023-08-30 19:46:37 +08:00
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[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)
|
2023-08-30 19:46:37 +08:00
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
---
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
### showLabel
|
|
|
|
|
|
|
|
• `Optional` **showLabel**: `boolean`
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
A boolean indicating whether to show the label.
|
|
|
|
|
2023-08-30 19:46:37 +08:00
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[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)
|
2023-08-30 19:46:37 +08:00
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
---
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
### throttle
|
|
|
|
|
|
|
|
• `Optional` **throttle**: `number`
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
A number representing the throttle time (in milliseconds).
|
|
|
|
|
2023-08-30 19:46:37 +08:00
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[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)
|
2023-08-30 19:46:37 +08:00
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
---
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
### trigger
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
• `Optional` **trigger**: `"click"` \| `"drag"` \| `"mousemove"`
|
|
|
|
|
|
|
|
The trigger method, which can be `'mousemove'`, `'click'`, or `'drag'`.
|
2023-08-30 19:46:37 +08:00
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2023-08-31 01:43:08 +08:00
|
|
|
[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)
|