Class AcDbViewportTableRecord

Represents a viewport table record in AutoCAD.

This class represents viewport arrangements in AutoCAD, which define how the drawing is displayed in different areas of the screen or paper space. Viewports can have their own zoom levels, pan positions, grid settings, and other display properties.

Example

const viewportRecord = new AcDbViewportTableRecord();
viewportRecord.name = ACTIVE_VPORT_NAME;
viewportRecord.circleSides = 100;
viewportRecord.lowerLeftCorner = new AcGePoint2d(0, 0);
viewportRecord.upperRightCorner = new AcGePoint2d(1, 1);

Hierarchy (View Summary)

Constructors

constructor

Accessors

ambientColor aspectRatio attrs backClippingPlane backgroundObjectId brightness center centerPoint circleSides contrast database defaultLightingType extensionDictionary frontClippingPlane gridIncrements gridMajor gsView isDefaultLightingOn isTemp lensLength lowerLeftCorner name objectId orthographicType ownerId renderMode shadePlotObjectId shadePlotSetting snapAngle snapBase snapEnabled snapIncrements standardFlag ucsIconSetting ucsOrigin ucsXAxis ucsYAxis upperRightCorner viewDirectionFromTarget viewHeight viewMode viewTarget viewTwistAngle visualStyleObjectId

Methods

assignDatabase clone close createExtensionDictionary dxfOut dxfOutFields getAttr getAttrWithoutException getXData modelViewBox removeXData resolveModelViewBox setAttr setXData isActiveVportName isModelViewBoxUsable

Constructors

constructor

Accessors

ambientColor

aspectRatio

attrs

backClippingPlane

backgroundObjectId

brightness

center

centerPoint

circleSides

  • get circleSides(): number

  • Gets or sets the circle zoom percent.

    This controls the number of sides to the tessellation used when displaying curves. The value can be between 1 and 20000, with higher settings using more sides in the curve tessellation.

    Returns number

    The number of sides used for circle tessellation

    Example

    const sides = viewportRecord.circleSides;
    viewportRecord.circleSides = 200; // Higher quality circles
  • set circleSides(value: number): void

  • Parameters

    • value: number

    Returns void

contrast

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;

defaultLightingType

extensionDictionary

  • get extensionDictionary(): undefined | string

  • Gets the objectId of the extension dictionary owned by this object.

    If the object does not have an extension dictionary, this returns undefined.

    In ObjectARX terms, this is equivalent to AcDbObject::extensionDictionary().

    Returns undefined | string

    The extension dictionary objectId, or undefined

    Example

    const dictId = obj.extensionDictionary
    if (dictId) {
      console.log('Has extension dictionary:', dictId)
    }
  • set extensionDictionary(value: undefined | string): void

  • Sets the objectId of the extension dictionary owned by this object.

    This does not create or delete the dictionary object itself — it only establishes or clears the ownership relationship.

    Passing undefined removes the association.

    Parameters

    • value: undefined | string

      The extension dictionary objectId, or undefined

    Returns void

    Example

    obj.extensionDictionary = dict.objectId

frontClippingPlane

gridIncrements

gridMajor

gsView

isDefaultLightingOn

isTemp

  • get isTemp(): any

  • Returns true if this object is temporary and not yet committed to the database.

    A temporary object is identified by its objectId starting with the TEMP prefix.

    Returns any

lensLength

lowerLeftCorner

  • get lowerLeftCorner(): AcGePoint2d

  • Gets or sets the lower left corner of the viewport window.

    The X and Y values of this point are expressed as a value between (0.0, 0.0) for the lower left corner of the AutoCAD graphics area and (1.0, 1.0) for the upper right corner of the AutoCAD graphics area. For example, a lower left corner value of (0.5, 0.0) indicates that the viewport's lower left corner is along the bottom of the AutoCAD graphics area, midway between the left and right edges of the graphics area.

    Returns AcGePoint2d

    The lower left corner point

    Example

    const corner = viewportRecord.lowerLeftCorner;
    viewportRecord.lowerLeftCorner = new AcGePoint2d(0.25, 0.25);
  • set lowerLeftCorner(value: AcGePoint2d): void

  • Parameters

    Returns void

name

  • get name(): string

  • Gets or sets the name of the symbol table record.

    This property corresponds to DXF group code 2 and is used for identifying and referencing the symbol table record.

    Returns string

    The name of the symbol table record

    Example

    const recordName = record.name;
    record.name = 'NewRecordName';
  • set name(value: string): void

  • Parameters

    • value: string

    Returns void

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';

orthographicType

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';

renderMode

