[mxcad_3d API documentation](../README. md)/Mx3dAspectDim

Class: Mx3dAspectDim

The Mx3dAspectDim class defines the attribute of displaying dimensions in 3D representations. This includes the setting of lines, text, and arrows related to size measurement.

Hierarchy

• Mx3dAspectObject

  ↳ Mx3dAspectDim

Table of contents

Constructors

• constructor

Methods

• ArrowOrientation
• ArrowTailSize
• ExtensionSize
• IsArrows3d
• IsText3d
• IsTextShaded
• IsUnitsDisplayed
• MakeArrows3d
• MakeText3d
• MakeTextShaded
• MakeUnitsDisplayed
• SetArrowAspect
• SetArrowOrientation
• SetArrowTailSize
• SetCommonColor
• SetExtensionSize
• SetLineAspect
• SetTextAspect
• SetTextHorizontalPosition
• SetTextVerticalPosition
• SetValueStringFormat
• TextHorizontalPosition
• TextVerticalPosition
• ValueStringFormat

Constructors

constructor

• new Mx3dAspectDim()

Constructor, create a default display size attribute object.

Overrides

Mx3dAspectObject.constructor

Methods

ArrowOrientation

▸ ArrowOrientation(): MxDimensionArrowOrientation

Obtain the direction of the arrow.

Returns

MxDimensionArrowOrientation

Arrow direction.

---

ArrowTailSize

▸ ArrowTailSize(): number

Get the size of the arrow tail.

Returns

number

Size value.

---

ExtensionSize

▸ ExtensionSize(): number

Obtain the size of the extension dimension.

Returns

number

Size value.

---

IsArrows3d

▸ IsArrows3d(): boolean

Check if the arrow is in 3D.

Returns

boolean

If the arrow is 3D, return true; otherwise, return false.

---

IsText3d

▸ IsText3d(): boolean

Check if the size text is in 3D.

Returns

boolean

If the text is 3D, return true; otherwise, return false.

---

IsTextShaded

▸ IsTextShaded(): boolean

Check if there are shadows in the 3D size text.

Returns

boolean

If the text has shadows, return true; otherwise, return false.

---

IsUnitsDisplayed

▸ IsUnitsDisplayed(): boolean

Check if the unit is displayed.

Returns

boolean

If the unit is displayed, return true; otherwise, return false.

---

MakeArrows3d

▸ MakeArrows3d(theIsArrows3d): void

Set the arrow to 3D or 2D.

Parameters

Name	Type	Description
theIsArrows3d	boolean	If true, set the arrow to 3D; Otherwise, it is 2D

Returns

void

---

MakeText3d

▸ MakeText3d(isText3d): void

Set the size text to 3D or 2D.

Parameters

Name	Type	Description
IsText3d	boolean	If true, set the text to 3D; Otherwise, it is 2D

Returns

void

---

MakeTextShaded

▸ MakeTextShaded(theIsTextShaded): void

Turn on or off shadows for 3D sized text.

Parameters

Name	Type	Description
If theIsTextChaded	boolean	is true, turn on shadows; Otherwise, turn off the shadow

Returns

void

---

MakeUnitsDisplayed

▸ MakeUnitsDisplayed(theIsDisplayed): void

Set whether to display units.

Parameters

Name	Type	Description
theIsDisplayed	boolean	If true, display units; Otherwise, it will not be displayed

Returns

void

---

SetArrowAspect

▸ SetArrowAspect(theAspect): void

Set the display properties of the size arrow.

Parameters

Name	Type	Description
The Aspect	[Mx3dAspectArrow] (Mx3dAspectArrow. md)	Arrow display properties

Returns

void

---

SetArrowOrientation

▸ SetArrowOrientation(theArrowOrient): void

Set the direction of the arrow (external or internal).

Parameters

Name	Type	Description
The ArrowOrientation	[MxDimension ArrowOrientation] (../enums/MdGe. MxDimension ArrowOrientation. md)	Arrow direction

Returns

void

---

SetArrowTailSize

▸ SetArrowTailSize(theSize): void

Set the size of the arrow tail (without text extension).

Parameters

Name	Type	Description
TheSize	Number	Size value

Returns

void

---

SetCommonColor

▸ SetCommonColor(theColor): void

Set the same color for all parts of the size (lines, arrows, and text).

Parameters

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

Returns

void

---

SetExtensionSize

▸ SetExtensionSize(theSize): void

Set the size of the extension dimension.

Parameters

Name	Type	Description
TheSize	Number	Size value

Returns

void

---

SetLineAspect

▸ SetLineAspect(theAspect): void

Set the display properties of dimension lines.

Parameters

Name	Type	Description
The Aspect	[Mx3dAspectLine] (Mx3dAspectLine. md)	Line display properties

Returns

void

---

SetTextAspect

▸ SetTextAspect(theAspect): void

Set the display properties of size text.

Parameters

Name	Type	Description
The Aspect	[Mx3dAspectText] (Mx3dAspectText. md)	Text display properties

Returns

void

---

SetTextHorizontalPosition

▸ SetTextHorizontalPosition(thePosition): void

Set the horizontal position of the text.

Parameters

Name	Type	Description
ThePosition	[MxDimension TextHorizontalPosition] (../enums/MdGe. MxDimension TextHorizontalPosition. md)	The horizontal position of the text

Returns

void

---

SetTextVerticalPosition

▸ SetTextVerticalPosition(thePosition): void

Set the vertical position of the text.

Parameters

Name	Type	Description
ThePosition	[MxDimension TextVerticalPosition] (../enums/MdGe. MxDimension TextVerticalPosition. md)	The vertical position of the text

Returns

void

---

SetValueStringFormat

▸ SetValueStringFormat(theFormat): void

Set the syntax format for formatting size value labels.

Parameters

Name	Type	Description
TheFormat	String	Format string

Returns

void

---

TextHorizontalPosition

▸ TextHorizontalPosition(): MxDimensionTextHorizontalPosition

Retrieve the horizontal position of the text.

Returns

MxDimensionTextHorizontalPosition

The horizontal position of the text.

---

TextVerticalPosition

▸ TextVerticalPosition(): MxDimensionTextVerticalPosition

Get the vertical position of the text.

Returns

MxDimensionTextVerticalPosition

The vertical position of the text.

---

ValueStringFormat

▸ ValueStringFormat(): string

Obtain the format of the size value label.

Returns

string

Format string.