Back to Plate

位置(Location)

docs/api/slate/location.cn.mdx

1.0.02.0 KB
Original Source

位置(Location)可以是路径(Path)、点(Point)或范围(Range)。方法通常会接受位置参数,而不仅限于路径、点或范围。

typescript
type TLocation = Path | Point | TRange

LocationApi

isAt

检查一个值是否实现了At接口。

<API name="isAt"> <APIParameters> <APIItem name="value" type="any"> 要检查的值。 </APIItem> </APIParameters> <APIReturns type="boolean"> 如果是位置或节点则返回`true`。 </APIReturns> </API>

isLocation

检查一个值是否实现了TLocation接口。

<API name="isLocation"> <APIParameters> <APIItem name="value" type="any"> 要检查的值。 </APIItem> </APIParameters> <APIReturns type="boolean"> 如果是`Path`、`Point`或`TRange`则返回`true`。 </APIReturns> </API>

isSpan

检查一个值是否实现了Span接口。

<API name="isSpan"> <APIParameters> <APIItem name="value" type="any"> 要检查的值。 </APIItem> </APIParameters> <APIReturns type="boolean"> 如果是有效的`Span`则返回`true`。 </APIReturns> </API>

类型

TLocation

LocationTLocation的类型别名。

<API name="TLocation"> <APIAttributes> <APIItem name="Path" type="Path"> 表示节点位置的数字数组。 </APIItem> <APIItem name="Point" type="Point"> 包含`path`和`offset`的对象。 </APIItem> <APIItem name="TRange" type="TRange"> 包含`anchor`和`focus`的对象。 </APIItem> </APIAttributes> </API>

Span

<API name="Span"> <APIAttributes> <APIItem name="[0]" type="Path"> 起始路径。 </APIItem> <APIItem name="[1]" type="Path"> 结束路径。 </APIItem> </APIAttributes> </API>