UNPKG

@inweb/markup

Version:
108 lines (93 loc) 2.98 kB
/////////////////////////////////////////////////////////////////////////////// // 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 Ellipse object interface. */ export interface IMarkupEllipse extends IMarkupObject, IMarkupColorable { /** * Returns the screen coordinates of the center point (position) of the ellipse. */ getPosition(): { x: number; y: number }; /** * Sets the screen coordinates of the top-left point (position) of the ellipse. */ setPosition(x: number, y: number): void; /** * Returns the X radius of the ellipse. */ getRadiusX(): number; /** * Sets the X radius of the ellipse. */ setRadiusX(r: number): void; /** * Returns the Y radius of the ellipse. */ getRadiusY(): number; /** * Sets the X radius of the ellipse. */ setRadiusY(r: number): void; /** * Returns the line width of the ellipse. */ getLineWidth(): number; /** * Sets the line width of the ellipse. */ setLineWidth(size: number): void; } /** * Defines the parameters for creating a {@link IMarkupEllipse | markup ellipse}. */ export interface IMarkupEllipseParams { /** * Screen coordinates of the center point (position) of the ellipse. */ position?: { x: number; y: number }; /** * Screen radius of the ellipse along the X and Y axes. * * @default 25 */ radius?: { x: number; y: number }; /** * Line width. * * @default 4 */ lineWidth?: 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; }