StrokeProfileStop

A stop of the stroke profile of a path, see path.strokeProfile: the pen that draws its stroke at an offset along the path, an ellipse with a width, an aspect and an angle. Between the stops, each of them changes along the path, easing into and out of smooth stops and in straight lines from the others, see smooth. A stop can set only some of them, and leave the others to the stops around it.

Constructors

StrokeProfileStop([object])

Creates a stroke profile stop.

Parameters:

object: Object — the properties of the stop, its offset, width, aspect, angle and smooth — optional

Returns:

StrokeProfileStop

Example:

var path = new Path.Line([20, 50], [180, 50]);
path.strokeColor = 'black';
path.strokeWidth = 10;
path.strokeProfile = [
    new StrokeProfileStop({ offset: 0, width: 0.5 }),
    new StrokeProfileStop({ offset: 160, width: 2 })
];

Properties

path

offset

The offset of the stop along its path, as in path.getPointAt(offset). Unlike the offset of gradient stops, it is a length, not a fraction. The stop stays between the same segments when they move, so its offset changes with the lengths of the curves before it.

Type:

Number

width

aspect

angle

The angle of the pen at the stop, in degrees, in the path’s coordinates. Angles aren’t wrapped: from 0 at one stop to 720 at the next, the pen turns twice. Stops without an angle leave it to the stops around them, and without any, it is 0.

Type:

Number⟋null

smooth

Whether the values ease into and out of the stop: they arrive at it and leave it flat, and between two smooth stops, a value follows a cubic from one to the other, without overshooting them. As the slopes don’t depend on other stops, changing a stop only changes the values up to the stops on either side of it. Without smoothing, the values change in straight lines to the stops on either side.

Default:

true

Type:

Boolean

Methods

clone()

equals(stop)