Question

mxcad API 文档 / 2d / McDbText

Class: McDbText

2d.McDbText

表示一个 CAD 文字实体。

Hierarchy

• McDbEntity

  ↳ McDbText

  ↳↳ McDbAttribute

  ↳↳ McDbAttributeDefinition

Table of contents

Constructors

• constructor

Properties

• imp

Accessors

• alignmentPoint
• colorIndex
• dxf0
• height
• horizontalMode
• layer
• layerId
• linetype
• linetypeId
• linetypeScale
• lineweight
• objectName
• oblique
• position
• rotation
• textString
• textStyle
• textStyleId
• trueColor
• verticalMode
• visible
• widthFactor

Methods

• IntersectWith
• clone
• deleteXData
• disableDisplay
• erase
• explode
• getAllAppName
• getArea
• getBoundingBox
• getDatabase
• getHandle
• getImp
• getJson
• getObjectID
• getOwnerID
• getxData
• getxDataDouble
• getxDataLong
• getxDataPoint
• getxDataString
• highlight
• initTempObject
• isErased
• isKindOf
• isNull
• mirror
• move
• rotate
• scaleEntity
• setJson
• setxData
• setxDataDouble
• setxDataLong
• setxDataPoint
• setxDataString
• transformBy
• unErase

Constructors

constructor

• new McDbText(imp?)

构造函数。

Parameters

Name	Type	Description
imp?	any	实现对象。

Overrides

McDbEntity.constructor

Properties

imp

• Protected imp: any = 0

内部实现对象。

Inherited from

McDbEntity.imp

Accessors

alignmentPoint

• get alignmentPoint(): McGePoint3d

获取或设置文字的对齐点。

Returns

McGePoint3d

• set alignmentPoint(pt): void

Parameters

Name	Type
pt	McGePoint3d

Returns

void

---

colorIndex

• get colorIndex(): number

得到对象颜色索引

Returns

number

Inherited from

McDbEntity.colorIndex

• set colorIndex(val): void

设置对象颜色索引

Parameters

Name	Type
val	number

Returns

void

Inherited from

McDbEntity.colorIndex

---

dxf0

• get dxf0(): string

获取 DXF 代码 0 的值。

Returns

string

Inherited from

McDbEntity.dxf0

---

height

• get height(): number

获取或设置文字的高度。

Returns

number

• set height(val): void

Parameters

Name	Type
val	number

Returns

void

---

horizontalMode

• get horizontalMode(): TextHorzMode

获取或设置文字的水平对齐方式。

Returns

TextHorzMode

• set horizontalMode(val): void

Parameters

Name	Type
val	TextHorzMode

Returns

void

---

layer

• get layer(): string

得到对象图层名

Returns

string

Inherited from

McDbEntity.layer

• set layer(val): void

设置对象图层名

Parameters

Name	Type
val	string

Returns

void

Inherited from

McDbEntity.layer

---

layerId

• get layerId(): McObjectId

Returns

McObjectId

Inherited from

McDbEntity.layerId

• set layerId(id): void

Parameters

Name	Type
id	McObjectId

Returns

void

Inherited from

McDbEntity.layerId

---

linetype

• get linetype(): string

得到对象线型名

Returns

string

Inherited from

McDbEntity.linetype

• set linetype(val): void

设置对象线型名

Parameters

Name	Type
val	string

Returns

void

Inherited from

McDbEntity.linetype

---

linetypeId

• get linetypeId(): McObjectId

Returns

McObjectId

Inherited from

McDbEntity.linetypeId

• set linetypeId(id): void

Parameters

Name	Type
id	McObjectId

Returns

void

Inherited from

McDbEntity.linetypeId

---

linetypeScale

• get linetypeScale(): number

得到对象线型比例

Returns

number

Inherited from

McDbEntity.linetypeScale

• set linetypeScale(val): void

设置对象线型比例

Parameters

Name	Type
val	number

Returns

void

Inherited from

McDbEntity.linetypeScale

---

lineweight

• get lineweight(): number

得到对象线重

Returns

number

Inherited from

McDbEntity.lineweight

• set lineweight(val): void

设置对象线重

Parameters

Name	Type
val	number

Returns

void

Inherited from

McDbEntity.lineweight

---

objectName

• get objectName(): string

获取对象名称。

Returns

string

Inherited from

McDbEntity.objectName

---

oblique

• get oblique(): number

获取或设置文字的倾斜角度。

Returns

number

• set oblique(val): void

Parameters

Name	Type
val	number

Returns

void

---

position

• get position(): McGePoint3d

获取或设置文字的位置。

Returns

McGePoint3d

• set position(pt): void

Parameters

Name	Type
pt	McGePoint3d

Returns

void

---

rotation

• get rotation(): number

获取或设置文字的旋转角度。

Returns

number

• set rotation(pt): void

Parameters

Name	Type
pt	number

Returns

void

---

textString

• get textString(): string

获取或设置文字的字符串。

Returns

string

• set textString(val): void

Parameters

Name	Type
val	string

Returns

void

---

textStyle

• get textStyle(): string

得到对象文字样式

Returns

string

Inherited from

McDbEntity.textStyle

• set textStyle(val): void

设置对象文字样式

Parameters

Name	Type
val	string

Returns

void

Inherited from

McDbEntity.textStyle

---

textStyleId

• get textStyleId(): McObjectId

Returns

McObjectId

Inherited from

McDbEntity.textStyleId

• set textStyleId(id): void

Parameters

Name	Type
id	McObjectId

Returns

void

Inherited from

McDbEntity.textStyleId

---

trueColor

• get trueColor(): McCmColor

得到对象颜色

Returns

McCmColor

Inherited from

McDbEntity.trueColor

• set trueColor(val): void

设置对象颜色

Parameters

Name	Type
val	McCmColor

Returns

void

Inherited from

McDbEntity.trueColor

---

verticalMode

• get verticalMode(): TextVertMode

获取或设置文字的垂直对齐方式。

Returns

TextVertMode

• set verticalMode(val): void

Parameters

Name	Type
val	TextVertMode

Returns

void

---

visible

• get visible(): boolean

对象是否可见

Returns

boolean

Inherited from

McDbEntity.visible

• set visible(val): void

设置是否可见

Parameters

Name	Type
val	boolean

Returns

void

Inherited from

McDbEntity.visible

---

widthFactor

• get widthFactor(): number

获取或设置文字的宽度因子。

Returns

number

• set widthFactor(val): void

Parameters

Name	Type
val	number

Returns

void

Methods

IntersectWith

▸ IntersectWith(intersectObject, exOption): McGePoint3dArray

Parameters

Name	Type
intersectObject	McDbEntity
exOption	Intersect

Returns

McGePoint3dArray

Inherited from

McDbEntity.IntersectWith

---

clone

▸ clone(): null | McDbObject

克隆对象。

Returns

null | McDbObject

克隆出的对象。

Inherited from

McDbEntity.clone

---

deleteXData

▸ deleteXData(appName): boolean

Parameters

Name	Type
appName	string

Returns

boolean

Inherited from

McDbEntity.deleteXData

---

disableDisplay

▸ disableDisplay(isDisable): void

暂时禁用对象的自动更新显示.

Parameters

Name	Type
isDisable	boolean

Returns

void

Inherited from

McDbEntity.disableDisplay

---

erase

▸ erase(): boolean

删除对象。

Returns

boolean

是否删除成功。

Inherited from

McDbEntity.erase

---

explode

▸ explode(): MxCADResbuf

打碎对象，返回打后对象数据链表

Returns

MxCADResbuf

Inherited from

McDbEntity.explode

---

getAllAppName

▸ getAllAppName(): McGeStringArray

Returns

McGeStringArray

Inherited from

McDbEntity.getAllAppName

---

getArea

▸ getArea(): Object

计算面积

Returns

Object

Name	Type
ret	boolean
val	number

Inherited from

McDbEntity.getArea

---

getBoundingBox

▸ getBoundingBox(): Object

得到对象的最小外包

Returns

Object

Name	Type
maxPt	McGePoint3d
minPt	McGePoint3d
ret	boolean

Inherited from

McDbEntity.getBoundingBox

---

getDatabase

▸ getDatabase(): McDbDatabase

得到对象所在的数据库

Returns

McDbDatabase

Inherited from

McDbEntity.getDatabase

---

getHandle

▸ getHandle(): string

得到对象句柄

Returns

string

Inherited from

McDbEntity.getHandle

---

getImp

▸ getImp(): any

获取内部实现对象。

Returns

any

内部实现对象。

Inherited from

McDbEntity.getImp

---

getJson

▸ getJson(): string

获取 JSON 格式的字符串。

Returns

string

JSON 格式的字符串。

Inherited from

McDbEntity.getJson

---

getObjectID

▸ getObjectID(): McObjectId

获取对象 ID。

Returns

McObjectId

对象 ID。

Inherited from

McDbEntity.getObjectID

---

getOwnerID

▸ getOwnerID(): number

