WECHAT
微信
mail
mxcad

English

简体中文

English

简体中文

Appearance

On this page

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

Class: McDbDatabase ​

2d.McDbDatabase

Represents a database. All information in the graph is stored in this object. Call the mxcad. getDatabase() function to get the database of the control.

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Accessors ​

Methods ​

Constructors ​

constructor ​

• new McDbDatabase(imp?)

Constructor.

Parameters ​

NameTypeDescription
imp?AnyInternal implementation object

Overrides ​

McRxObject.constructor

Properties ​

imp ​

• imp: any = 0

Internal implementation object.

Inherited from ​

McRxObject.imp

Accessors ​

blockTable ​

• get blockTable(): McDbBlockTable

Get block table

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
let blkTable = dataBase.blockTable;

Returns ​

McDbBlockTable

currentSpace ​

• get currentSpace(): McDbBlockTableRecord

Return the current space block table record

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
let currentBlkRec = dataBase.currentSpace;

Returns ​

McDbBlockTableRecord

Block table record

dimStyleTable ​

• get dimStyleTable(): McDbDimStyleTable

Retrieve the annotation style sheet.

Returns ​

McDbDimStyleTable

Linear table.

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 ​

McRxObject.dxf0

layerTable ​

• get layerTable(): McDbLayerTable

Get layer table

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
let layerTable = dataBase.layerTable;

Returns ​

McDbLayerTable

linetypeTable ​

• get linetypeTable(): McDbLinetypeTable

Get line type table

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
let lineTypeTable = dataBase.linetypeTable;

Returns ​

McDbLinetypeTable

objectName ​

• get objectName(): string

Get the object name.

Example

ts
import { McRxObject } from 'mxcad';

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

Returns ​

string

Return object name

Inherited from ​

McRxObject.objectName

textStyleTable ​

• get textStyleTable(): McDbTextStyleTable

Get Text Style Sheet

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
let textStyleTable = dataBase.textStyleTable;

Returns ​

McDbTextStyleTable

ucsMatrix ​

• get ucsMatrix(): McGeMatrix3d

Obtain the UCS user coordinate system transformation matrix

Example

ts

Returns ​

McGeMatrix3d

• set ucsMatrix(val): void

Set UCS user coordinate system transformation matrix

Example

ts

Parameters ​

NameType
valMcGeMatrix3d

Returns ​

void

Methods ​

CreateGroup ​

▸ CreateGroup(ids, name?): boolean

Create a group from a pile of objects

Example

ts
async function Mx_Test_CreateGroup(){
   let ss = new MxCADSelectionSet();
If (! Await ss. userSelect): ")) return;
   if (ss.count() == 0) return;
   let mxcad = MxCpp.getCurrentMxCAD();
   mxcad.getDatabase().CreateGroup(ss.getIds(),"GroupName");

   let idGroup = mxcad.database.GetGroupDictionary().getAt("GroupName");
   let group = idGroup.getMcDbGroup();
   if(group){
       console.log(group.getAllEntityId());
   }
}

Parameters ​

NameTypeDefault value
idsMcObjectId[]undefined
namestring""

Returns ​

boolean

boolean

GetGroupDictionary ​

▸ GetGroupDictionary(): McDbDictionary

Obtain the group dictionary object of the drawing.

Returns ​

McDbDictionary

McDbDictionary

SetCurrentlyTextStyleId ​

▸ SetCurrentlyTextStyleId(id): boolean

Set the current text style id

Parameters ​

NameType
idMcObjectId

Returns ​

boolean

getBlockTable ​

▸ getBlockTable(): McDbBlockTable

Retrieve the block table.

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"
  let mxcad = MxCpp.App.getCurrentMxCAD();
  let blockTable = mxcad.getDatabase().getBlockTable();
  let aryId = blockTable.getAllRecordId();
  aryId.forEach((id) => {
      let blkRec = id.getMcDbBlockTableRecord();
      if (blkRec === null) return;
      console.log(blkRec);
      console.log("blkRec.name:" + blkRec.name);
      console.log("blkRec.origin:" + blkRec.origin);
  });

Returns ​

McDbBlockTable

Block table.

getCurrentlyColorIndex ​

▸ getCurrentlyColorIndex(): number

Retrieve the current color index.

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
const colorIndex = dataBase.getCurrentlyColorIndex();

Returns ​

number

Current Color Index (ColorIndexType).

getCurrentlyDimStyleId ​

▸ getCurrentlyDimStyleId(): McObjectId

Return the current annotation style id

Returns ​

McObjectId

getCurrentlyDrawColor ​

▸ getCurrentlyDrawColor(): Color

Get the color used in the current drawing

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
const color = dataBase.getCurrentlyDrawColor();

Returns ​

Color

getCurrentlyLayerId ​

▸ getCurrentlyLayerId(): McObjectId

Return the current layer ID

Returns ​

McObjectId

getCurrentlyLayerName ​

▸ getCurrentlyLayerName(): string

Get the current layer name.

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
const layerName = dataBase.getCurrentlyLayerName();

Returns ​

string

Current layer name.

getCurrentlyLineTypeName ​

▸ getCurrentlyLineTypeName(): string

Get the current line type name.

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
const name = dataBase.getCurrentlyLineTypeName();

Returns ​

string

The current line type name.

getCurrentlyLineTypeScale ​

▸ getCurrentlyLineTypeScale(): number

Get the current line type scale.

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
let currentLTS = dataBase.getCurrentlyLineTypeScale();

Returns ​

number

Current line type scale.

getCurrentlyLineWeight ​

▸ getCurrentlyLineWeight(): LineWeight

Return the current line weight used

Returns ​

LineWeight

getCurrentlyLinetypeId ​

▸ getCurrentlyLinetypeId(): McObjectId

Return the current line type ID

Returns ​

McObjectId

getCurrentlyTextStyleId ​

▸ getCurrentlyTextStyleId(): McObjectId

Return the current text style id

Returns ​

McObjectId

getCurrentlyTextStyleName ​

▸ getCurrentlyTextStyleName(): string

Get the current text style name.

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
const textStyName = dataBase.getCurrentlyTextStyleName();

Returns ​

string

The current text style name.

getCurrentlyTrueColor ​

▸ getCurrentlyTrueColor(): McCmColor

Retrieve the current CAD color.

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
const color = dataBase.getCurrentlyTrueColor();

Returns ​

McCmColor

Current CAD color.

getDimStyleTable ​

▸ getDimStyleTable(): McDbDimStyleTable

Retrieve the annotation style sheet.

Returns ​

McDbDimStyleTable

Linear table.

getEntitiesInTheGroup ​

▸ getEntitiesInTheGroup(id): McObjectId[]

Get all object IDs in the group where the object is located

Parameters ​

NameType
idMcObjectId

Returns ​

McObjectId[]

McDbDictionary

getImp ​

▸ getImp(): any

Retrieve internal implementation objects.

Example

ts
import { McRxObject } from 'mxcad';

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

Returns ​

any

Internal implementation object.

Inherited from ​

McRxObject.getImp

getJson ​

▸ getJson(): string

Retrieve a string in JSON format.

Example

ts
import { McRxObject } from 'mxcad';

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

Returns ​

string

A string in JSON format.

Inherited from ​

McRxObject.getJson

getLayerTable ​

▸ getLayerTable(): McDbLayerTable

Retrieve the layer table.

Example

ts
import { MxCADUiPrEntity, MxCpp } from "mxcad";
//Hide the layer where the target object is located
  async function Mx_SelectEntitHideLayer() {
     let selEntity1 = new MxCADUiPrEntity();

SelElement1.setMessage ("Select Objects to Hide")
     let id = await selEntity1.go();
     if (!id.isValid()) return;

     let ent = id.getMcDbEntity();
     let mxcad = MxCpp.getCurrentMxCAD();
     let layerTable = mxcad.getDatabase().getLayerTable();
     let layerId = layerTable.get(ent.layer);
     let layerRec = layerId.getMcDbLayerTableRecord();
     if (layerRec === null) return;
     layerRec.isOff = true;
     mxcad.updateLayerDisplayStatus();
     mxcad.updateDisplay()
   }

Returns ​

McDbLayerTable

Layer table.

getLinetypeTable ​

▸ getLinetypeTable(): McDbLinetypeTable

Retrieve the line type table.

Example

ts
import { MxCpp } from "mxcad"
//Get all line types
   let mxcad = MxCpp.App.getCurrentMxCAD();
   let linetypeTable = mxcad.getDatabase().getLinetypeTable();
   let aryId = linetypeTable.getAllRecordId();
   aryId.forEach((id) => {
       let linetypeRec = id.getMcDbLinetypeTableRecord();
       if (linetypeRec === null) return;
       console.log(linetypeRec);
   });

Returns ​

McDbLinetypeTable

Linear table.

getNamedObjectsDictionary ​

▸ getNamedObjectsDictionary(): McDbDictionary

Obtain the dictionary object of the drawing.

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"
//Write extension records
  let mxcad = MxCpp.getCurrentMxCAD();
  let dict = mxcad.getDatabase().getNamedObjectsDictionary();

  let sName = "MyDict";
  let idDict = dict.getAt(sName);
  if (idDict.isNull()) {
      let newDict = new McDbDictionary;
      idDict = dict.addObject(sName, newDict);
   }
   let myDict = idDict.getMcDbDictionary();
   if (myDict) {

       let xrec = new McDbXrecord();
       let data = new MxCADResbuf();
       data.AddString("TestData");
       xrec.setData(data);
       myDict.addObject("MyRecord", xrec);
       console.log("write xrecord ok");
   }

Returns ​

McDbDictionary

McDbDictionary

getTextStyleTable ​

▸ getTextStyleTable(): McDbTextStyleTable

Retrieve the text style sheet.

Example

ts
//Get all text styles
 import { MxCpp } from "mxcad"
 let mxcad = MxCpp.getCurrentMxCAD();
 let textSyleTable = mxcad.getDatabase().getTextStyleTable();
 let aryId = textSyleTable.getAllRecordId();
 aryId.forEach((id) => {
     let textSyleRec = id.getMcDbTextStyleTableRecord();
     if (textSyleRec === null) return;
     let out: any = {};
     out.name = textSyleRec.name;
     out.font = textSyleRec.font();
     out.fileName = textSyleRec.fileName;
     out.bigFontFileName = textSyleRec.bigFontFileName;
     out.textSize = textSyleRec.textSize;
     out.xScale = textSyleRec.xScale;
     console.log(out);
 });

Returns ​

McDbTextStyleTable

Text style sheet.

handleToIdIndex ​

▸ handleToIdIndex(sHandle): McObjectId

Return the object ID based on the handle of the object

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
//Pass in the handle and obtain the corresponding object ID
const handle = "ABCD1234"; //  Assuming this is a valid handle
const objectId = dataBase.handleToIdIndex(handle);
//Ensure that the obtained object ID is valid
if (objectId) {
  console.log("success", objectId);
} else {
  console.log("error")
}

Parameters ​

NameType
sHandlestring

Returns ​

McObjectId

initTempObject ​

▸ initTempObject(imp): void

Initialize temporary objects.

Example

ts
import { McRxObject } from 'mxcad';

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

Parameters ​

NameTypeDescription
'imp''any'Internal implementation object

Returns ​

void

Inherited from ​

McRxObject.initTempObject

insert ​

▸ insert(database, sBlkName): McObjectId

Insert block

Example

ts

Parameters ​

NameType
databaseMcDbDatabase
sBlkNamestring

Returns ​

McObjectId

isKindOf ​

▸ isKindOf(sObjectName): boolean

Determine object type

Example

ts
import { McRxObject } from 'mxcad';

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

Parameters ​

NameTypeDescription
SOrtNamestringType Name

Returns ​

boolean

Return whether the object is of the target type

Inherited from ​

McRxObject.isKindOf

isModifyed ​

▸ isModifyed(): boolean

Has the current database been modified

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
const res = dataBase.isModifyed();
if(res){
Console.log ("Modified")
}else{
Console.log ("unmodified")
}

Returns ​

boolean

