Class AcDbEllipse

Represents an ellipse entity in AutoCAD.

An ellipse is a 2D geometric object defined by its center point, major and minor axes, and optional start and end angles. Ellipses are curved shapes that can be used to create elliptical shapes in drawings. The ellipse is always drawn in the plane defined by its normal vector.

Example

// Create a full ellipse
const ellipse = new AcDbEllipse(
  new AcGePoint3d(0, 0, 0),
  AcGeVector3d.Z_AXIS,
  AcGeVector3d.X_AXIS,
  10, // major axis radius
  5,  // minor axis radius
  0,  // start angle
  2 * Math.PI // end angle (full ellipse)
);

// Access ellipse properties
console.log(`Center: ${ellipse.center}`);
console.log(`Major radius: ${ellipse.majorAxisRadius}`);
console.log(`Minor radius: ${ellipse.minorAxisRadius}`);

Hierarchy (View Summary)

Constructors

constructor

Accessors

attrs center closed color database geometricExtents layer lineStyle lineType linetypeScale lineWeight majorAxisRadius minorAxisRadius normal objectId ownerId rgbColor transparency type visibility

Methods

close draw getAttr getAttrWithoutException getLayerColor setAttr subGetGripPoints subGetOsnapPoints transformBy triggerModifiedEvent

Constructors

constructor

  • new AcDbEllipse(
        center: AcGeVectorLike,
        normal: AcGeVector3dLike,
        majorAxis: AcGeVector3dLike,
        majorAxisRadius: number,
        minorAxisRadius: number,
        startAngle: number,
        endAngle: number,
    ): AcDbEllipse

  • Creates a new ellipse entity.

    This constructor creates an ellipse using the specified center point, normal vector, major axis, and radii. The center point must be in World Coordinate System (WCS) coordinates.

    Parameters

    • center: AcGeVectorLike

      The center point of the ellipse in WCS coordinates

    • normal: AcGeVector3dLike

      The normal vector defining the plane of the ellipse

    • majorAxis: AcGeVector3dLike

      The major axis vector in WCS coordinates

    • majorAxisRadius: number

      The radius of the major axis (must be positive)

    • minorAxisRadius: number

      The radius of the minor axis (must be positive)

    • startAngle: number

      The starting angle in radians (0 to 2π)

    • endAngle: number

      The ending angle in radians (0 to 2π)

    Returns AcDbEllipse

    Example

    // Create a full ellipse in the XY plane
    const fullEllipse = new AcDbEllipse(
      new AcGePoint3d(0, 0, 0),
      AcGeVector3d.Z_AXIS,
      AcGeVector3d.X_AXIS,
      20, // major radius
      10, // minor radius
      0,
      2 * Math.PI
    );

    // Create a quarter ellipse
    const quarterEllipse = new AcDbEllipse(
      new AcGePoint3d(10, 20, 0),
      AcGeVector3d.Z_AXIS,
      AcGeVector3d.X_AXIS,
      15,
      8,
      0,
      Math.PI / 2
    );

Accessors

attrs

center

closed

  • get closed(): boolean

  • Gets whether this ellipse is closed.

    An ellipse is considered closed if the start and end angles are the same (forming a complete ellipse).

    Returns boolean

    True if the ellipse is closed (forms a complete ellipse), false otherwise

color

database

  • get database(): AcDbDatabase

  • Gets the database in which this object is resident.

    When an object isn't added to a database, this property returns the current working database. After it is added to a database, it will be set automatically. You should never set this value manually.

    Returns AcDbDatabase

    The database this object belongs to

    Example

    const db = obj.database;
  • set database(db: AcDbDatabase): void

  • Sets the database for this object.

    This is typically set automatically when the object is added to a database. Manual setting should be avoided unless you know what you're doing.

    Parameters

    Returns void

    Example

    obj.database = myDatabase;

geometricExtents

  • get geometricExtents(): AcGeBox3d

  • Gets the geometric extents (bounding box) of this ellipse.

    Returns AcGeBox3d

    The bounding box that encompasses the entire ellipse

    Example

    const extents = ellipse.geometricExtents;
    console.log(`Ellipse bounds: ${extents.minPoint} to ${extents.maxPoint}`);

