Options
All
• Public
• Public/Protected
• All

# Class Arc

An elliptical arc is a Shape that represents a general elliptical arc in the 2D space.

The elliptical arc is defined by:

An elliptical arc cannot be instantiated directly. It must be instantiated using createArc.

## Accessors

### a

• get a(): number
• set a(value: number): void
• The semi major axis of the ellipse defining the arc, in meters.

#### Returns number

• The semi major axis of the ellipse defining the arc, in meters.

### b

• get b(): number
• set b(value: number): void
• The semi minor axis of the ellipse defining the arc, in meters. This field is mutable.

#### Returns number

• The semi minor axis of the ellipse defining the arc, in meters. This field is mutable.

### center

• The center point of the ellipse defining the arc.

### coordinateType

• The coordinate type this shape. This property is read only. An Error will be thrown when trying to assign to this property.

### endPoint

• The end point of the arc. This field is read-only.

### focusPoint

• get focusPoint(): Point
• The focus point of the arc. This field is read-only.

### reference

• The spatial reference of this shape. This property is read only. An Error will be thrown when trying to assign to this property.

### rotationAzimuth

• get rotationAzimuth(): number
• set rotationAzimuth(value: number): void
• The rotation angle of the ellipse defining the arc. It is defined as an azimuth: degrees, clockwise, starting up/north. This field is mutable.

The value is normalized to the range -180° .. 180°.

#### Returns number

• The rotation angle of the ellipse defining the arc. It is defined as an azimuth: degrees, clockwise, starting up/north. This field is mutable.

The value is normalized to the range -180° .. 180°.

### startAzimuth

• get startAzimuth(): number
• set startAzimuth(value: number): void
• The start angle. It is defined as an azimuth: degrees, clockwise, starting up/north. This field is mutable.

#### Returns number

• The start angle. It is defined as an azimuth: degrees, clockwise, starting up/north. This field is mutable.

### startPoint

• get startPoint(): Point
• The start point of the arc. This field is read-only.

### sweepAngle

• get sweepAngle(): number
• set sweepAngle(value: number): void
• The angle over which the arc extends. It is defined in degrees, clockwise. This field is mutable.

#### Returns number

• The angle over which the arc extends. It is defined in degrees, clockwise. This field is mutable.

## Methods

### contains2D

• Determines whether a given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).

throws

InvalidReferenceError when passing a Point with another spatial reference

deprecated

#### Parameters

• ##### x: Point | number | Bounds

The point for which containment must be checked. If a 3D point is passed to this function, it will be treated as a 2D point: the z coordinate (height) will be ignored. The reference of this point must be the same reference as this Shape

#### Returns boolean

`true` when the given point is contained in this shape

### Abstract contains2DCoordinates

• (x: number, y: number): boolean
• Determines whether the given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).

throws

InvalidReferenceError when passing a Point with another spatial reference

#### Parameters

• ##### x: number

The x coordinate of the point for which containment must be checked

• ##### y: number

The y coordinate of the point for which containment must be checked

#### Returns boolean

`true` when the given point is contained in this shape

### contains2DPoint

• (point: Point): boolean
• Determines whether the given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).

throws

InvalidReferenceError when passing a Point with another spatial reference

#### Parameters

• ##### point: Point

The point for which containment must be checked.

#### Returns boolean

`true` when the given point is contained in this shape

### move2DToCoordinates

• (x: number, y: number): void
• Moves the center point of this arc to another location. The passed x and y coordinates are expressed in the reference of this arc. The passed coordinates will become the coordinates of the center point of this arc.

#### Parameters

• ##### x: number

the x coordinate of the point.

• ##### y: number

the y coordinate of the point.

### move2DToPoint

• Moves this center point of this arc to another location. The center point of this arc will be moved to the location of the passed point. The reference of the passed point must match the reference of the shape.

throws

InvalidReferenceError when the reference of the Point parameter does not correspond with the reference of this shape.

#### Parameters

• ##### point: Point

the point to move the arc's center point to.

• (): string

### Abstract translate2D

• (x: number, y: number): void
• Translates the shape over the given vector in 2D space.

#### Parameters

• ##### x: number

The x coordinate of the translation vector

• ##### y: number

The y coordinate of the translation vector

## Legend

• Module
• Object literal
• Variable
• Function
• Function with type parameter
• Index signature
• Type alias
• Type alias with type parameter
• Enumeration
• Enumeration member
• Property
• Method
• Interface
• Interface with type parameter
• Constructor
• Property
• Method
• Index signature
• Class
• Class with type parameter
• Constructor
• Property
• Method
• Accessor
• Index signature
• Inherited constructor
• Inherited property
• Inherited method
• Inherited accessor
• Protected property
• Protected method
• Protected accessor
• Private property
• Private method
• Private accessor
• Static property
• Static method