Weave.js
prerelease Prerelease 5.2.2 Latest 5.2.1
↑↓ navigate · ↵ select · esc close
Weave.js
Weave.js
prerelease Prerelease 5.2.2 Latest 5.2.1

WeaveMeasureToolAction

Add measure nodes to the canvas

Overview

The WeaveMeasureToolAction class that allows users to add measure to the canvas by click-and-click to define the measure points.

The class extends the WeaveAction class.

Name

This action name property value is measureTool.

Import

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

Instantiation

new WeaveMeasureToolAction(params?: WeaveMeasureToolActionParams);

TypeScript types

type WeaveMeasureToolActionStateKeys = keyof typeof MEASURE_TOOL_STATE;
type WeaveMeasureToolActionState =
  (typeof MEASURE_TOOL_STATE)[WeaveMeasureToolActionStateKeys];

type WeaveMeasureToolProperties = {
  style: {
    stroke: string;
  };
};

type WeaveMeasureToolParams = {
  config: DeepPartial<WeaveMeasureToolProperties>;
};

Parameters

For WeaveMeasureToolActionParams:

Property Type Required Description

config

Partial<WeaveMeasureToolActionProperties>

Required

Config parameters for the tool.

For WeaveMeasureToolActionProperties:

Property Type Required Default Description

style.stroke

string

#FF3366

Color for the crosshair cursor

Default values

const WEAVE_MEASURE_TOOL_DEFAULT_CONFIG: WeaveMeasureToolProperties = {
  style: {
    stroke: "#FF3366",
  },
};