layer

  • get layer(): string

  • Gets the name of the layer referenced by this entity.

    Returns string

    The layer name

    Example

    const layerName = entity.layer;
  • set layer(value: string): void

  • Sets the name of the layer for this entity.

    Parameters

    • value: string

      The new layer name

    Returns void

    Example

    entity.layer = 'MyLayer';

ProtectedlineStyle

  • get lineStyle(): AcGiLineStyle

  • Gets the line style for this entity.

    This method returns the line style based on the entity's linetype and other properties.

    Returns AcGiLineStyle

    The line style object

    Example

    const lineStyle = entity.lineStyle;

lineType

  • get lineType(): string

  • Gets the name of the line type referenced by this entity.

    Returns string

    The linetype name

    Example

    const lineType = entity.lineType;
  • set lineType(value: string): void

  • Sets the name of the line type for this entity.

    Parameters

    • value: string

      The new linetype name

    Returns void

    Example

    entity.lineType = 'DASHED';

linetypeScale

  • get linetypeScale(): number

  • Gets the line type scale factor of this entity.

    When an entity is first instantiated, its line type scale is initialized to an invalid value. When the entity is added to the database, if a linetype scale has not been specified for the entity, it is set to the database's current line type scale value.

    Returns number

    The linetype scale factor

    Example

    const scale = entity.linetypeScale;
  • set linetypeScale(value: number): void

  • Sets the line type scale factor for this entity.

    Parameters

    • value: number

      The new linetype scale factor

    Returns void

    Example

    entity.linetypeScale = 2.0;

lineWeight

  • get lineWeight(): number

  • Gets the line weight used by this entity.

    Returns number

    The line weight value

    Example

    const weight = entity.lineWeight;
  • set lineWeight(value: number): void

  • Sets the line weight for this entity.

    Parameters

    • value: number

      The new line weight value

    Returns void

    Example

    entity.lineWeight = 2;

majorAxisRadius

  • get majorAxisRadius(): number

  • Gets the major axis radius of this ellipse.

    Returns number

    The major axis radius value

    Example

    const majorRadius = ellipse.majorAxisRadius;
    console.log(`Major radius: ${majorRadius}`);
  • set majorAxisRadius(value: number): void

  • Sets the major axis radius of this ellipse.

    Parameters

    • value: number

      The new major axis radius value (must be positive)

    Returns void

    Example

    ellipse.majorAxisRadius = 25;

minorAxisRadius

  • get minorAxisRadius(): number

  • Gets the minor axis radius of this ellipse.

    Returns number

    The minor axis radius value

    Example

    const minorRadius = ellipse.minorAxisRadius;
    console.log(`Minor radius: ${minorRadius}`);
  • set minorAxisRadius(value: number): void

  • Sets the minor axis radius of this ellipse.

    Parameters

    • value: number

      The new minor axis radius value (must be positive)

    Returns void

    Example

    ellipse.minorAxisRadius = 12;

normal

objectId

  • get objectId(): string

  • Gets the object ID.

    AutoCAD uses 64-bit integers to represent handles, which exceed the maximum integer value of JavaScript. Therefore, strings are used to represent object handles.

    Returns string

    The object ID as a string

    Example

    const id = obj.objectId;
    console.log(`Object ID: ${id}`);
  • set objectId(value: string): void

  • Sets the object ID.

    Parameters

    • value: string

      The new object ID

    Returns void

    Example

    obj.objectId = 'new-object-id';

ownerId

  • get ownerId(): string

  • Gets the object ID of the owner of this object.

    Returns string

    The owner object ID

    Example

    const ownerId = obj.ownerId;
  • set ownerId(value: string): void

  • Sets the object ID of the owner of this object.

    Parameters

    • value: string

      The new owner object ID

    Returns void

    Example

    obj.ownerId = 'parent-object-id';

rgbColor

  • get rgbColor(): number

  • Gets the RGB color of this entity after converting color index.

    This method handles the conversion of color indices (including ByLayer and ByBlock) to actual RGB colors. It resolves layer colors and block colors as needed.

    Returns number

    The RGB color value as a number

    Example

    const rgbColor = entity.rgbColor;
    console.log(`RGB: ${rgbColor.toString(16)}`);

