Class AcDbLinetypeTableRecord

Represents a record in the line type table within the AutoCAD drawing database.

Each line type table record contains the information necessary to define a specific line type, including its pattern, description, and rendering characteristics. Line types define how lines are drawn, including patterns of dashes, dots, and spaces.

Within the line type table record, the dashes (line segments that make up characteristics of the linetype) are stored in a list with an index that is zero based. If the linetype is complex, then embedded shapes or text strings are stored in the list at the same index as the dash that preceded them in the linetype definition. So there will always be a dashLength for any valid index in the list, even if there is a shape or text string sharing the same index. When the linetype is elaborated, a shape's insertion point will coincide with the end of the dash that it shares an index with.

Hierarchy (View Summary)

AcDbSymbolTableRecord
- AcDbLinetypeTableRecord

Index

Constructors

constructor

new AcDbLinetypeTableRecord(
linetype: AcGiBaseLineStyle,
): AcDbLinetypeTableRecord
Creates a new line type table record.
Parameters
- linetype: AcGiBaseLineStyle
  The line type style object that defines the visual characteristics and pattern of this line type
Returns AcDbLinetypeTableRecord
Overrides AcDbSymbolTableRecord.constructor
- Defined in data-model/src/database/AcDbLinetypeTableRecord.ts:28

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

comments

get comments(): string
Gets the description or comments associated with this line type.

This property provides additional information about the line type, such as its intended use or any special characteristics.

Returns string
The description text for the line type
- Defined in data-model/src/database/AcDbLinetypeTableRecord.ts:69

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

linetype

get linetype(): AcGiBaseLineStyle
Gets the line type style object used by the renderer.

This property provides access to the underlying line type definition that contains all the visual characteristics and rendering information.

Returns AcGiBaseLineStyle
The line type style object
- Defined in data-model/src/database/AcDbLinetypeTableRecord.ts:81

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

numDashes

get numDashes(): number
Gets the number of dash elements in the line type pattern.

This value represents the total count of dashes, spaces, dots, and other pattern elements that make up the line type. It corresponds to DXF group code 73 in the AutoCAD file format.

Returns number
The number of pattern elements in the line type
- Defined in data-model/src/database/AcDbLinetypeTableRecord.ts:42

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

patternLength

get patternLength(): number
Gets the total pattern length in AutoCAD drawing units.

The pattern length represents the total length of all dashes and spaces when the line type scale is 1.0. This value is used to calculate how the pattern repeats along a line.

Note: Embedded shapes or text strings do not add to the pattern length because they are overlaid and do not interrupt the actual dash pattern.

Returns number
The total length of the line type pattern in drawing units
- Defined in data-model/src/database/AcDbLinetypeTableRecord.ts:57

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

dashLengthAt

dashLengthAt(index: number): number
Gets the length of a specific dash element in the line type pattern.

Each dash element in the pattern has a specific length that determines how it appears when the line type is rendered. Positive values represent visible dashes, while negative values represent spaces (pen up).
Parameters
- index: number
  Zero-based index of the dash element. Must be greater than or equal to zero, but less than the value of property 'numDashes'
Returns number
The length of the specified dash element in drawing units

Throws
When the index is out of range
- Defined in data-model/src/database/AcDbLinetypeTableRecord.ts:97

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 AcDbLinetypeTableRecord

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AcDbLinetypeTableRecord

Accessors

attrs

Returns AcCmObject<ATTRS>

Example

comments

Returns string

database

Returns AcDbDatabase

Example

Parameters

Returns void

Example

linetype

Returns AcGiBaseLineStyle

name

Returns string

Example

Parameters

Returns void

numDashes

Returns number

objectId

Returns string

Example

Parameters

Returns void

Example

ownerId

Returns string

Example

Parameters

Returns void

Example

patternLength

Returns number

Methods

close

Returns void

Example

dashLengthAt

Parameters

Returns number

Throws

getAttr

Parameters

Returns any

Throws

Example

getAttrWithoutException

Parameters

Returns any

Example

setAttr

Type Parameters

Parameters

Returns void

Example

Settings

On This Page