Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces
2.1.51 (release candidate)
collection
interactivityModel
Interfaces

geometry.pixel.Circle

Extends IPixelCircleGeometry.

The "Circle" pixel geometry.

Constructor | Fields | Methods

Constructor

geometry.pixel.Circle(coordinates, radius[, metaData])

Parameters:

ParameterDefault valueDescription
coordinates *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Number[]|null

Coordinates of the center of the circle.

radius *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Number|null

Radius of the circle.

metaData

Type: Object

Metadata.

* Mandatory parameter/option.

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

Methods

NameReturnsDescription
equals(geometry)

Boolean

Returns true if the passed geometry is equivalent to the given one.

Inherited from IPixelGeometry.

getBounds()

Number[][]|null

Returns coordinates of the two opposite corners of the area that surrounds the geometry. The first item in the array is the corner with the smallest coordinate values relative to the rest of the points in the area; the second item is the corner with the largest coordinate values.

Inherited from IBaseGeometry.

getCoordinates()

Number[]

Returns coordinates of the center of the circle.

Inherited from IPixelCircleGeometry.

getMetaData()

Object

Returns metadata of the pixel geometry.

Inherited from IPixelGeometry.

getRadius()

Number

Returns radius of the circle.

Inherited from IPixelCircleGeometry.

getType()

String

Returns ID of the geometry type.

Inherited from IBaseGeometry.

scale(factor)

IPixelGeometry

Creates a scaled copy of the geometry.

Inherited from IPixelGeometry.

shift(offset)

IPixelGeometry

Creates a copy of the geometry that is shifted by the specified amount.

Inherited from IPixelGeometry.