得到对象拥用者的id

Returns

number

Inherited from

McDbEntity.getOwnerID

---

getxData

▸ getxData(appName?): MxCADResbuf

得到对象的扩展数据

Parameters

Name	Type	Default value
appName	string	""

Returns

MxCADResbuf

Inherited from

McDbEntity.getxData

---

getxDataDouble

▸ getxDataDouble(appName): Object

Parameters

Name	Type
appName	string

Returns

Object

Name	Type
ret	boolean
val	number

Inherited from

McDbEntity.getxDataDouble

---

getxDataLong

▸ getxDataLong(appName): Object

Parameters

Name	Type
appName	string

Returns

Object

Name	Type
ret	boolean
val	number

Inherited from

McDbEntity.getxDataLong

---

getxDataPoint

▸ getxDataPoint(appName): Object

Parameters

Name	Type
appName	string

Returns

Object

Name	Type
ret	boolean
val	McGePoint3d

Inherited from

McDbEntity.getxDataPoint

---

getxDataString

▸ getxDataString(appName): Object

Parameters

Name	Type
appName	string

Returns

Object

Name	Type
ret	boolean
val	string

Inherited from

McDbEntity.getxDataString

---

highlight

▸ highlight(isHighlight): void

设置对象是否高亮

Parameters

Name	Type
isHighlight	boolean

Returns

void

Inherited from

McDbEntity.highlight

---

initTempObject

▸ initTempObject(imp): void

初始化临时对象。

Parameters

Name	Type	Description
imp	any	内部实现对象。

Returns

void

Inherited from

McDbEntity.initTempObject

---

isErased

▸ isErased(): boolean

对象是否已经删除

Returns

boolean

Inherited from

McDbEntity.isErased

---

isKindOf

▸ isKindOf(sObjectName): boolean

Parameters

Name	Type
sObjectName	string

Returns

boolean

Inherited from

McDbEntity.isKindOf

---

isNull

▸ isNull(): any

Returns

any

Inherited from

McDbEntity.isNull

---

mirror

▸ mirror(point1, point2): boolean

镜向对象

Parameters

Name	Type
point1	McGePoint3d
point2	McGePoint3d

Returns

boolean

Inherited from

McDbEntity.mirror

---

move

▸ move(fromPoint, toPoint): boolean

移动对象

Parameters

Name	Type
fromPoint	McGePoint3d
toPoint	McGePoint3d

Returns

boolean

Inherited from

McDbEntity.move

---

rotate

▸ rotate(basePoint, dRotationAngle): boolean

旋转对象

Parameters

Name	Type
basePoint	McGePoint3d
dRotationAngle	number

Returns

boolean

Inherited from

McDbEntity.rotate

---

scaleEntity

▸ scaleEntity(basePoint, dScaleFactor): boolean

缩放对象

Parameters

Name	Type
basePoint	McGePoint3d
dScaleFactor	number

Returns

boolean

Inherited from

McDbEntity.scaleEntity

---

setJson

▸ setJson(str): boolean

设置 JSON 格式的字符串。

Parameters

Name	Type	Description
str	string	JSON 格式的字符串。

Returns

boolean

是否设置成功。

Inherited from

McDbEntity.setJson

---

setxData

▸ setxData(xdata): boolean

设置对象的扩展数据

Parameters

Name	Type
xdata	MxCADResbuf

Returns

boolean

Inherited from

McDbEntity.setxData

---

setxDataDouble

▸ setxDataDouble(appName, val): boolean

Parameters

Name	Type
appName	string
val	number

Returns

boolean

Inherited from

McDbEntity.setxDataDouble

---

setxDataLong

▸ setxDataLong(appName, val): boolean

Parameters

Name	Type
appName	string
val	number

Returns

boolean

Inherited from

McDbEntity.setxDataLong

---

setxDataPoint

▸ setxDataPoint(appName, val): boolean

Parameters

Name	Type
appName	string
val	McGePoint3d

Returns

boolean

Inherited from

McDbEntity.setxDataPoint

---

setxDataString

▸ setxDataString(appName, val): boolean

Parameters

Name	Type
appName	string
val	string

Returns

boolean

Inherited from

McDbEntity.setxDataString

---

transformBy

▸ transformBy(transformationMatrix): boolean

变换对象

Parameters

Name	Type
transformationMatrix	McGeMatrix3d

Returns

boolean

Inherited from

McDbEntity.transformBy

---

unErase

▸ unErase(): boolean

反删除对象。

Returns

boolean

Inherited from

McDbEntity.unErase