Point

PreviousNext

Plate 文档中点的 API 参考。

Point 表示 Plate 文档中的特定位置。它由指向文本节点的路径和该文本节点内容中的偏移量组成。

type Point = {
  path: Path
  offset: number
}

PointAPI

get

从位置获取点。

Parameters

  • at optional At | null

    要获取点的位置。可以是 TRange、Point 或 Path。

  • options optional object

    获取点的附加选项。

Optionsobject

Collapse all

  • focus optional boolean

    如果为 true 且位置是范围，则返回焦点点而非锚点。

ReturnsPoint | undefined

    指定位置的点，如果未找到则返回 undefined。

transform

通过操作变换点。

Parameters

Collapse all

  • point Point

    要变换的点。

  • op Operation

    要应用的操作。

  • options optional PointTransformOptions

    变换点的选项。

OptionsPointTransformOptions

Collapse all

  • affinity optional TextDirection | null

    变换点时首选的方向。

ReturnsPoint | null

    变换后的点，如果点被删除则返回 null。

compare

比较两个点。

Parameters

Collapse all

  • point Point

    要比较的第一个点。

  • another Point

    要比较的第二个点。

Returns-1 | 0 | 1

    如果第一个点在前面返回 -1，相同位置返回 0，在后面返回 1。

equals

检查两个点是否完全相等。

Parameters

Collapse all

  • point Point

    要比较的第一个点。

  • another Point

    要比较的第二个点。

Returnsboolean

    如果点相等返回 true，否则返回 false。

isAfter

检查一个点是否在另一个点之后。

Parameters

Collapse all

  • point Point

    要检查的点。

  • another Point

    要比较的点。

Returnsboolean

    如果第一个点在第二个点之后返回 true。

isBefore

检查一个点是否在另一个点之前。

Parameters

Collapse all

  • point Point

    要检查的点。

  • another Point

    要比较的点。

Returnsboolean

    如果第一个点在第二个点之前返回 true。

isPoint

检查值是否实现了 Point 接口。

Parameters

Collapse all

  • value any

    要检查的值。

Returnsboolean

    如果值是点则返回 true。

类型

Point

点表示 Plate 文档中的特定位置。

Attributes

Collapse all

  • offset number

    文本节点中字符的索引。

  • path Path

    指向文本节点的路径。

PointEntry

点条目在迭代属于范围的 Point 对象时返回。

Attributes

Collapse all

  • [0] Point

    点位置。

  • [1] 'anchor' | 'focus'

    指示此点是范围的锚点还是焦点。

PathPoint