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';
viewportRecord.circleSides = 100;
viewportRecord.lowerLeftCorner = new AcGePoint2d(0, 0);
viewportRecord.upperRightCorner = new AcGePoint2d(1, 1);

Hierarchy (View Summary)

AcDbSymbolTableRecord
- AcDbViewportTableRecord

Index

Constructors

constructor

new AcDbViewportTableRecord(): AcDbViewportTableRecord
Creates a new AcDbViewportTableRecord instance.

Returns AcDbViewportTableRecord
Example
```
const viewportRecord = new AcDbViewportTableRecord();
```
Overrides AcDbSymbolTableRecord.constructor
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:93

Accessors

attrs

get attrs(): AcCmObject<ATTRS>
Gets the attributes object for this AcDbObject.

Returns AcCmObject<ATTRS>
The AcCmObject instance containing all attributes
Example
```
const attrs = obj.attrs;
const value = attrs.get('someAttribute');
```
Inherited from AcDbSymbolTableRecord.attrs
- Defined in data-model/src/base/AcDbObject.ts:80

backgroundObjectId

get backgroundObjectId(): undefined | string
The object dD of the new background for the view.

Returns undefined | string
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:279
set backgroundObjectId(value: undefined | string): void
Parameters
- value: undefined | string
Returns void
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:282

center

get center(): AcGePoint2d
Gets the center point of the viewport.

Returns AcGePoint2d
The center point of the viewport
Example
```
const center = viewportRecord.center;
```
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:141

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
```
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:124
set circleSides(value: number): void
Parameters
- value: number
Returns void
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:127

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;
```
Inherited from AcDbSymbolTableRecord.database
- Defined in data-model/src/base/AcDbObject.ts:223
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
- db: AcDbDatabase
  The database to associate with this object
Returns void
Example
```
obj.database = myDatabase;
```
Inherited from AcDbSymbolTableRecord.database
- Defined in data-model/src/base/AcDbObject.ts:242

gridIncrements

get gridIncrements(): AcGePoint2d
An AcGePoint2d in which the X value represents the X spacing (in drawing units) of the grid and the Y value represents the Y spacing of the grid.

Returns AcGePoint2d
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:231
set gridIncrements(value: AcGePoint2d): void
Parameters
- value: AcGePoint2d
Returns void
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:234

gridMajor

get gridMajor(): number
The number of minor grid lines between each major grid line in the viewport.

Returns number
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:220
set gridMajor(value: number): void
Parameters
- value: number
Returns void
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:223

gsView

get gsView(): AcGiView
The AcGiView associated with this viewport table record

Returns AcGiView
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:289

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);
```
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:163
set lowerLeftCorner(value: AcGePoint2d): void
Parameters
- value: AcGePoint2d
Returns void
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:166

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';
```
Inherited from AcDbSymbolTableRecord.name
- Defined in data-model/src/database/AcDbSymbolTableRecord.ts:69
set name(value: string): void
Parameters
- value: string
Returns void
Inherited from AcDbSymbolTableRecord.name
- Defined in data-model/src/database/AcDbSymbolTableRecord.ts:72

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}`);
```
Inherited from AcDbSymbolTableRecord.objectId
- Defined in data-model/src/base/AcDbObject.ts:163
set objectId(value: string): void
Sets the object ID.
Parameters
- value: string
  The new object ID
Returns void
Example
```
obj.objectId = 'new-object-id';
```
Inherited from AcDbSymbolTableRecord.objectId
- Defined in data-model/src/base/AcDbObject.ts:177

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;
```
Inherited from AcDbSymbolTableRecord.ownerId
- Defined in data-model/src/base/AcDbObject.ts:191
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';
```
Inherited from AcDbSymbolTableRecord.ownerId
- Defined in data-model/src/base/AcDbObject.ts:205

snapAngle

get snapAngle(): number
The snap angle setting (in radians) for the viewport table record. The snap angle is measured within the UCS XY plane, with zero being the UCS X axis and positive angles going counterclockwise when looking down the UCS Z axis towards the UCS origin.

Returns number
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:199
set snapAngle(value: number): void
Parameters
- value: number
Returns void
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:202

snapBase

get snapBase(): AcGePoint2d
The snap basepoint (in UCS coordinates) for the viewport table record.

Returns AcGePoint2d
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:187
set snapBase(value: AcGePoint2d): void
Parameters
- value: AcGePoint2d
Returns void
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:190

snapEnabled

get snapEnabled(): boolean
Returns boolean
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:272

snapIncrements

get snapIncrements(): AcGePoint2d
An AcGePoint2d in which the X value represents the X spacing of the snap grid and the Y value represents the Y spacing of the snap grid. Both values are in drawing units.

Returns AcGePoint2d
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:210
set snapIncrements(value: AcGePoint2d): void
Parameters
- value: AcGePoint2d
Returns void
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:213

standardFlag

get standardFlag(): number
Returns number
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:265
set standardFlag(value: number): void
Parameters
- value: number
Returns void
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:268

upperRightCorner

get upperRightCorner(): AcGePoint2d
The upper right 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 upper right corner of the AutoCAD graphics area. For example, an upper right corner value of (0.5, 1.0) indicates that the viewport's upper right corner is along the top of the AutoCAD graphics area, midway between the left and right edges of the graphics area.

Returns AcGePoint2d
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:177
set upperRightCorner(value: AcGePoint2d): void
Parameters
- value: AcGePoint2d
Returns void
- Defined in data-model/src/database/AcDbViewportTableRecord.ts:180

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();
```
Inherited from AcDbSymbolTableRecord.close
- Defined in data-model/src/base/AcDbObject.ts:258

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');
}
```
Inherited from AcDbSymbolTableRecord.getAttr
- Defined in data-model/src/base/AcDbObject.ts:103

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
}
```
Inherited from AcDbSymbolTableRecord.getAttrWithoutException
- Defined in data-model/src/base/AcDbObject.ts:130

setAttr

setAttr<A extends string>(
attrName: A,
val?: AcDbSymbolTableRecordAttrs[A],
): void
Sets the value of an attribute.
Type Parameters
- A extends string
Parameters
- attrName: A
  The name of the attribute to set
- Optionalval: AcDbSymbolTableRecordAttrs[A]
  The value to assign to the attribute
Returns void
Example
```
obj.setAttr('objectId', 'new-id-123');
```
Inherited from AcDbSymbolTableRecord.setAttr
- Defined in data-model/src/base/AcDbObject.ts:145

Class AcDbViewportTableRecord

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns AcDbViewportTableRecord

Example

Accessors

attrs

Returns AcCmObject<ATTRS>

Example

backgroundObjectId

Returns undefined | string

Parameters

Returns void

center

Returns AcGePoint2d

Example

circleSides

Returns number

Example

Parameters

Returns void

database

Returns AcDbDatabase

Example

Parameters

Returns void

Example

gridIncrements

Returns AcGePoint2d

Parameters

Returns void

gridMajor

Returns number

Parameters

Returns void

gsView

Returns AcGiView

lowerLeftCorner

Returns AcGePoint2d

Example

Parameters

Returns void

name

Returns string

Example

Parameters

Returns void

objectId

Returns string

Example

Parameters

Returns void

Example

ownerId

Returns string

Example

Parameters

Returns void

Example

snapAngle

Returns number

Parameters

Returns void

snapBase

Returns AcGePoint2d

Parameters

Returns void

snapEnabled

Returns boolean

snapIncrements

Returns AcGePoint2d

Parameters

Returns void

standardFlag