WeaveStrokeNode | Weave.js

Overview

The WeaveStrokeNode class represents a multi-point continuous line or path on the Weave.js canvas. It is a versatile and essential node type for building tools like freehand drawing.

Built on top of Konva’s Shape class shape under the hood, the WeaveStrokeNode offers full control over the line’s geometry, style, and behavior—all synchronized in real time across users.

The class extends the WeaveNode class

Type

This node nodeType property value is stroke.

Import

import { WeaveStrokeNode } from "@inditextech/weave-sdk";

Instantiation

new WeaveStrokeNode(params?: WeaveStrokeNodeParams);

TypeScript types

type WeaveNodeTransformerProperties = Konva.TransformerConfig;

type WeaveStrokeProperties = {
  splineResolution: number; // Spline resolution
  resamplingSpacing: number; // Spacing for resampling points
  transform?: WeaveNodeTransformerProperties;
};

type WeaveStrokeNodeParams = {
  config: Partial<WeaveStrokeProperties>;
};

type WeaveStrokePoint = {
  x: number;
  y: number;
  pressure: number;
};

Parameters

For WeaveStrokeNodeParams:

Property Type Required Description

Property	Type	Required	Description
`config`	`Partial<WeaveStrokeNodeParams>`	Required	Config parameters for the node.

config

Partial<WeaveStrokeNodeParams>

Required

Config parameters for the node.

For WeaveStrokeNodeParams:

Property Type Required Default Description

Property	Type	Required	Default	Description
`splineResolution`	`number`		`8`	Resolution of the interpolated spline to smooth the curve

splineResolution

number

8

Resolution of the interpolated spline to smooth the curve

Default values

const WEAVE_STROKE_NODE_DEFAULT_CONFIG = {
  splineResolution: 8,
  resamplingSpacing: 2,
};