shadePlotObjectId

shadePlotSetting

snapAngle

snapBase

snapEnabled

snapIncrements

standardFlag

ucsIconSetting

ucsOrigin

ucsXAxis

ucsYAxis

upperRightCorner

viewDirectionFromTarget

viewHeight

viewMode

viewTarget

viewTwistAngle

visualStyleObjectId

Methods

ProtectedassignDatabase

clone

close

createExtensionDictionary

  • createExtensionDictionary(): undefined | string

  • Creates the extension dictionary for this object if it does not already exist.

    This method closely mirrors the behavior of AcDbObject::createExtensionDictionary() in ObjectARX.

    • If the object already owns an extension dictionary, no new dictionary is created and the existing dictionary's objectId is returned.
    • Otherwise, a new AcDbDictionary is created, added to the same database, owned by this object, and its objectId is stored on this object.

    Returns undefined | string

    The objectId of the extension dictionary

    Example

    const dictId = obj.createExtensionDictionary()

dxfOut

dxfOutFields

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
    }

getXData

  • getXData(appId: string): undefined | AcDbResultBuffer

  • Retrieves the XData associated with this object for a given application ID.

    Extended Entity Data (XData) allows applications to attach arbitrary, application-specific data to an AcDbObject. Each XData entry is identified by a registered application name (AppId) and stored as an AcDbResultBuffer.

    This method is conceptually equivalent to AcDbObject::xData() in ObjectARX, but simplified to return the entire result buffer for the specified AppId.

    Parameters

    • appId: string

      The application ID (registered AppId name) that owns the XData

    Returns undefined | AcDbResultBuffer

    The AcDbResultBuffer associated with the AppId, or undefined if no XData exists for that AppId

    Example

    const xdata = obj.getXData('MY_APP')
    if (xdata) {
      // Read values from the result buffer
    }

modelViewBox

  • modelViewBox(canvasAspectRatio: number): undefined | AcGeBox2d

  • Builds the model-space WCS view rectangle from this VPORT record.

    AutoCAD stores:

    • view center in groups 10/20 (mapped to centerPoint)
    • view height in group 40/45 (viewHeight)
    • aspect ratio in group 41 (gsView.aspectRatio) — the AutoCAD graphics window width/height at save time, not the model-space view on its own

    View width = view height × aspect ratio. The viewer uses the current canvas aspect ratio so DWG/DXF exports of the same drawing frame identically even when group 41 differs.

    Parameters

    • canvasAspectRatio: number

    Returns undefined | AcGeBox2d

removeXData

  • removeXData(appId: string): void

  • Removes the XData associated with the specified application ID.

    After removal, calls to getXData() for the same AppId will return undefined. If no XData exists for the given AppId, this method has no effect.

    This mirrors the behavior of clearing XData for a specific application in ObjectARX rather than removing all XData from the object.

    Parameters

    • appId: string

      The application ID whose XData should be removed

    Returns void

    Example

    obj.removeXData('MY_APP')

resolveModelViewBox

setAttr

setXData

  • setXData(resbuf: AcDbResultBuffer): void

  • Attaches or replaces XData for this object.

    If XData already exists for the given AppId, it is replaced by the provided AcDbResultBuffer. The caller is responsible for ensuring that:

    • The AppId is registered in the database's AppId table
    • The result buffer follows valid DXF/XData conventions (e.g. starts with a 1001 group code for the AppId)

    This method is conceptually similar to AcDbObject::setXData() in ObjectARX.

    Parameters

    Returns void

    Example

    const rb = new AcDbResultBuffer([
      { code: AcDbDxfCode.ExtendedDataRegAppName, value: 'MY_APP' },
      { code: AcDbDxfCode.ExtendedDataAsciiString, value: 'custom value' }
    ])

    obj.setXData('MY_APP', rb)

StaticisActiveVportName

  • isActiveVportName(name: string): boolean

  • Returns true if the specified name is the active viewport table record.

    AutoCAD stores the current model-space viewport configuration as *Active. DXF/DWG sources may emit different casing (*ACTIVE, *active, etc.), but the names compare case-insensitively.

    Parameters

    • name: string

    Returns boolean

StaticisModelViewBoxUsable

  • isModelViewBoxUsable(viewBox: AcGeBox2d, drawingExtents: AcGeBox2d): boolean

  • Returns whether a VPORT-derived view box is sane enough to frame the drawing on open. Rejects stale saves that are zoomed far beyond the sheet (common when $EXTMIN/$EXTMAX reflect the title block but *ACTIVE still stores a huge view height) or panned to a corner with no real geometry.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods