Skip to content
On this page

[mxcad_2d API documentation] (../README. md)/[2d] (../modules/2d. md)/McDbLinetypeTable

Class: McDbLinetypeTable

2d.McDbLinetypeTable

Represents the database line type table, where all line type definitions are stored.

Example

ts
//Get all line types
import { MxCpp, McDbLinetypeTable } from "mxcad"
//Retrieve the current CAD object
let mxcad = MxCpp.getCurrentMxCAD();
//Retrieve database line type table
let linetypeTable: McDbLinetypeTable = mxcad.getDatabase().getLinetypeTable();
//Retrieve all line type table record object IDs from the linear table
let aryId = linetypeTable.getAllRecordId();
//Traverse the line type table to record objects
aryId.forEach((id) => {
let linetypeRec = id.getMcDbLinetypeTableRecord();
if (linetypeRec === null) return;
console.log(linetypeRec);
console.log("linetypeRec.name:" + linetypeRec.name);
});

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new McDbLinetypeTable(imp?)

Constructor.

Parameters

NameTypeDescription
imp?AnyInternal implementation object

Overrides

McDbObject.constructor

Properties

imp

imp: any = 0

Internal implementation object.

Inherited from

McDbObject.imp

Accessors

dxf0

get dxf0(): string

Obtain the type name of the object's DXF group code, which is the same as the DXF group code in AutoCAD. For example, the type name of the line is McDbLine, and the group code value for DXF0 is: LINE and DXF0 group code values can be used for type filtering when constructing sets.

Returns

string

Inherited from

McDbObject.dxf0


objectName

get objectName(): string

Get the object name.

Returns

string

Return object name

Example

ts
import { McRxObject } from 'mxcad';

let obj = new McRxObject();
console.log(obj.objectName);

Inherited from

McDbObject.objectName

Methods

add

add(rec): McObjectId

Add line type records to the line type table.

Parameters

NameTypeDescription
Rec[McDbLinetypeTableRecord] (2d. McDbLinetypeTableRecord. md)Line type table record object

Returns

McObjectId

Add a new line type record object ID.

Example

ts
import { MxCpp, McDbLinetypeTable } from "mxcad";

let mxcad = MxCpp.getCurrentMxCAD();
let linetypeTable: McDbLinetypeTable = mxcad.getDatabase().getLinetypeTable();
let newLinetypeRecord = new McDbLinetypeTableRecord();
const id = linetypeTable.add(newLinetypeRecord);
console.log(id)

assertObjectModification

assertObjectModification(autoUndo?): number

Setting the state of the object to be changed can automatically trigger the update display function to update the display. For example, if the block table record is updated and the block reference needs to be notified to update the display, this function can be called.

Parameters

NameTypeDefault value
autoUndobooleanfalse

Returns

number

Example

ts
//Assuming obj is a database object
obj.assertObjectModification()

Inherited from

McDbObject.assertObjectModification


clone

clone(): null | McDbObject

Clone objects.

Returns

null | McDbObject

The cloned object.

Example

ts
//Assuming obj is a database object
const obj_clone = obj.clone();

Inherited from

McDbObject.clone


createExtensionDictionary

createExtensionDictionary(): boolean

Create extended dictionary data for objects

Returns

boolean

Example

ts
//Assuming obj is a database object
const res = obj.createExtensionDictionary();

Inherited from

McDbObject.createExtensionDictionary


erase

erase(): boolean

Delete object.

Returns

boolean

Whether the deletion was successful.

Example

ts
//Assuming obj is a database object
const res = obj.erase();
console.log(res);

Inherited from

McDbObject.erase


get

get(sName, skipDeleted?): McObjectId

Search for line type records in the line type table.

Parameters

NameTypeDefault valueDescription
SNamestringundefinedLine type name
SkipDeletedbooleantrueDo you want to skip deleted linetypes

Returns

McObjectId

Line type records the object ID.

Example

ts
import { MxCpp, McDbLinetypeTable } from "mxcad";

let mxcad = MxCpp.getCurrentMxCAD();
let linetypeTable: McDbLinetypeTable = mxcad.getDatabase().getLinetypeTable();
let newLinetypeRecord = new McDbLinetypeTableRecord();
newLinetypeRecord.name = "TestMyLine";
linetypeTable.add(newLinetypeRecord);
const id = linetypeTable.get("TestMyLine")

getAllRecordId

getAllRecordId(skipDeleted?): McObjectId[]

Retrieve the IDs of all line type records in the line type table.

Parameters

NameTypeDefault valueDescription
SkipDeletedbooleantrueDo you want to skip deleted linetypes

Returns

McObjectId[]

Ret line type ID array.

Example

ts
import { MxCpp, McDbLinetypeTable } from "mxcad";

let mxcad = MxCpp.getCurrentMxCAD();
let linetypeTable: McDbLinetypeTable = mxcad.getDatabase().getLinetypeTable();

getDatabase

getDatabase(): McDbDatabase

Get the database where the object is located

Returns

McDbDatabase

Return to database

Example

ts
//Assuming obj is a database object
const data = obj.getDatabase();

Inherited from

McDbObject.getDatabase


getDatabaseIndexId

getDatabaseIndexId(): number

Get the index ID of the object

