Math utilities provide mathematical functions and constants commonly used in chart calculations and geometry operations.
Constants
Value of π (pi), equivalent to Math.PI.
HALFPI
Value of π/2, equivalent to Math.PI / 2.
RADIANS
Conversion factor from degrees to radians (π/180).
DEGREES
Conversion factor from radians to degrees (180/π).
Rounding Functions
round()
function round(value: number, precision?: number, floor?: boolean): number
Precision (number of decimal points)
If value ends with 0.5 and precision is 0, floor the value instead of ceiling it
import { round } from "@amcharts/amcharts5";
console.log(round(3.14159)); // 3
console.log(round(3.14159, 2)); // 3.14
console.log(round(3.5, 0, true)); // 3 (floored)
console.log(round(3.5)); // 4 (rounded up)
ceil()
function ceil(value: number, precision: number): number
Precision (number of decimal points)
import { ceil } from "@amcharts/amcharts5";
console.log(ceil(3.14159, 0)); // 4
console.log(ceil(3.14159, 2)); // 3.15
Trigonometric Functions
sin()
function sin(angle: number): number
import { sin } from "@amcharts/amcharts5";
console.log(sin(90)); // 1
console.log(sin(30)); // 0.5
cos()
function cos(angle: number): number
import { cos } from "@amcharts/amcharts5";
console.log(cos(0)); // 1
console.log(cos(90)); // 0
tan()
function tan(angle: number): number
Angle Functions
normalizeAngle()
function normalizeAngle(value: number): number
import { normalizeAngle } from "@amcharts/amcharts5";
console.log(normalizeAngle(450)); // 90
console.log(normalizeAngle(-90)); // 270
getAngle()
function getAngle(point1: IPoint, point2?: IPoint): number
First point with x and y coordinates
import { getAngle } from "@amcharts/amcharts5";
const angle = getAngle({ x: 0, y: 0 }, { x: 100, y: 100 });
console.log(angle); // 45
fitAngleToRange()
function fitAngleToRange(
value: number,
startAngle: number,
endAngle: number
): number
Range Functions
fitToRange()
function fitToRange(value: number, min: number, max: number): number
import { fitToRange } from "@amcharts/amcharts5";
console.log(fitToRange(150, 0, 100)); // 100
console.log(fitToRange(-10, 0, 100)); // 0
console.log(fitToRange(50, 0, 100)); // 50
closest()
function closest(values: number[], referenceValue: number): number
Array of values to search
Reference value to compare against
Closest value from the array
import { closest } from "@amcharts/amcharts5";
const values = [10, 20, 30, 40, 50];
console.log(closest(values, 27)); // 30
console.log(closest(values, 12)); // 10
Point and Curve Functions
getArcPoint()
function getArcPoint(radius: number, arc: number): IPoint
Point on the arc with x and y coordinates
getPointOnLine()
function getPointOnLine(
pointA: IPoint,
pointB: IPoint,
position: number
): IPoint
Position on the line (0-1, where 0 is pointA and 1 is pointB)
import { getPointOnLine } from "@amcharts/amcharts5";
const pointA = { x: 0, y: 0 };
const pointB = { x: 100, y: 100 };
const midpoint = getPointOnLine(pointA, pointB, 0.5);
console.log(midpoint); // { x: 50, y: 50 }
getPointOnQuadraticCurve()
function getPointOnQuadraticCurve(
pointA: IPoint,
pointB: IPoint,
controlPoint: IPoint,
position: number
): IPoint
Control point for the curve
Position on the curve (0-1)
getCubicControlPointA()
function getCubicControlPointA(
p0: IPoint,
p1: IPoint,
p2: IPoint,
tensionX: number,
tensionY: number
): IPoint
getCubicControlPointB()
function getCubicControlPointB(
p1: IPoint,
p2: IPoint,
p3: IPoint,
tensionX: number,
tensionY: number
): IPoint
Bounds Functions
getArcBounds()
function getArcBounds(
cx: number,
cy: number,
startAngle: number,
endAngle: number,
radius: number
): IBounds
Bounding box with left, top, right, bottom properties
mergeBounds()
function mergeBounds(bounds: IBounds[]): IBounds
Array of bounding boxes to merge
inBounds()
function inBounds(point: IPoint, bounds: IBounds): boolean
True if point is within bounds
boundsOverlap()
function boundsOverlap(bounds1: IBounds, bounds2: IBounds): boolean
Collision Detection
circlesOverlap()
function circlesOverlap(
circle1: { x: number; y: number; radius: number },
circle2: { x: number; y: number; radius: number }
): boolean
circle1
{ x: number; y: number; radius: number }
required
First circle with center coordinates and radius
circle2
{ x: number; y: number; radius: number }
required
Second circle with center coordinates and radius
import { circlesOverlap } from "@amcharts/amcharts5";
const circle1 = { x: 0, y: 0, radius: 10 };
const circle2 = { x: 15, y: 0, radius: 10 };
console.log(circlesOverlap(circle1, circle2)); // true (they overlap)
Spiral Functions
spiralPoints()
function spiralPoints(
cx: number,
cy: number,
radius: number,
radiusY: number,
innerRadius: number,
step: number,
radiusStep: number,
startAngle: number,
endAngle: number
): IPoint[]
Vertical radius (for elliptical spirals)
How much radius increases per revolution
Array of points along the spiral
See Also