mirror of
https://github.com/toeverything/AFFiNE.git
synced 2026-02-12 12:28:42 +00:00
docs(editor): scaffolding docs generator (#10925)
This commit is contained in:
@@ -0,0 +1,54 @@
|
||||
[**@blocksuite/block-std**](../../../../@blocksuite/block-std/README.md)
|
||||
|
||||
***
|
||||
|
||||
[BlockSuite API Documentation](../../../../README.md) / [@blocksuite/block-std](../../README.md) / [gfx](../README.md) / PointTestOptions
|
||||
|
||||
# Interface: PointTestOptions
|
||||
|
||||
The options for the hit testing of a point.
|
||||
|
||||
## Properties
|
||||
|
||||
### hitThreshold?
|
||||
|
||||
> `optional` **hitThreshold**: `number`
|
||||
|
||||
The threshold of the hit test. The unit is pixel.
|
||||
|
||||
***
|
||||
|
||||
### ignoreTransparent?
|
||||
|
||||
> `optional` **ignoreTransparent**: `boolean`
|
||||
|
||||
If true, the transparent area of the element will be ignored during the point inclusion test.
|
||||
Otherwise, the transparent area will be considered as filled area.
|
||||
|
||||
Default is true.
|
||||
|
||||
***
|
||||
|
||||
### responsePadding?
|
||||
|
||||
> `optional` **responsePadding**: \[`number`, `number`\]
|
||||
|
||||
The padding of the response area for each element when do the hit testing. The unit is pixel.
|
||||
The first value is the padding for the x-axis, and the second value is the padding for the y-axis.
|
||||
|
||||
***
|
||||
|
||||
### useElementBound?
|
||||
|
||||
> `optional` **useElementBound**: `boolean`
|
||||
|
||||
If true, the element bound will be used for the hit testing.
|
||||
By default, the response bound will be used.
|
||||
|
||||
***
|
||||
|
||||
### zoom?
|
||||
|
||||
> `optional` **zoom**: `number`
|
||||
|
||||
The zoom level of current view when do the hit testing.
|
||||
Reference in New Issue
Block a user