WeaveMeasureToolAction

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:

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

For WeaveMeasureToolActionProperties:

Prop	Type	Default
`style.stroke?`	`string`	`#FF3366`

Default values

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