mxcad_2d API 文档 / 2d / McDbTextStyleTableRecord
Class: McDbTextStyleTableRecord
2d.McDbTextStyleTableRecord
表示一个文字样式表记录对象,实现了对文字的属性相关操作函数。
Example
// 添加文字样式
import { McCmColor, MxCpp, McDbTextStyleTableRecord, McDb } from "mxcad"
const mxcad = MxCpp.getCurrentMxCAD();
// 拿到当前文字样式表
const textSyleTable = mxcad.getDatabase().getTextStyleTable();
// 构造一个文字样式表记录对象
let newTextStyleRecord = new McDbTextStyleTableRecord();
// 设置对象文件名
newTextStyleRecord.fileName = "txt.shx";
// 设置对象大字体名称
newTextStyleRecord.bigFontFileName = "hztxt.shx";
// 设置对象文字大小
newTextStyleRecord.textSize = 10;
// 设置对象名
newTextStyleRecord.name = sMyTextStyle;
// 设置对象宽度因子
newTextStyleRecord.xScale = 0.7;
// 添加文字样式
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?
)
构造函数。
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
Parameters
Name | Type | Description |
---|---|---|
imp? | any | 内部实现对象。 |
Overrides
Properties
imp
• imp: any
= 0
内部实现对象。
Inherited from
Accessors
bigFontFileName
• get
bigFontFileName(): string
大字体文件名称
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
newTextStyleRecord.bigFontFileName = "测试";
console.log("大字体名称:",newTextStyleRecord.bigFontFileName)
Returns
string
• set
bigFontFileName(val
): void
Parameters
Name | Type |
---|---|
val | string |
Returns
void
dxf0
• get
dxf0(): string
得到对象的DXF组码的类型名,这个和AutoCAD中的DXF组码是一样。 比如直线的类型名为:McDbLine,DXF0组码值: LINE,DXF0组码值可以用来构造集时的类型过滤。
Returns
string
Inherited from
McDbObject.dxf0
fileName
• get
fileName(): string
字体文件名称
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
newTextStyleRecord.fileName = "测试字体名";
console.log("当前字体文件名:",newTextStyleRecord.fileName)
Returns
string
• set
fileName(val
): void
Parameters
Name | Type |
---|---|
val | string |
Returns
void
flagBits
• get
flagBits(): number
获取或设置文本样式表记录的一组标志位
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
// 获取标志位的当前值
const currentFlagBits = newTextStyleRecord.flagBits;
console.log("当前标志位:", currentFlagBits);
// 设置新的标志位值
const newFlagBits = 0b101010; // 例如:使用二进制字面量来表示新的标志位值
newTextStyleRecord.flagBits = newFlagBits;
console.log("设置后的标志位:", newTextStyleRecord.flagBits);
Returns
number
• set
flagBits(val
): void
Parameters
Name | Type |
---|---|
val | number |
Returns
void
isShapeFile
• get
isShapeFile(): boolean
获取或设置文本样式是否使用形状字体
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
newTextStyleRecord.isShapeFile = false;
console.log(newTextStyleRecord.isShapeFile) // false
Returns
boolean
• set
isShapeFile(val
): void
Parameters
Name | Type |
---|---|
val | boolean |
Returns
void
isVertical
• get
isVertical(): boolean
获取或设置文本样式是否使用斜体
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
newTextStyleRecord.isVertical = false;
console.log(newTextStyleRecord.isVertical) // false
Returns
boolean
• set
isVertical(val
): void
Parameters
Name | Type |
---|---|
val | boolean |
Returns
void
name
• get
name(): string
获取或设置文字样式名称。
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
newTextStyleRecord.name = "测试文字样式"
console.log(newTextStyleRecord.name) // 测试文字样式
Returns
string
• set
name(val
): void
Parameters
Name | Type |
---|---|
val | string |
Returns
void
objectName
• get
objectName(): string
获取对象名称。
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
console.log(obj.objectName);
Returns
string
返回对象名
Inherited from
McDbObject.objectName
obliquingAngle
• get
obliquingAngle(): number
倾斜角度
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
newTextStyleRecord.obliquingAngle = Math.PI/4;
console.log(newTextStyleRecord.obliquingAngle) // 45
Returns
number
• set
obliquingAngle(val
): void
Parameters
Name | Type |
---|---|
val | number |
Returns
void
textSize
• get
textSize(): number
文字大小(高度)
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
newTextStyleRecord.textSize = 20;
console.log(newTextStyleRecord.textSize) // 20
Returns
number
• set
textSize(val
): void
Parameters
Name | Type |
---|---|
val | number |
Returns
void
xScale
• get
xScale(): number
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
newTextStyleRecord.xScale = 0.8;
console.log(newTextStyleRecord.xScale) // 0.8
Returns
number
• set
xScale(val
): void
Parameters
Name | Type |
---|---|
val | number |
Returns
void
Methods
assertObjectModification
▸ assertObjectModification(autoUndo?
): number
设置对象被改变的状态,可自动触发更新显示函数,更新显示。 比如块表记录更新了,需要通知块引用更新显示,可以调用该函数。
Example
//假设obj为一个数据库对象
obj.assertObjectModification()
Parameters
Name | Type | Default value |
---|---|---|
autoUndo | boolean | false |
Returns
number
Inherited from
McDbObject.assertObjectModification
clone
▸ clone(): null
| McDbObject
克隆对象。
Example
//假设obj为一个数据库对象
const obj_clone = obj.clone();
Returns
null
| McDbObject
克隆出的对象。
Inherited from
createExtensionDictionary
▸ createExtensionDictionary(): boolean
创建对象的扩展字典数据.
Example
//假设obj为一个数据库对象
const res = obj.createExtensionDictionary();
Returns
boolean
Inherited from
McDbObject.createExtensionDictionary
erase
▸ erase(): boolean
删除对象。
Example
//假设obj为一个数据库对象
const res = obj.erase();
console.log(res);
Returns
boolean
是否删除成功。
Inherited from
font
▸ font(): Object
获取字体样式
Returns
Object
sTypeface: 字体名称 | bold: 是否粗体 | italic: 是否斜体 | charset: 字符集 | pitchAndFamily: 字体间距和风格
Name | Type |
---|---|
bold | boolean |
charset | number |
italic | boolean |
pitchAndFamily | number |
sTypeface | string |
getDatabase
▸ getDatabase(): McDbDatabase
得到对象所在的数据库
Example
//假设obj为一个数据库对象
const data = obj.getDatabase();
Returns
返回数据库
Inherited from
getDatabaseIndexId
▸ getDatabaseIndexId(): number
获取对象的索引ID
Example
//假设obj为一个数据库对象
const id = obj.getDatabaseIndexId();
Returns
number
Inherited from
getExtensionDictionary
▸ getExtensionDictionary(): McDbDictionary
得到对象的扩展字典数据.
Example
//假设obj为一个数据库对象
const id = obj.getOwnerID();
Returns
扩展字典数据
Inherited from
McDbObject.getExtensionDictionary
getGripPoints
▸ getGripPoints(): McGePoint3dArray
获取对象的控制点
Example
//假设obj为一个数据库对象
const ptArr = obj.getGripPoints();
Returns
Inherited from
getHandle
▸ getHandle(): string
得到对象句柄
Example
//假设obj为一个数据库对象
const handle = obj.getHandle();
Returns
string
返回对象句柄
Inherited from
getImp
▸ getImp(): any
获取内部实现对象。
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
let imp = obj.getImp();
Returns
any
内部实现对象。
Inherited from
getJson
▸ getJson(): string
获取 JSON 格式的字符串。
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
const json = obj.getJson()
Returns
string
JSON 格式的字符串。
Inherited from
getObjectID
▸ getObjectID(): McObjectId
获取对象 ID。
Example
import { McDbObject } from "mxcad";
const id = obj.getObjectID();
Returns
对象 ID。
Inherited from
getOwnerID
▸ getOwnerID(): number
得到对象拥用者的id
Example
//假设obj为一个数据库对象
const id = obj.getOwnerID();
Returns
number
Inherited from
initTempObject
▸ initTempObject(imp
): void
初始化临时对象。
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
obj.initTempObject()
Parameters
Name | Type | Description |
---|---|---|
imp | any | 内部实现对象。 |
Returns
void
Inherited from
isErased
▸ isErased(): boolean
对象是否已经删除
Example
//假设obj为一个数据库对象
const res = obj.isErased();
console.log(res);
Returns
boolean
Inherited from
isHaveExtensionDictionary
▸ isHaveExtensionDictionary(): boolean
是否有扩展字典数据.
Example
//假设obj为一个数据库对象
const res = obj.isHaveExtensionDictionary();
Returns
boolean
Inherited from
McDbObject.isHaveExtensionDictionary
isKindOf
▸ isKindOf(sObjectName
): boolean
判断对象类型
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
let isKind = obj.isKindOf('SomeObjectType');
console.log(isKind); // 输出: true 或 false
Parameters
Name | Type | Description |
---|---|---|
sObjectName | string | 类型名 |
Returns
boolean
返回对象是否是目标类型
Inherited from
isNull
▸ isNull(): any
判断是否为空对象
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
console.log(obj.isNull()); // 输出: true 或 false
Returns
any
Inherited from
moveGripPointsAt
▸ moveGripPointsAt(iIndex
, dXOffset
, dYOffset
, dZOffset
): any
移动对象的控制点
Example
//假设obj为一个数据库对象
obj.moveGripPointsAt(1,10,10,10);
Parameters
Name | Type | Description |
---|---|---|
iIndex | number | 索引 |
dXOffset | number | X轴偏移量 |
dYOffset | number | Y轴偏移量 |
dZOffset | number | Z轴偏移量 |
Returns
any
Inherited from
setFont
▸ setFont(sTypeface
, bold
, italic
, charset
, pitchAndFamily
): boolean
设置字体样式
Example
import { McDbTextStyleTableRecord } from 'mxcad';
const newTextStyleRecord = new McDbTextStyleTableRecord();
// 设置字体
const typeface = "Arial"; // 字体名称
const isBold = true; // 是否粗体
const isItalic = false; // 是否斜体
const charset = 0; // 字符集
const pitchAndFamily = 0; // 字体间距和风格
const isSetFontSuccessful = newTextStyleRecord.setFont(typeface, isBold, isItalic, charset, pitchAndFamily);
// 检查设置是否成功
if (isSetFontSuccessful) {
console.log("Font set successfully.");
} else {
console.log("Failed to set font.");
}
Parameters
Name | Type | Description |
---|---|---|
sTypeface | string | 字体名称 |
bold | boolean | 是否粗体 |
italic | boolean | 是否斜体 |
charset | number | 字符集 |
pitchAndFamily | number | 字体间距和风格 |
Returns
boolean
是否设置成功
setJson
▸ setJson(str
): boolean
设置 JSON 格式的字符串。
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
const res = obj.setJson('{"key": "value"}');
console.log(res)
Parameters
Name | Type | Description |
---|---|---|
str | string | JSON 格式的字符串。 |
Returns
boolean
是否设置成功。
Inherited from
unErase
▸ unErase(): boolean
反删除对象。
Example
//假设obj为一个数据库对象
const res = obj.unErase();
console.log(res);
Returns
boolean