Range

PreviousNext

Plate 文档中范围（Range）的 API 参考。

Range（范围）是一组指向 Plate 文档特定跨度的点集合。它可以定义单个节点内的范围，也可以跨越多个节点。一个范围由两个点组成：锚点（起点）和焦点（终点）。

type TRange = {
  anchor: Point
  focus: Point
}

RangeAPI

transform

通过操作转换范围。

Parameters

  • range TRange

    要转换的范围。

  • op Operation

    应用于范围的操作。

  • options optional RangeTransformOptions

    范围转换的选项。

OptionsRangeTransformOptions

Collapse all

  • affinity optional RangeDirection | null

    转换范围时首选的方向。

ReturnsTRange | null

    转换后的范围，如果范围被删除则返回 null。

edges

获取范围的起点和终点。

Parameters

Collapse all

  • range TRange

    要获取边界的范围。

  • options optional RangeEdgesOptions

    获取边界的选项。

OptionsRangeEdgesOptions

Collapse all

  • reverse optional boolean

    如果为 true，则以相反顺序返回点。

Returns[Point, Point]

    表示起点和终点的点元组。

end

获取范围的终点。

Parameters

Collapse all

  • range TRange

    要获取终点的范围。

ReturnsPoint

    范围的终点。

equals

检查两个范围是否完全相等。

Parameters

Collapse all

  • range TRange

    要比较的第一个范围。

  • another TRange

    要比较的第二个范围。

Returnsboolean

    如果范围完全相等则为 true。

includes

检查范围是否包含路径、点或另一个范围的部分。

Parameters

Collapse all

  • range TRange

    要检查的范围。

  • target Path | Point | TRange

    要检查是否包含的目标。

Returnsboolean

    如果范围包含目标则为 true。

intersection

获取两个范围的交集。

Parameters

Collapse all

  • range TRange

    第一个范围。

  • another TRange

    第二个范围。

ReturnsTRange | null

    交集范围，如果没有交集则返回 null。

isBackward

检查范围是否为反向（锚点出现在焦点之后）。

Parameters

Collapse all

  • range TRange

    要检查的范围。

Returnsboolean

    如果范围为反向则为 true。

isCollapsed

检查范围是否折叠（两个点指向同一位置）。

Parameters

Collapse all

  • range optional TRange | null

    要检查的范围。

Returnsboolean

    如果范围存在且折叠则为 true。

isExpanded

检查范围是否展开（未折叠）。

Parameters

Collapse all

  • range optional TRange | null

    要检查的范围。

Returnsboolean

    如果范围存在且展开则为 true。

isForward

检查范围是否为正向（锚点出现在焦点之前）。

Parameters

Collapse all

  • range TRange

    要检查的范围。

Returnsboolean

    如果范围为正向则为 true。

isRange

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

Parameters

Collapse all

  • value any

    要检查的值。

Returnsboolean

    如果值是范围则为 true。

points

遍历范围内的所有点条目。

Parameters

Collapse all

  • range TRange

    要遍历的范围。

ReturnsGenerator<PointEntry, void, undefined>

    生成点条目的生成器。

start

获取范围的起点。

Parameters

Collapse all

  • range TRange

    要获取起点的范围。

ReturnsPoint

    范围的起点。

surrounds

检查范围是否完全包围另一个范围。

Parameters

Collapse all

  • range TRange

    可能包围目标的范围。

  • target TRange

    可能被包围的目标范围。

Returnsboolean

    如果范围包围目标则为 true。

类型

TRange

TRange 对象是一组指向 Plate 文档特定跨度的点集合。它可以定义单个节点内的范围，也可以跨越多个节点。

Range 是 TRange 的类型别名。

Attributes

Collapse all

  • anchor Point

    范围的起点。

  • focus Point

    范围的终点。

PointRange