StrokeOptions

Public Interface

Table of Contents

The options object for getStroke or getStrokePoints.

Signature
interface StrokeOptions {}

Properties

easing

Public PropertySignature

An easing function to apply to each point's pressure.

Signature
easing?: (pressure: number) => number

end

Public PropertySignature

Cap, taper and easing for the end of the line.

Signature
end?: {
  cap?: boolean
  taper?: boolean | number
  easing?: (distance: number) => number
}

last

Public PropertySignature

Whether to handle the points as a completed stroke.

Signature
last?: boolean

simulatePressure

Public PropertySignature

Whether to simulate pressure based on velocity.

Signature
simulatePressure?: boolean

size

Public PropertySignature

The base size (diameter) of the stroke.

Signature
size?: number

smoothing

Public PropertySignature

How much to soften the stroke's edges.

Signature
smoothing?: number

start

Public PropertySignature

Cap, taper and easing for the start of the line.

Signature
start?: {
  cap?: boolean
  taper?: boolean | number
  easing?: (distance: number) => number
}

streamline

Public PropertySignature

Signature
streamline?: number

thinning

Public PropertySignature

The effect of pressure on the stroke's size.

Signature
thinning?: number

Edit this page
Last edited on 11 May 2023
snapAngleStrokePoint