PathSegment$Typings extension

on

Properties

centerX ↔ num
Gets or sets the center X value of the Arc for a PathSegment of type PathSegment.Arc|Arc.
getter/setter pair
centerY ↔ num
Gets or sets the center Y value of the Arc for a PathSegment of type PathSegment.Arc|Arc.
getter/setter pair
endX ↔ num
Gets or sets the X coordinate of the end point for all types of PathSegment except PathSegment.Arc|Arc. The default value is zero.
getter/setter pair
endY ↔ num
Gets or sets the Y coordinate of the end point for all types of PathSegment except PathSegment.Arc|Arc. The default value is zero.
getter/setter pair
isClockwiseArc ↔ bool
Gets or sets the clockwise-flag for a PathSegment of type PathSegment.SvgArc|SvgArc. SVG Arcs specify a radius and an endpoint, and are always a portion of an ellipse. The parameters allow for two potential ellipses and four potential arcs. A clockwise-flag set to true will use one of the two possible positive-angle arcs, and false will use one of the two negative-angle arcs. Which arc is chosen (small or large) depends on the value of #isLargeArc. For more information see the visual examples in the SVG Arc specification (w3.org)
getter/setter pair
isClosed ↔ bool
Gets or sets whether the path is closed after this PathSegment. Default value is false.
getter/setter pair
isLargeArc ↔ bool
Gets or sets the large-arc-flag for a PathSegment of type PathSegment.SvgArc|SvgArc. SVG Arcs specify a radius and an endpoint, and are always a portion of an ellipse. The parameters allow for two potential ellipses and four potential arcs. A large-arc-flag set to true will choose the larger of the two arc sweeps. Which way the arc sweeps (positive angle or negative angle) depends on the value of #isClockwiseArc For more information see the visual examples in the SVG Arc specification (w3.org)
getter/setter pair
point1X ↔ num
Gets or sets the X value of the first control point for a PathSegment of type PathSegment.Bezier|Bezier or PathSegment.QuadraticBezier|QuadraticBezier.
getter/setter pair
point1Y ↔ num
Gets or sets the Y value of the first control point for a PathSegment of type PathSegment.Bezier|Bezier or PathSegment.QuadraticBezier|QuadraticBezier.
getter/setter pair
point2X ↔ num
Gets or sets the X value of the second control point for a PathSegment of type cubic PathSegment.Bezier|Bezier.
getter/setter pair
point2Y ↔ num
Gets or sets the Y value of the second control point for a PathSegment of type cubic PathSegment.Bezier|Bezier.
getter/setter pair
radiusX ↔ num
Gets or sets the X value of the radius for a PathSegment of type PathSegment.Arc|Arc or PathSegment.SvgArc|SvgArc. Value must be a positive number.
getter/setter pair
radiusY ↔ num
Gets or sets the Y value of the radius for a PathSegment of type PathSegment.Arc|Arc or PathSegment.SvgArc|SvgArc. Value must be a positive number.
getter/setter pair
startAngle ↔ num
Gets or sets the starting angle for a PathSegment of type PathSegment.Arc|Arc. Value must within the range: (0 <= value < 360).
getter/setter pair
sweepAngle ↔ num
Gets or sets the length of angle in degrees, or amount of arc to "sweep" for a PathSegment of type PathSegment.Arc|Arc. Must be between -360 and 360, inclusive.
getter/setter pair
type ↔ EnumValue
Gets or sets the type of the PathSegment. The value must be one of the following: PathSegment.Line, PathSegment.Bezier, PathSegment.QuadraticBezier, PathSegment.Arc, PathSegment.Move, PathSegment.Arc, and PathSegment.SvgArc.
getter/setter pair
xAxisRotation ↔ num
Gets or sets the X-axis rotation for a PathSegment of type PathSegment.SvgArc|SvgArc. X-axis rotation is used to rotate the ellipse that the arc is created from, and must be between 0 and 360 degrees. Default is 0.
getter/setter pair

Methods

close() → PathSegment
Closes the path after this PathSegment @return {PathSegment} returns this PathSegment.
copy() → PathSegment
Create a copy of this PathSegment, of the same type and with the same point values. @expose @return {PathSegment}
equalsApprox(PathSegment s) → bool
(undocumented) @param {PathSegment} s @return {boolean}