@inweb/markup/src/markup/IMarkupArrow.ts

JavaScript 2D markups

///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
//   This application incorporates Open Design Alliance software pursuant to a
//   license agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

import { IMarkupObject } from "./IMarkupObject";
import { IMarkupColorable } from "./IMarkupColorable";

/**
 * 2D markup Arrow object interface.
 */
export interface IMarkupArrow extends IMarkupObject, IMarkupColorable {
  /**
   * Returns the coordinales of the start and end points of arrow.
   */
  getPoints(): { x: number; y: number }[];

  /**
   * Sets the coordinales of the start and end points of the arrow.
   *
   * @param {{ x: number; y: number }} points - Array of points.
   */
  setPoints(points: { x: number; y: number }[]): void;

  /**
   * Returns the coordinales of the start point of arrow.
   */
  getStartPoint(): { x: number; y: number };

  /**
   * Sets the coordinales of the start point of the arrow.
   */
  setStartPoint(x: number, y: number): void;

  /**
   * Returns the coordinales of the end point of arrow.
   */
  getEndPoint(): { x: number; y: number };

  /**
   * Sets the coordinales of the end point of the arrow.
   */
  setEndPoint(x: number, y: number): void;
}

/**
 * Defines the parameters for creating a {@link IMarkupArrow | markup arrow}.
 */
export interface IMarkupArrowParams {
  /**
   * Coordinales of the start point of arrow.
   */
  start?: { x: number; y: number };

  /**
   * Coordinales of the end point of arrow.
   */
  end?: { x: number; y: number };

  /**
   * Line color as a string in hexadecimal color syntax `#RGB` color using its primary color components
   * (red, green, blue) written as hexadecimal numbers.
   *
   * @default "#ff0000"
   */
  color?: string;

  /**
   * Internal markup object identifier.
   */
  id?: string;
}