Options
All
• Public
• Public/Protected
• All

# Class CircleByCenterPoint

Circle-by-center-point interface. A circle-by-center-point is a Shape that represents a general circle defined by a center point and a radius in the 2D space.

The circle-by-center-point is defined by:

• The point (read-only).
• The length of its radius (read-write).
A circle-by-center-point cannot be instantiated directly. It must be instantiated using createCircleByCenterPoint.

## Accessors

### coordinateType

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

### focusPoint

• get focusPoint(): Point

• get radius(): number
• set radius(value: number): void
• 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.

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

• (): string

### translate2D

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

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