[mxcad_3d API Document](../README. md)/Mx3dSymbolText

Class: Mx3dSymbolText

Represents a text symbol, inherited from Mx3dSymbolObject

Hierarchy

• Mx3dSymbolObject

  ↳ Mx3dSymbolText

Table of contents

Constructors

• constructor

Methods

• FontAspect
• HasFlipping
• HasOrientation3D
• HasOwnAnchorPoint
• Orientation3D
• Position
• SetAngle
• SetColor
• SetColorSubTitle
• SetDisplayType
• SetFlipping
• SetFont
• SetFontAspect
• SetHJustification
• SetHeight
• SetOrientation3D
• SetOwnAnchorPoint
• SetPositon
• SetText
• SetVJustification
• SetZoomable
• UnsetOrientation3D

Constructors

constructor

• new Mx3dSymbolText()

Create a default text symbol object.

Overrides

Mx3dSymbolObject.constructor

• new Mx3dSymbolText(text, height, position)

Create a text symbol object using text, height, and position.

Parameters

Name	Type	Description
Text	string	Text content
Height	Number	Text height
Position	[Mx3dGePoint] (Mx3dGePoint. md)	Text position

Overrides

Mx3dSymbolObject.constructor

Methods

FontAspect

▸ FontAspect(): MxFontAspect

Get font style.

Returns

MxFontAspect

Font appearance style.

---

HasFlipping

▸ HasFlipping(): boolean

Check if it has been flipped.

Returns

boolean

Whether to flip.

---

HasOrientation3D

▸ HasOrientation3D(): boolean

Check if there is a 3D orientation.

Returns

boolean

Is there a 3D orientation.

---

HasOwnAnchorPoint

▸ HasOwnAnchorPoint(): boolean

Check if there are custom anchor points.

Returns

boolean

Is there a custom anchor point.

---

Orientation3D

▸ Orientation3D(): Mx3dGeCSYSR

Obtain 3D orientation.

Returns

Mx3dGeCSYSR

3D direction.

---

Position

▸ Position(): Mx3dGePoint

Get the text location.

Returns

Mx3dGePoint

Text location.

---

SetAngle

▸ SetAngle(theAngle): void

Set the text angle.

Parameters

Name	Type	Description
TheAngle	Number	Text angle

Returns

void

---

SetColor

▸ SetColor(theColor): void

Set text color.

Parameters

Name	Type	Description
TheColor	[Mx3dGeColor] (Mx3dGeColor. md)	Color object

Returns

void

▸ SetColor(theR, theG, theB): void

Set text color.

Parameters

Name	Type	Description
TheR	number	red component
TheG	Number	Green component
TheB	Number	Blue component

Returns

void

---

SetColorSubTitle

▸ SetColorSubTitle(theR, theG, theB): void

Set subtitle color.

Parameters

Name	Type	Description
TheR	number	red component
TheG	Number	Green component
TheB	Number	Blue component

Returns

void

---

SetDisplayType

▸ SetDisplayType(theDisplayType): void

Set display type.

Parameters

Name	Type	Description
The Display Type	[MxTypeOfDisplayText] (../enums/MdGe. MxTypeOfDisplayText. md)	Display Type

Returns

void

---

SetFlipping

▸ SetFlipping(theIsFlipping): void

Set whether to flip.

Parameters

Name	Type	Description
theIsFlipping	boolean	Whether to flip

Returns

void

---

SetFont

▸ SetFont(theFont): void

Set the font.

Parameters

Name	Type	Description
The font name is' theFont '	' string '

Returns

void

---

SetFontAspect

▸ SetFontAspect(theFontAspect): void

Set font style.

Parameters

Name	Type	Description
The FontAspect	[MxFontAspect] (../enums/MdGe. MxFontAspect. md)	Font Style

Returns

void

---

SetHJustification

▸ SetHJustification(theHJust): void

Set the horizontal alignment method.

Parameters

Name	Type	Description
TheHJust	[MxHorizontalTextAlignment] (../enums/MdGe. MxHorizontalTextAlignment. md)	Horizontal alignment method

Returns

void

---

SetHeight

▸ SetHeight(height): void

Set the text height.

Parameters

Name	Type	Description
Height	Number	Text height

Returns

void

---

SetOrientation3D

▸ SetOrientation3D(theOrientation): void

Set the 3D orientation.

Parameters

Name	Type	Description
The Orientation	[Mx3dGeCSYSR] (Mx3dGeCSYSR. md)	3D direction

Returns

void

---

SetOwnAnchorPoint

▸ SetOwnAnchorPoint(theOwnAnchorPoint): void

Set whether there is a custom anchor point.

Parameters

Name	Type	Description
Does' theOwnAnchorPoint '	' boolean '	have a custom anchor point

Returns

void

---

SetPositon

▸ SetPositon(position): void

Set the text position.

Parameters

Name	Type	Description
Position	[Mx3dGePoint] (Mx3dGePoint. md)	Text position

Returns

void

---

SetText

▸ SetText(text): void

Set the text content.

Parameters

Name	Type	Description
Text	string	Text content

Returns

void

---

SetVJustification

▸ SetVJustification(theVJust): void

Set the vertical alignment method.

Parameters

Name	Type	Description
TheVJust	[MxVerticalTextAlignment] (../enums/MdGe. MxVerticalTextAlignment. md)	Vertical alignment method

Returns

void

---

SetZoomable

▸ SetZoomable(theIsZoomable): void

Set whether it is scalable.

Parameters

Name	Type	Description
Is' theIsZoomable '	' boolean '	scalable

Returns

void

---

UnsetOrientation3D

▸ UnsetOrientation3D(): void

Cancel the 3D orientation setting.

Returns

void