Class PathSegment

constructor

• new PathSegment(type?: EnumValue, ex?: number, ey?: number, x1?: number, y1?: number, x2?: number, y2?: number | boolean, clockwise?: boolean): PathSegment

• Constructs a segment that goes nowhere unless you specify some Points.

  The very first point of a path is specified in the containing PathFigure by its PathFigure.startX and PathFigure.startY properties.

  The segment type must be one of the following values: PathSegment.Line, PathSegment.Bezier, PathSegment.QuadraticBezier, PathSegment.Arc, PathSegment.SvgArc. You will want to add a new instance of a PathSegment to the PathFigure.segments list of a PathFigure.

  Parameters

  • Optional type: EnumValue

    if not supplied, the default PathSegment type is PathSegment.Line. But if the type is supplied, one must also provide the endpoint X and Y values, either as arguments in this constructor or by setting the endX and endY properties. If the type is QuadraticBezier, the X1 and Y1 control point values must both be supplied. If the type is Bezier, X1, Y1, X2, and Y2 control point values must all be supplied.

    If the type is Line it needs the following arguments:

    (go.PathSegment.Line, ex, ey)

    • ex, ey describe the end point

    If the type is QuadraticBezier it needs the following arguments:

    (go.PathSegment.QuadraticBezier, ex, ey, x1, y1)

    • ex, ey describe the end point
    • x1, y1 describe the only control point

    If the type is Bezier it needs the following arguments:

    (go.PathSegment.Bezier, ex, ey, x1, y1, x2, y2)

    • ex, ey describe the end point
    • x1, y1 describe the first control point
    • x2, y2 describe the second control point

    If the type is Arc it needs the following arguments:

    (go.PathSegment.Arc, startAngle, sweepAngle, centerX, centerY, radiusX, radiusY)

    • startAngle describes the start angle, in degrees
    • sweepAngle describes the sweep angle, in degrees
    • centerX, centerY describe the center point
    • radiusX, radiusY describe the radiusX and radiusY

    If the type is SvgArc it needs the following arguments:

    (go.PathSegment.SvgArc, ex, ey, radiusX, radiusY, xAxisRotation, largeArcFlag, clockwiseFlag)

    They are in the same order as arcs in SVG path strings, except the endpoint x and y values come first, not last.

    • ex, ey describe the endpoint
    • radiusX, radiusY describe the radius
    • xAxisRotation describes the xAxisRotation (number in degrees)
    • largeArcFlag describes the isLargeArc (true or false)
    • clockwiseFlag describes the isClockwiseArc (true or false).

    If the type is Move it needs the following arguments:

    (go.PathSegment.Move, ex, ey)

    • ex, ey describe the next starting point

  • Optional ex: number

    optional: the X coordinate of the end point, or the startAngle of an Arc.

  • Optional ey: number

    optional: the Y coordinate of the end point, or the sweepAngle of an Arc.

  • Optional x1: number

    optional: the X coordinate of the first bezier control point, or the centerX of an Arc, or the radiusX of an SvgArc.

  • Optional y1: number

    optional: the Y coordinate of the first bezier control point, or the centerY of an Arc, or the radiusY of an SvgArc.

  • Optional x2: number

    optional: the X coordinate of the second cubic bezier control point, or the radiusX of an Arc, or the xAxisRotation of an SvgArc.

  • Optional y2: number | boolean

    optional: the Y coordinate of the second cubic bezier control point, or the radiusY of an Arc, or whether this is the larger arc of an SvgArc.

  • Optional clockwise: boolean

    optional: whether an SvgArc goes clockwise or counterclockwise.

  Returns PathSegment