Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace path

Index

Functions

Functions

addTo

  • addTo(childPath: IPath, parentModel: IModel, pathId: string, overwrite?: boolean): IPath

  • 添加模型的路径。

    parentModel.paths[pathId] = childPath;

    Parameters

    • childPath: IPath

      The path to add.

    • parentModel: IModel

      The model to add to.

    • pathId: string

      The id of the path.

    • Default value overwrite: boolean = false

    Returns IPath

    The original path (for cascading).

alterLength

  • alterLength(pathToAlter: IPath, distance: number, useOrigin?: boolean): IPath

  • 通过延长或缩短路径来更改路径.

    Parameters

    • pathToAlter: IPath

      Path to alter.

    • distance: number

      要在路径中添加或删除的长度数字量。使用正数延长，负数缩短。缩短时：此函数不会更改路径，如果生成的路径长度小于或等于零，则返回 null.

    • Default value useOrigin: boolean = false

      可选标志，用于从起点而不是路径末尾更改.

    Returns IPath

    原始路径（用于级联），如果无法更改路径，则为 null.

breakAtPoint

  • 将一条路径一分为二。提供的路径将在提供的中断点处结束, 返回一条新路径，该路径从 pointOfBreak 开始，到提供的路径的初始终点结束. 对于 Circle，原始路径将就地转换为 Arc，并返回 null.

    Parameters

    • pathToBreak: IPath

      The path to break.

    • pointOfBreak: IPoint

      The point at which to break the path.

    Returns IPath

    当路径类型为直线或圆弧时，相同类型的新路径。为圆返回空值.

center

  • 将路径居中位于 [0， 0].

    Parameters

    • pathToCenter: IPath

      The path to center.

    Returns IPath

    The original path (for cascading).

clone

  • 创建路径的克隆。这比克隆对象更快.

    Parameters

    • pathToClone: IPath

      The path to clone.

    • Optional offset: IPoint

      可选点移动路径相对距离.

    Returns IPath

    Cloned path.

converge

  • 在斜率交点连接 2 条线.

    Parameters

    • lineA: IPathLine

      First line to converge.

    • lineB: IPathLine

      Second line to converge.

    • Optional useOriginA: boolean

      用于线 A 的起点而不是终点的可选标志.

    • Optional useOriginB: boolean

      用于线 B 的起点而不是终点的可选标志.

    Returns IPoint

    point of convergence.

copyProps

  • 将一个路径的属性复制到另一个路径.

    Parameters

    • srcPath: IPath

      The source path to copy property values from.

    • destPath: IPath

      The destination path to copy property values to.

    Returns IPath

    The source path.

data

  • 设置路径的属性数据。

    pathContext.data = data;

    Parameters

    Returns IPath

    The original path (for cascading).

distort

  • 扭曲路径 - 分别缩放 x 和 y.

    Parameters

    • pathToDistort: IPath

      The path to distort.

    • scaleX: number

      x 缩放量.

    • scaleY: number

      y 缩放量.

    Returns IModel | IPath

    新的IModel（用于圆和弧）或IPath（用于线和贝塞尔曲线）.

dogbone

  • 在 2 条线之间的外角添加一个圆角。这些线必须在一个点相遇。

    Parameters

    • lineA: IPathLine

      圆角的第一行，将对其进行修改以适合圆角.

    • lineB: IPathLine

      圆角的第二条线，将对其进行修改以适合圆角.

    • filletRadius: number
    • Optional options: IPointMatchOptions

    Returns IPathArc

    新圆角的弧形路径对象.

expand

  • expand(pathToExpand: IPath, expansion: number, isolateCaps?: boolean): IModel

  • 通过创建围绕路径的模型来扩展路径.

    Parameters

    • pathToExpand: IPath

      Path to expand.

    • expansion: number

      Distance to expand.

    • Optional isolateCaps: boolean

      可选标志，用于将end caps放入名为“caps”的单独模型中.

    Returns IModel

    Model which surrounds the path.

fillet

  • 在 2 条路径之间的内角添加一个圆角。路径必须在一个点相遇。

    Parameters

    • pathA: IPath

      圆角的第一个路径，将对其进行修改以适合圆角.

    • pathB: IPath

      第二条路径到圆角，将对其进行修改以适合圆角.

    • filletRadius: number

      圆角半径.

    • Optional options: IPointMatchOptions

      可选的 IPointMatchOptions 对象，用于指定 pointMatchingDistance.

    Returns IPathArc

    新圆角的弧形路径对象.