transparency

  • get transparency(): number

  • Gets the transparency level of this entity.

    Returns number

    The transparency value (0-1, where 0 is opaque and 1 is fully transparent)

    Example

    const transparency = entity.transparency;
  • set transparency(value: number): void

  • Sets the transparency level of this entity.

    Parameters

    • value: number

      The transparency value (0-1, where 0 is opaque and 1 is fully transparent)

    Returns void

    Example

    entity.transparency = 0.5; // 50% transparent

type

  • get type(): string

  • Gets the type name of this entity.

    This method returns the entity type by removing the "AcDb" prefix from the constructor name.

    Returns string

    The entity type name

    Example

    const entity = new AcDbLine();
    console.log(entity.type); // "Line"

visibility

  • get visibility(): boolean

  • Gets whether this entity is visible.

    Returns boolean

    True if the entity is visible, false otherwise

    Example

    const isVisible = entity.visibility;
  • set visibility(value: boolean): void

  • Sets whether this entity is visible.

    Parameters

    • value: boolean

      True to make the entity visible, false to hide it

    Returns void

    Example

    entity.visibility = false; // Hide the entity

Methods

close

  • close(): void

  • Closes the object.

    All changes made to the object since it was opened are committed to the database, and a "closed" notification is sent. This method can be overridden by subclasses to provide specific cleanup behavior.

    Returns void

    Example

    obj.close();

draw

getAttr

  • getAttr(attrName: string): any

  • Gets the value of the specified attribute.

    This method will throw an exception if the specified attribute doesn't exist. Use getAttrWithoutException() if you want to handle missing attributes gracefully.

    Parameters

    • attrName: string

      The name of the attribute to retrieve

    Returns any

    The value of the specified attribute

    Throws

    When the specified attribute doesn't exist

    Example

    try {
      const value = obj.getAttr('objectId');
    } catch (error) {
      console.error('Attribute not found');
    }

getAttrWithoutException

  • getAttrWithoutException(attrName: string): any

  • Gets the value of the specified attribute without throwing an exception.

    This method returns undefined if the specified attribute doesn't exist, making it safer for optional attributes.

    Parameters

    • attrName: string

      The name of the attribute to retrieve

    Returns any

    The value of the specified attribute, or undefined if it doesn't exist

    Example

    const value = obj.getAttrWithoutException('optionalAttribute');
    if (value !== undefined) {
      // Use the value
    }

ProtectedgetLayerColor

  • getLayerColor(): null | AcCmColor

  • Gets the color of the layer this entity belongs to.

    This method retrieves the color from the layer table for the layer this entity belongs to.

    Returns null | AcCmColor

    The layer color, or undefined if the layer doesn't exist

    Example

    const layerColor = entity.getLayerColor();

setAttr

subGetGripPoints

  • subGetGripPoints(): AcGePoint3d[]

  • Gets the grip points for this entity.

    Grip points are the control points that can be used to modify the entity. This method should be overridden by subclasses to provide entity-specific grip points.

    Returns AcGePoint3d[]

    Array of grip points as 3D points

    Example

    const gripPoints = entity.subGetGripPoints();

subGetOsnapPoints

  • subGetOsnapPoints(
        osnapMode: AcDbOsnapMode,
        gsSelectionMark: number,
        pickPoint: AcGePoint3d,
        lastPoint: AcGePoint3d,
        snapPoints: AcGePoint3d[],
    ): void

  • Gets the object snap points for this entity.

    Object snap points are the points that can be used for precise positioning when drawing or editing. This method should be overridden by subclasses to provide entity-specific snap points.

    Parameters

    Returns void

    Example

    const snapPoints: AcGePoint3d[] = [];
    entity.subGetOsnapPoints(AcDbOsnapMode.Endpoint, 0, pickPoint, lastPoint, snapPoints);

transformBy

  • transformBy(matrix: AcGeMatrix3d): this

  • Transforms this entity by the specified matrix.

    This method applies a geometric transformation to the entity. Subclasses should override this method to provide entity-specific transformation behavior.

    Parameters

    Returns this

    This entity after transformation

    Example

    const matrix = AcGeMatrix3d.translation(10, 0, 0);
    entity.transformBy(matrix);

triggerModifiedEvent

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods