[mxcad_2d API documentation] (../README. md)/[2d] (../modules/2d. md)/McDbTextCtyleTableRecord
Class: McDbTextStyleTableRecord
2d.McDbTextStyleTableRecord
Represents a text style sheet that records objects and implements attribute related operation functions for text.
Example
//Add Text Style
import { McCmColor, MxCpp, McDbTextStyleTableRecord, McDb } from "mxcad"
const mxcad = MxCpp.getCurrentMxCAD();
//Get the current text style sheet
const textSyleTable = mxcad.getDatabase().getTextStyleTable();
//Construct a text style sheet to record objects
let newTextStyleRecord = new McDbTextStyleTableRecord();
//Set object file name
newTextStyleRecord.fileName = "txt.shx";
//Set the large font name for the object
newTextStyleRecord.bigFontFileName = "hztxt.shx";
//Set object text size
newTextStyleRecord.textSize = 10;
//Set object name
newTextStyleRecord.name = sMyTextStyle;
//Set object width factor
newTextStyleRecord.xScale = 0.7;
//Add Text Style
const res = textSyleTable.add(newTextStyleRecord).isValid()
if (res) {
console.log("add ok");
}
Hierarchy
↳
McDbTextStyleTableRecord
Table of contents
Constructors
Properties
Accessors
Methods
- assertObjectModification
- clone
- createExtensionDictionary
- erase
- font
- getDatabase
- getDatabaseIndexId
- getExtensionDictionary
- getGripPoints
- getHandle
- getImp
- getJson
- getObjectID
- getOwnerID
- initTempObject
- isErased
- isHaveExtensionDictionary
- isKindOf
- isNull
- moveGripPointsAt
- setFont
- setJson
- unErase
Constructors
constructor
• new McDbTextStyleTableRecord(imp?
)
Constructor.
Parameters
Name | Type | Description |
---|---|---|
imp? | Any | Internal implementation object |
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
Overrides
Properties
imp
• imp: any
= 0
Internal implementation object.
Inherited from
Accessors
bigFontFileName
• get
bigFontFileName(): string
Large font file name
Returns
string
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
NewTextCtyleRecord. bigFontFileName="Test";
Console.log ("Large font name: ",newTextStyleRecord.bigFontFileName)
• set
bigFontFileName(val
): void
Parameters
Name | Type |
---|---|
val | string |
Returns
void
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
fileName
• get
fileName(): string
Font file name
Returns
string
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
NewTextCtyleRecord. FileName="Test Font Name";
Console.log (current font file name: ",newTextStyleRecord.fileName)
• set
fileName(val
): void
Parameters
Name | Type |
---|---|
val | string |
Returns
void
flagBits
• get
flagBits(): number
Get or set a set of flags for a text style sheet record
Returns
number
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
//Get the current value of the flag bit
const currentFlagBits = newTextStyleRecord.flagBits;
Console.log (current flag: ", currentFlagBits);
//Set a new flag value
const newFlagBits = 0b101010; // For example, using binary literals to represent new flag values
newTextStyleRecord.flagBits = newFlagBits;
Console.log ("flag set: ", newTextStyleRecord.flagBits);
• set
flagBits(val
): void
Parameters
Name | Type |
---|---|
val | number |
Returns
void
isShapeFile
• get
isShapeFile(): boolean
Get or set whether to use shape fonts for text styles
Returns
boolean
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
newTextStyleRecord.isShapeFile = false;
console.log(newTextStyleRecord.isShapeFile) // false
• set
isShapeFile(val
): void
Parameters
Name | Type |
---|---|
val | boolean |
Returns
void
isVertical
• get
isVertical(): boolean
Get or set whether to use italics for text style
Returns
boolean
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
newTextStyleRecord.isVertical = false;
console.log(newTextStyleRecord.isVertical) // false
• set
isVertical(val
): void
Parameters
Name | Type |
---|---|
val | boolean |
Returns
void
name
• get
name(): string
Get or set the name of the text style.
Returns
string
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
NewTextCtyleRecord. name="Test Text Style"
Console. log (newTextCtyleRecord. name)//Test text style
• set
name(val
): void
Parameters
Name | Type |
---|---|
val | string |
Returns
void
objectName
• get
objectName(): string
Get the object name.
Returns
string
Return object name
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
console.log(obj.objectName);
Inherited from
McDbObject.objectName
obliquingAngle
• get
obliquingAngle(): number
Tilt angle
Returns
number
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
newTextStyleRecord.obliquingAngle = Math.PI/4;
console.log(newTextStyleRecord.obliquingAngle) // 45
• set
obliquingAngle(val
): void
Parameters
Name | Type |
---|---|
val | number |
Returns
void
textSize
• get
textSize(): number
Text size (height)
Returns
number
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
newTextStyleRecord.textSize = 20;
console.log(newTextStyleRecord.textSize) // 20
• set
textSize(val
): void
Parameters
Name | Type |
---|---|
val | number |
Returns
void
xScale
• get
xScale(): number
Returns
number
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
newTextStyleRecord.xScale = 0.8;
console.log(newTextStyleRecord.xScale) // 0.8
• set
xScale(val
): void
Parameters
Name | Type |
---|---|
val | number |
Returns
void
Methods
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
Name | Type | Default value |
---|---|---|
autoUndo | boolean | false |
Returns
number
Example
//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
//Assuming obj is a database object
const obj_clone = obj.clone();
Inherited from
createExtensionDictionary
▸ createExtensionDictionary(): boolean
Create extended dictionary data for objects
Returns
boolean
Example
//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
//Assuming obj is a database object
const res = obj.erase();
console.log(res);
Inherited from
font
▸ font(): Object
Get font style
Returns
Object
sTypeface: Font Name | bold: bold or not | italic: italic or not | charset: character set | pitchAndFamily: font spacing and style
Name | Type |
---|---|
bold | boolean |
charset | number |
italic | boolean |
pitchAndFamily | number |
sTypeface | string |
getDatabase
▸ getDatabase(): McDbDatabase
Get the database where the object is located
Returns
Return to database
Example
//Assuming obj is a database object
const data = obj.getDatabase();
Inherited from
getDatabaseIndexId
▸ getDatabaseIndexId(): number
Get the index ID of the object
Returns
number
Example
//Assuming obj is a database object
const id = obj.getDatabaseIndexId();
Inherited from
getExtensionDictionary
▸ getExtensionDictionary(): McDbDictionary
Obtain the extended dictionary data of the object
Returns
Expand dictionary data
Example
//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
Example
//Assuming obj is a database object
const ptArr = obj.getGripPoints();
Inherited from
getHandle
▸ getHandle(): string
Obtain object handle
Returns
string
Return object handle
Example
//Assuming obj is a database object
const handle = obj.getHandle();
Inherited from
getImp
▸ getImp(): any
Retrieve internal implementation objects.
Returns
any
Internal implementation object.
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
let imp = obj.getImp();
Inherited from
getJson
▸ getJson(): string
Retrieve a string in JSON format.
Returns
string
A string in JSON format.
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
const json = obj.getJson()
Inherited from
getObjectID
▸ getObjectID(): McObjectId
Get the object ID.
Returns
Object ID.
Example
import { McDbObject } from "mxcad";
const id = obj.getObjectID();
Inherited from
getOwnerID
▸ getOwnerID(): number
Obtain the ID of the object owner
Returns
number
Example
//Assuming obj is a database object
const id = obj.getOwnerID();
Inherited from
initTempObject
▸ initTempObject(imp
): void
Initialize temporary objects.
Parameters
Name | Type | Description |
---|---|---|
'imp' | 'any' | Internal implementation object |
Returns
void
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
obj.initTempObject()
Inherited from
isErased
▸ isErased(): boolean
Has the object been deleted
Returns
boolean
Example
//Assuming obj is a database object
const res = obj.isErased();
console.log(res);
Inherited from
isHaveExtensionDictionary
▸ isHaveExtensionDictionary(): boolean
Is there any extended dictionary data available
Returns
boolean
Example
//Assuming obj is a database object
const res = obj.isHaveExtensionDictionary();
Inherited from
McDbObject.isHaveExtensionDictionary
isKindOf
▸ isKindOf(sObjectName
): boolean
Determine object type
Parameters
Name | Type | Description |
---|---|---|
SOrtName | string | Type Name |
Returns
boolean
Return whether the object is of the target type
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
let isKind = obj.isKindOf('SomeObjectType');
console.log(isKind); // Output: True or false
Inherited from
isNull
▸ isNull(): any
Determine if it is an empty object
Returns
any
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
console.log(obj.isNull()); // Output: True or false
Inherited from
moveGripPointsAt
▸ moveGripPointsAt(iIndex
, dXOffset
, dYOffset
, dZOffset
): any
Control points for moving objects
Parameters
Name | Type | Description |
---|---|---|
IIndex | Number | Index |
DXOffset | number | X-axis offset |
DYOffset | number | Y-axis offset |
DZOffset | number | Z-axis offset |
Returns
any
Example
//Assuming obj is a database object
obj.moveGripPointsAt(1,10,10,10);
Inherited from
setFont
▸ setFont(sTypeface
, bold
, italic
, charset
, pitchAndFamily
): boolean
Set font style
Parameters
Name | Type | Description |
---|---|---|
STypeface | string | Font Name |
Bold | boolean | Is it bold |
Italic | boolean | italic or not |
Charset | number | character set |
PitchAndFamily | number | Font spacing and style |
Returns
boolean
Is the setting successful
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
//Set font
const typeface = "Arial"; // Font Name
const isBold = true; // Is it bold
const isItalic = false; // Is it italicized
const charset = 0; // character set
const pitchAndFamily = 0; // Font spacing and style
const isSetFontSuccessful = newTextStyleRecord.setFont(typeface, isBold, isItalic, charset, pitchAndFamily);
//Check if the settings are successful
if (isSetFontSuccessful) {
console.log("Font set successfully.");
} else {
console.log("Failed to set font.");
}
setJson
▸ setJson(str
): boolean
Set a string in JSON format.
Parameters
Name | Type | Description |
---|---|---|
Str | string | JSON formatted string |
Returns
boolean
Is the setting successful.
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
const res = obj.setJson('{"key": "value"}');
console.log(res)
Inherited from
unErase
▸ unErase(): boolean
Anti delete object.
Returns
boolean
Example
//Assuming obj is a database object
const res = obj.unErase();
console.log(res);