WeaveLineToolAction

Overview

The WeaveLineToolAction class that allows users to draw a precise, vector-based line by click-and-drag to define the line.

The line becomes a WeaveLineNode, synced in real time across all collaborators.

The class extends the WeaveAction class.

Name

This action name property value is lineTool.

Import

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

Instantiation

new WeaveLineToolAction(params?: WeaveLineToolActionParams);

TypeScript types

type WeaveLineToolActionProperties = {
  snapAngles: {
    angles: number[]; // Angles for snapping in degrees
    activateThreshold: number;
    releaseThreshold: number;
  };
};

type WeaveLineToolActionParams = {
  config: Partial<WeaveLineToolActionProperties>;
};

Parameters

For WeaveLineToolActionParams:

Prop	Type	Default
`config`	`Partial<WeaveLineToolActionProperties>`	-

For WeaveLineToolActionProperties:

Prop	Type	Default
`snapAngles.releaseThreshold?`	`number`	`10`
`snapAngles.activateThreshold?`	`number`	`5`
`snapAngles.angles?`	`number`	`10`

Default values

const LINE_TOOL_DEFAULT_CONFIG = {
  snapAngles: {
    angles: [0, 45, 90, 135, 180, 225, 270, 315],
    activateThreshold: 5,
    releaseThreshold: 10,
  },
};