@inweb/markup/src/markup/IMarkupColorable.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.
///////////////////////////////////////////////////////////////////////////////

/**
 * 2D markup colorable object interface.
 */
export interface IMarkupColorable {
  /**
   * Returns the foreground color of an object's line or text as a string in hexadecimal color syntax
   * `#RGB` using its primary color components (red, green, blue) written as hexadecimal numbers.
   */
  getColor(): string;

  /**
   * Sets the foreground color of an object's line or text.
   *
   * @param hex - Color in hexadecimal color syntax `#RGB`.
   */
  setColor(hex: string): void;
}