@inweb/markup/src/markup/IMarkupLine.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";

/**
 * Defines the type of the markup line.
 */
export type MarkupLineType = "solid" | "dot" | "dash";

/**
 * 2D markup Line object interface.
 */
export interface IMarkupLine extends IMarkupObject, IMarkupColorable {
  /**
   * Returns the coordinates of the line points as a flat array [x1, y1, x2, y2, ...].
   */
  getPoints(): number[];

  /**
   * Returns the line width.
   */
  getLineWidth(): number;

  /**
   * Sets the line width.
   */
  setLineWidth(size: number);

  /**
   * Returns the line type. Can be `solid`, `dot` or `dash`.
   */
  getLineType(): string;

  /**
   * Sets the line type.
   *
   * @param type - Line type. Can be `solid`, `dot` or `dash`.
   */
  setLineType(type: string);

  /**
   * Adds the specified points to the end of the line.
   *
   * @param points - Array of 2D points.
   */
  addPoints(points: [{ x: number; y: number }]);
}

/**
 * Defines the parameters for creating a {@link IMarkupLine | markup line}.
 */
export interface IMarkupLineParams {
  /**
   * Array of line points.
   */
  points?: { x: number; y: number }[];

  /**
   * Line type. Can be `solid`, `dot` or `dash`.
   *
   * @default "solid"
   */
  type?: MarkupLineType;

  /**
   * Line width.
   *
   * @default 4
   */
  width?: 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;
}