intersection

  • 查找 2 条路径相交的点.

    Parameters

    • path1: IPath

      找到交叉点的第一条路径.

    • path2: IPath

      寻找交叉点的第二条路径.

    • Default value options: IPathIntersectionOptions = {}

      可选 IPath 交集选项.

    Returns IPathIntersection

    IPath交集对象，具有交点（和角度，当路径是弧形或圆时）;如果路径不相交，则为 null.

layer

  • 设置路径图层.

    pathContext.layer = layer;

    Parameters

    • pathContext: IPath

      The path to set the layer.

    • layer: string

      The layer name.

    Returns IPath

    The original path (for cascading).

mirror

  • mirror(pathToMirror: IPath, mirrorX: boolean, mirrorY: boolean): IPath

  • 创建路径的克隆，在 x 轴和 y 轴上或两个轴上镜像.

    Parameters

    • pathToMirror: IPath

      The path to mirror.

    • mirrorX: boolean

      Boolean to mirror on the x axis.

    • mirrorY: boolean

      Boolean to mirror on the y axis.

    Returns IPath

    Mirrored path.

move

  • 将路径移动到绝对点.

    Parameters

    • pathToMove: IPath

      The path to move.

    • origin: IPoint

      The new origin for the path.

    Returns IPath

    The original path (for cascading).

moveRelative

  • 按相对量移动路径的原点.

    Parameters

    • pathToMove: IPath

      The path to move.

    • delta: IPoint

      作为点对象的 x 和 y 调整.

    • Optional subtract: boolean

      可选的布尔值减去而不是加法.

    Returns IPath

    The original path (for cascading).

moveTemporary

  • moveTemporary(pathsToMove: IPath[], deltas: IPoint[], task: Function): void

  • 在任务执行期间临时相对移动一些路径，然后取消移动它们.

    Parameters

    • pathsToMove: IPath[]

      The paths to move.

    • deltas: IPoint[]

      The x & y adjustments as a point object array.

    • task: Function

      The function to call while the paths are temporarily moved.

    Returns void

rotate

  • rotate(pathToRotate: IPath, angleInDegrees: number, rotationOrigin?: IPoint): IPath

  • 旋转路径.

    Parameters

    • pathToRotate: IPath

      The path to rotate.

    • angleInDegrees: number

      旋转量，以度为单位.

    • Default value rotationOrigin: IPoint = [0, 0]

      旋转中心点.

    Returns IPath

    The original path (for cascading).

scale

  • 缩放路径.

    Parameters

    • pathToScale: IPath

      The path to scale.

    • scaleValue: number

      缩放量.

    • Optional basePoint: IPoint

      缩放的基点.

    Returns IPath

    The original path (for cascading).

straighten

  • straighten(arc: IPathArc, bevel?: boolean, prefix?: string, close?: boolean): IModel

  • 使用直线表示弧.

    Parameters

    • arc: IPathArc

      要拉直的圆弧对象.

    • Optional bevel: boolean

      可选标志，用于倾斜角度以防止其过于尖锐.

    • Optional prefix: string

      要应用于路径 ID 的可选字符串前缀.

    • Optional close: boolean

      可选标志，用于通过连接端点创建闭合几何图形.

    Returns IModel

    Model of straight lines with same endpoints as the arc.

toKeyPoints

  • toKeyPoints(pathContext: IPath, maxArcFacet?: number): IPoint[]

  • 沿路径获取关键点（最少数量的点）.

    Parameters

    • pathContext: IPath

      Path to get points from.

    • Optional maxArcFacet: number

      圆弧或圆上点之间的可选最大长度.

    Returns IPoint[]

    Array of points which are on the path.

toPoints

  • toPoints(pathContext: IPath, numberOfPoints: number): IPoint[]

  • 沿路径获取点.

    Parameters

    • pathContext: IPath

      Path to get points from.

    • numberOfPoints: number

      划分路径的点数.

    Returns IPoint[]

    路径上的点数组以均匀的间隔分布.

zero

  • 移动路径，使其边界框从 [0， 0] 开始.

    Parameters

    • pathToZero: IPath

      The path to zero.

    Returns IPath

    The original path (for cascading).

Generated using TypeDoc