Type Alias Path

bbox

• bbox(): RectPositioned

  Gets smallest box that encloses path

  Returns RectPositioned

distanceToPoint

• distanceToPoint(point: Point): number

  Distance from start of path to this point. If path is closed (eg. a circle) it may have some arbitary 'start' point

  Parameters

  • point: Point

  Returns number

interpolate

• interpolate(t: number): Point

  Returns a point at a relative (0.0-1.0) position along the path

  Inverse of relativePosition.

  Parameters

  • t: number

    Relative position (0.0-1.0)

  Returns Point

  Point

length

• length(): number

  Length of path

  Returns number

nearest

• nearest(point: Point): Point

  Returns the nearest point on path to point

  Parameters

  • point: Point

  Returns Point

relativePosition

• relativePosition(point: Point, intersectionThreshold: number): number

  Returns relative position of point along path. If pt is same as start, result will be 0, if it's the same as end, it will be 1.

  Inverse of interpolate.

  Parameters

  • point: Point
  • intersectionThreshold: number

  Returns number

toString

• toString(): string

  Returns a string representation of pth values

  Returns string

toSvgString

• toSvgString(): readonly string[]

  Returns an array of SVG segments that can render path

  Returns readonly string[]

Readonlykind