Return Boolean value

isNull ​

▸ isNull(): any

Determine if it is an empty object

Example

ts
import { McRxObject } from 'mxcad';

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

Returns ​

any

Inherited from ​

McRxObject.isNull

readFile ​

▸ readFile(sFilePath): boolean

Read files.

Example

ts

Parameters ​

NameType
sFilePathstring

Returns ​

boolean

resetModificationStatus ​

▸ resetModificationStatus(): void

Reset the current database modification status to unmodified status

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
dataBase.resetModificationStatus();

Returns ​

void

saveAs ​

▸ saveAs(sFilePath): boolean

Save the file.

Example

ts

Parameters ​

NameType
sFilePathstring

Returns ​

boolean

setCurrentlyColorIndex ​

▸ setCurrentlyColorIndex(colorIndex): any

Set the current color index (ColorIndexType).

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
const colorIndex = dataBase.getCurrentlyColorIndex();

Parameters ​

NameTypeDescription
ColorIndexNumberColor Index

Returns ​

any

setCurrentlyDimStyleId ​

▸ setCurrentlyDimStyleId(id): boolean

Set the current annotation style id

Parameters ​

NameType
idMcObjectId

Returns ​

boolean

setCurrentlyLayerId ​

▸ setCurrentlyLayerId(id): boolean

Set the current annotation style id

Parameters ​

NameType
idMcObjectId

Returns ​

boolean

setCurrentlyLayerName ​

▸ setCurrentlyLayerName(sName): void

Set the current layer name.

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
DataBase. setCurrentlyLayerName ("Test Layer");

Parameters ​

NameTypeDescription
SNamestringlayer name

Returns ​

void

setCurrentlyLineTypeName ​

▸ setCurrentlyLineTypeName(sName): void

Set the current line type name.

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
DataBase. setCurrentlyLineTypeName ("test line type");

Parameters ​

NameTypeDescription
SNamestringLine type name

Returns ​

void

setCurrentlyLineTypeScale ​

▸ setCurrentlyLineTypeScale(val): number

Set the current line type scale.

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
dataBase.setCurrentlyLineTypeScale(0.8);

Parameters ​

NameTypeDescription
ValnumberLine proportion

Returns ​

number

Current line type scale.

setCurrentlyLineWeight ​

▸ setCurrentlyLineWeight(lineWeight): void

Set the current line weight used

Parameters ​

NameType
lineWeightLineWeight

Returns ​

void

setCurrentlyLinetypeId ​

▸ setCurrentlyLinetypeId(id): boolean

Set the current annotation style id

Parameters ​

NameType
idMcObjectId

Returns ​

boolean

setCurrentlyTextStyle ​

▸ setCurrentlyTextStyle(sName): void

Set the current text style name.

Example

ts
import { MxCpp, McDbDatabase } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
DataBase.setCurrentlyStyle ("Test Text Style");

Parameters ​

NameTypeDescription
SNamestringText style name

Returns ​

void

setCurrentlyTrueColor ​

▸ setCurrentlyTrueColor(color): any

Set the current CAD color.

Example

ts
import { MxCpp, McDbDatabase, McCmColor } from "mxcad"

const dataBase:McDbDatabase = MxCpp.getCurrentMxCAD().getDatabase();
const color = new McCmColor(255, 0, 0);
dataBase.setCurrentlyTrueColor(color);

Parameters ​

NameTypeDescription
Color[McCMColor] (2d. McCmColor. md)CAD color

Returns ​

any

setJson ​

▸ setJson(str): boolean

Set a string in JSON format.

Example

ts
import { McRxObject } from 'mxcad';

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

Parameters ​

NameTypeDescription
StrstringJSON formatted string

Returns ​

boolean

Is the setting successful.

Inherited from ​

McRxObject.setJson

wblock ​

▸ wblock(database, aryId, ptBase?): boolean

Write a block

Example

ts

Parameters ​

NameType
databaseMcDbDatabase
aryIdMcObjectId[]
ptBase?McGePoint3d

Returns ​

boolean

Copyright @ 2023 成都梦想凯德科技有限公司 Rights Reserved