Returns

number

Example

ts
//Assuming obj is a database object
const id = obj.getDatabaseIndexId();

Inherited from

McDbObject.getDatabaseIndexId


getExtensionDictionary

getExtensionDictionary(): McDbDictionary

Obtain the extended dictionary data of the object

Returns

McDbDictionary

Expand dictionary data

Example

ts
//Assuming obj is a database object
const id = obj.getOwnerID();

Inherited from

McDbObject.getExtensionDictionary


getGripPoints

getGripPoints(): McGePoint3dArray

Get the control points of the object

Returns

McGePoint3dArray

Example

ts
//Assuming obj is a database object
const ptArr = obj.getGripPoints();

Inherited from

McDbObject.getGripPoints


getHandle

getHandle(): string

Obtain object handle

Returns

string

Return object handle

Example

ts
//Assuming obj is a database object
const handle = obj.getHandle();

Inherited from

McDbObject.getHandle


getImp

getImp(): any

Retrieve internal implementation objects.

Returns

any

Internal implementation object.

Example

ts
import { McRxObject } from 'mxcad';

let obj = new McRxObject();
let imp = obj.getImp();

Inherited from

McDbObject.getImp


getJson

getJson(): string

Retrieve a string in JSON format.

Returns

string

A string in JSON format.

Example

ts
import { McRxObject } from 'mxcad';

let obj = new McRxObject();
const json = obj.getJson()

Inherited from

McDbObject.getJson


getObjectID

getObjectID(): McObjectId

Get the object ID.

Returns

McObjectId

Object ID.

Example

ts
import { McDbObject } from "mxcad";
const id = obj.getObjectID();

Inherited from

McDbObject.getObjectID


getOwnerID

getOwnerID(): number

Obtain the ID of the object owner

Returns

number

Example

ts
//Assuming obj is a database object
const id = obj.getOwnerID();

Inherited from

McDbObject.getOwnerID


has

has(sName, skipDeleted?): boolean

Check if there is a line type record with the specified name in the line type table.

Parameters

NameTypeDefault valueDescription
SNamestringundefinedLine type name
SkipDeletedbooleantrueDo you want to skip deleted linetypes

Returns

boolean

Boolean value.

Example

ts
import { MxCpp, McDbLinetypeTable } from "mxcad";

let mxcad = MxCpp.getCurrentMxCAD();
let linetypeTable: McDbLinetypeTable = mxcad.getDatabase().getLinetypeTable();
let newLinetypeRecord = new McDbLinetypeTableRecord();
newLinetypeRecord.name = "TestMyLine";
linetypeTable.add(newLinetypeRecord);
const res = linetypeTable.has("TestMyLine");
console.log(res)

initTempObject

initTempObject(imp): void

Initialize temporary objects.

Parameters

NameTypeDescription
'imp''any'Internal implementation object

Returns

void

Example

ts
import { McRxObject } from 'mxcad';

let obj = new McRxObject();
obj.initTempObject()

Inherited from

McDbObject.initTempObject


isErased

isErased(): boolean

Has the object been deleted

Returns

boolean

Example

ts
//Assuming obj is a database object
const res = obj.isErased();
console.log(res);

Inherited from

McDbObject.isErased


isHaveExtensionDictionary

isHaveExtensionDictionary(): boolean

Is there any extended dictionary data available

Returns

boolean

Example

ts
//Assuming obj is a database object
const res = obj.isHaveExtensionDictionary();

Inherited from

McDbObject.isHaveExtensionDictionary


isKindOf

isKindOf(sObjectName): boolean

Determine object type

Parameters

NameTypeDescription
SOrtNamestringType Name

Returns

boolean

Return whether the object is of the target type

Example

ts
import { McRxObject } from 'mxcad';

let obj = new McRxObject();
let isKind = obj.isKindOf('SomeObjectType');
console.log(isKind); //  Output: True or false

Inherited from

McDbObject.isKindOf


isNull

isNull(): any

Determine if it is an empty object

Returns

any

Example

ts
import { McRxObject } from 'mxcad';

let obj = new McRxObject();
console.log(obj.isNull()); //  Output: True or false

Inherited from

McDbObject.isNull


moveGripPointsAt

moveGripPointsAt(iIndex, dXOffset, dYOffset, dZOffset): any

Control points for moving objects

Parameters

NameTypeDescription
IIndexNumberIndex
DXOffsetnumberX-axis offset
DYOffsetnumberY-axis offset
DZOffsetnumberZ-axis offset

Returns

any

Example

ts
//Assuming obj is a database object
obj.moveGripPointsAt(1,10,10,10);

Inherited from

McDbObject.moveGripPointsAt


setJson

setJson(str): boolean

Set a string in JSON format.

Parameters

NameTypeDescription
StrstringJSON formatted string

Returns

boolean

Is the setting successful.

Example

ts
import { McRxObject } from 'mxcad';

let obj = new McRxObject();
const res = obj.setJson('{"key": "value"}');
console.log(res)

Inherited from

McDbObject.setJson


unErase

unErase(): boolean

Anti delete object.

Returns

boolean

Example

ts
//Assuming obj is a database object
const res = obj.unErase();
console.log(res);

Inherited from

McDbObject.unErase