JXG.Circle

Class

Creates a new circle object. Do not use this constructor to create a circle. Use JXG.Board#create with type Circle instead.

Attributes

Own

none

Inherited

Members

Own

center : JXG.Point

Description

The circles center. Do not set this parameter directly as it will break JSXGraph's update system.

Type
JXG.Point
Source
base/circle.js, line 102

circle : JXG.Circle

Description

Circle defining the radius of the circle given by the radius of the other circle only set if method equals 'pointLine'. Do not set this parameter directly as it will break JSXGraph's update system.

Type
JXG.Circle
Default Value
null
See
Source
base/circle.js, line 132

line : JXG.Line

Description

Line defining the radius of the circle given by the distance from the startpoint and the endpoint of the line only set if method equals 'pointLine'. Do not set this parameter directly as it will break JSXGraph's update system.

Type
JXG.Line
Default Value
null
See
Source
base/circle.js, line 124

method : String

Description

Stores the given method. Can be

  • 'twoPoints' which means the circle is defined by its center and a point on the circle.
  • 'pointRadius' which means the circle is defined by its center and its radius given in user units or as term.
  • 'pointLine' which means the circle is defined by its center and its radius given by the distance from the startpoint and the endpoint of the line.
  • 'pointCircle' which means the circle is defined by its center and its radius given by the radius of another circle.
Type
String
See
Source
base/circle.js, line 93

point2 : JXG.Point

Description

Point on the circle only set if method equals 'twoPoints'. Do not set this parameter directly as it will break JSXGraph's update system.

Type
JXG.Point
See
Source
base/circle.js, line 108

radius : Number

Description

Radius of the circle only set if method equals 'pointRadius'

Type
Number
Default Value
0
See
Source
base/circle.js, line 116

Inherited

Methods

Own

Area() → {Number}

Circle area

Returns

area of the circle.

Type
Number

Details

Source
base/circle.js, line 820

Diameter() → {Number}

Calculates the diameter of the circle.

Returns

The Diameter of the circle

Type
Number

Details

Source
base/circle.js, line 569

Perimeter() → {Number}

Perimeter (circumference) of circle.

Returns

Perimeter of circle in user units.

Type
Number

Details

Source
base/circle.js, line 830

Radius(valueopt) → {Number}

Calculates the radius of the circle.

Parameters

Name Type Attributes Description
value String | Number | function <optional>

Set new radius

Returns

The radius of the circle

Type
Number

Details

Source
base/circle.js, line 535

X(t) → {Number}

Treats the circle as parametric curve and calculates its X coordinate.

Parameters

Name Type Description
t Number

Number between 0 and 1.

Returns

X(t)= radius*cos(t)+centerX.

Type
Number

Details

Source
base/circle.js, line 778

Y(t) → {Number}

Treats the circle as parametric curve and calculates its Y coordinate.

Parameters

Name Type Description
t Number

Number between 0 and 1.

Returns

X(t)= radius*sin(t)+centerY.

Type
Number

Details

Source
base/circle.js, line 787

Z(t) → {Number}

Treat the circle as parametric curve and calculates its Z coordinate.

Parameters

Name Type Description
t Number

ignored

Returns

1.0

Type
Number

Details

Source
base/circle.js, line 796

addTransform(transform) → {JXG.Circle}

Add transformations to this circle.

Parameters

Name Type Description
transform JXG.Transformation | Array

Either one JXG.Transformation or an array of JXG.Transformations.

Returns

Reference to this circle object.

Type
JXG.Circle

Details

Overrides
JXG.GeometryElement#addTransform
Source
base/circle.js, line 707

bounds() → {Array}

Get bounding box of the circle.

Returns

[x1, y1, x2, y2]

Type
Array

Details

Overrides
JXG.GeometryElement#bounds
Source
base/circle.js, line 838

(private) generateRadiusSquared() → {String}

Generate symbolic radius calculation for loci determination with Groebner-Basis algorithm.

Returns

String containing symbolic calculation of the circle's radius or an empty string if the radius can't be expressed in a polynomial equation.

Type
String

Details

Source
base/circle.js, line 309

getParents() → {Array}

Get data to construct this element. Data consists of the parent elements and static data like radius.

Returns

data necessary to construct this element

Type
Array

Details

Overrides
JXG.GeometryElement#getParents
Source
base/circle.js, line 850

getRadius()

Use JXG.Circle#Radius.

Details

Deprecated
Yes
Source
base/circle.js, line 577

(private) hasPoint(x, y) → {Boolean}

Checks whether (x,y) is near the circle line or inside of the ellipse (in case JXG.Options.conic#hasInnerPoints is true).

Parameters

Name Type Description
x Number

Coordinate in x direction, screen coordinates.

y Number

Coordinate in y direction, screen coordinates.

Returns

True if (x,y) is near the circle, False otherwise.

Type
Boolean

Details

Overrides
JXG.GeometryElement#hasPoint
Source
base/circle.js, line 219

(private) maxX()

Returns 1.

Details

Source
base/circle.js, line 812

(private) minX()

Returns 0.

Details

Source
base/circle.js, line 804

(private) notifyParents(contentStr)

Finds dependencies in a given term and resolves them by adding the elements referenced in this string to the circle's list of ancestors.

Parameters

Name Type Description
contentStr String

Details

Source
base/circle.js, line 511

setRadius(r) → {JXG.Circle}

Set a new radius, then update the board.

Parameters

Name Type Description
r String | Number | function

A string, function or number describing the new radius.

Returns

Reference to this circle

Type
JXG.Circle

Details

Source
base/circle.js, line 522

update()

Uses the boards renderer to update the circle.

Details

Overrides
JXG.GeometryElement#update
Source
base/circle.js, line 355

(private) updateQuadraticform()

Updates this circle's JXG.GeometryElement#quadraticform.

Details

Source
base/circle.js, line 412

(private) updateRenderer()

Uses the boards renderer to update the circle.

Details

Overrides
JXG.GeometryElement#updateRenderer
Source
base/circle.js, line 449

(private) updateStdform()

Updates the stdform derived from the position of the center and the circle's radius.

Details

Source
base/circle.js, line 429

Inherited

Events

Own

none

Inherited

Parameters

Name Type Description
board JXG.Board

The board the new circle is drawn on.

method String

Can be

  • 'twoPoints' which means the circle is defined by its center and a point on the circle.
  • 'pointRadius' which means the circle is defined by its center and its radius in user units
  • 'pointLine' which means the circle is defined by its center and its radius given by the distance from the startpoint and the endpoint of the line
  • 'pointCircle' which means the circle is defined by its center and its radius given by the radius of another circle

The parameters p1, p2 and radius must be set according to this method parameter.

par1 Point

center of the circle.

par2 Point | Line | Circle

Can be

  • a point on the circle if method is 'twoPoints'
  • a line if the method is 'pointLine'
  • a circle if the method is 'pointCircle'
attributes Object

Details

See
Source
base/circle.js, line 75

Extends