Options
All
• Public
• Public/Protected
• All

# Class CircleBy3Points

Circle-by-3-points interface. A circle-by-3-points is a Shape that represents a circle defined by three points on its circumference in the 2D space.

The circle-by-3-points is defined by:

A circle-by-3-points cannot be instantiated directly. It must be instantiated using createCircleBy3Points.

## Accessors

### coordinateType

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

### firstPoint

• get firstPoint(): Point

### focusPoint

• get focusPoint(): Point

• The radius of this circle, in meters.

#### Returns number

• The radius of this circle, in meters.

### reference

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

### secondPoint

• get secondPoint(): Point

### thirdPoint

• get thirdPoint(): Point

## 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

### equals

• (aCircle: Shape): boolean

### move2DToCoordinates

• (x: number, y: number): void

### move2DToPoint

• Translates this shape so that its center ends up at the specified position.

throws

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

#### Parameters

• ##### point: Point

The location to move too.

### Abstract moveFirstPoint2DToCoordinates

• (x: number, y: number): void
• Moves the first point of this circle to the given coordinates

#### Parameters

• ##### x: number

The new x coordinate of the start point

• ##### y: number

The new y coordinate of the start point

### moveFirstPoint2DToPoint

• Moves the first point of this circle to the given point

#### Parameters

• ##### point: Point

The new coordinate of the start point

### Abstract moveSecondPoint2DToCoordinates

• (x: number, y: number): void
• Moves the second point of this circle to the given coordinates

#### Parameters

• ##### x: number

The new x coordinate of the first intermediate point on this circle

• ##### y: number

The new y coordinate of the first intermediate point on this circle

### moveSecondPoint2DToPoint

• Moves the second point of this circle to the given point.

#### Parameters

• ##### point: Point

The new coordinate of the first intermediate point on this circle

### Abstract moveThirdPoint2DToCoordinates

• (x: number, y: number): void
• Moves the second intermediate point of this circle to the given coordinates.

#### Parameters

• ##### x: number

The new x coordinate of the second intermediate point on this circle

• ##### y: number

The new y coordinate of the second intermediate point on this circle

### moveThirdPoint2DToPoint

• Moves the third point of this circle to the given point.

#### Parameters

• ##### point: Point

The new x coordinate of the second intermediate point on this circle

• (): 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

### Abstract translateFirstPoint2D

• (x: number, y: number): void
• Translates the first point of this circle from its current position over the given translation vector to another location.

#### Parameters

• ##### x: number

x coordinate value

• ##### y: number

y coordinate value

### Abstract translateSecondPoint2D

• (x: number, y: number): void
• Translates the second point of this circle from its current position over the given translation vector to another location.

#### Parameters

• ##### x: number

x coordinate value

• ##### y: number

y coordinate value

### Abstract translateThirdPoint2D

• (x: number, y: number): void
• Translates the third point of this circle from its current position over the given translation vector to another location.

#### Parameters

• ##### x: number

x coordinate value

• ##### y: number

y coordinate value

## 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