Skip to content

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

Class: Mx3dAspectArrow ​

The Mx3dAspectArrow class is used to define the display properties of arrows. This class provides methods for setting arrow angle, length, color, and scaling properties.

Hierarchy ​

Table of contents ​

Constructors ​

Methods ​

Constructors ​

constructor ​

• new Mx3dAspectArrow()

Construct an arrow to display attribute objects.

Overrides ​

Mx3dAspectObject.constructor

• new Mx3dAspectArrow(anAngle, aLength)

Construct an arrow display attribute object with a specified angle and length.

Parameters ​

NameTypeDescription
AnglenumberThe angle of the arrow
ALengthnumberThe length of the arrow

Overrides ​

Mx3dAspectObject.constructor

Methods ​

Angle ​

▸ Angle(): number

Get the current angle of the arrow.

Returns ​

number

The angle of the current arrow.


IsZoomable ​

▸ IsZoomable(): boolean

Check if the arrow is scalable.

Returns ​

boolean

If the arrow is scalable, return true; Otherwise, return false.


Length ​

▸ Length(): number

Get the current length of the arrow.

Returns ​

number

The length of the current arrow.


SetAngle ​

▸ SetAngle(anAngle): void

Set the angle of the arrow.

Parameters ​

NameTypeDescription
An AngleNumberArrow angle to be set

Returns ​

void


SetColor ​

▸ SetColor(theColor): void

Set the color of the arrow.

Parameters ​

NameTypeDescription
TheColor[Mx3dGeColor] (Mx3dGeColor. md)The arrow color to be set

Returns ​

void


SetLength ​

▸ SetLength(theLength): void

Set the length of the arrow.

Parameters ​

NameTypeDescription
The LengthNumberThe length of the arrow to be set

Returns ​

void


SetZoomable ​

▸ SetZoomable(theIsZoomable): void

Set whether the arrow is scalable.

Parameters ​

NameTypeDescription
If 'theIsZoomable''boolean'is true, the arrow is scalable; Otherwise, it is false

Returns ​

void