WeaveAlignNodesToolAction

Overview

The WeaveAlignNodesToolAction class that allows users to align selected nodes vertically or horizontally.

The class extends the WeaveAction class.

Name

This action name property value is alignNodesTools.

Import

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

Instantiation

new WeaveAlignNodesToolAction();

TypeScript types

export type WeaveAlignNodesToolActionAlignToKeys =
  keyof typeof ALIGN_NODES_ALIGN_TO;
export type WeaveAlignNodesToolActionAlignTo =
  (typeof ALIGN_NODES_ALIGN_TO)[WeaveAlignNodesToolActionAlignToKeys];

export type WeaveAlignNodesToolActionTriggerParams = {
  alignTo: WeaveAlignNodesToolActionAlignTo;
  triggerSelectionTool?: boolean;
};

Constants

export const ALIGN_NODES_ALIGN_TO = {
  ["LEFT_HORIZONTAL"]: "left-horizontal",
  ["CENTER_HORIZONTAL"]: "center-horizontal",
  ["RIGHT_HORIZONTAL"]: "right-horizontal",
  ["TOP_VERTICAL"]: "top-vertical",
  ["CENTER_VERTICAL"]: "center-vertical",
  ["BOTTOM_VERTICAL"]: "bottom-vertical",
} as const;

Trigger function params

trigger(cancelAction: () => void, params?: WeaveAlignNodesToolActionTriggerParams): void;

For WeaveAlignNodesToolActionTriggerParams:

Prop	Type	Default
`triggerSelectionTool`	`boolean`	-
`alignTo`	`WeaveAlignNodesToolActionAlignTo`	-