SVGAngle: convertToSpecifiedUnits() method
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.
The convertToSpecifiedUnits()
method of the SVGAngle
interface allows you to convert the angle's value to the specified unit type.
This function will:
- Set the
unitType
property to the given unit type - Update the
valueInSpecifiedUnits
andvalueAsString
properties so the angle value is represented in the given unit type
Syntax
js
svgAngle.convertToSpecifiedUnits(unitType)
Parameters
unitType
-
A constant representing the unit type to which the angle's value should be converted. This must be one of the constant values defined for the
unitType
property, with the exception ofSVG_ANGLETYPE_UNKNOWN
.SVGAngle.SVG_ANGLETYPE_DEG
: convert to degreesSVGAngle.SVG_ANGLETYPE_RAD
: convert to radiansSVGAngle.SVG_ANGLETYPE_GRAD
: convert to gradiansSVGAngle.SVG_ANGLETYPE_UNSPECIFIED
: convert to a unitless number, interpreted as degrees
Return value
None (undefined
).
Examples
Converting an angle to degrees
js
// Get an SVGAngle object
const svg = document.querySelector("svg");
const angle = svg.createSVGAngle();
// Set the angle's value in radians (Math.PI / 2)
angle.newValueSpecifiedUnits(SVGAngle.SVG_ANGLETYPE_RAD, Math.PI / 2);
// Retrieve the angle's value as a string
console.log(angle.valueAsString); // Output: 1.5708rad
console.log(angle.unitType); // Output: 3 (SVG_ANGLETYPE_RAD)
// Convert the angle's value to degrees
angle.convertToSpecifiedUnits(SVGAngle.SVG_ANGLETYPE_DEG);
// Retrieve the angle's value as a string
console.log(angle.valueAsString); // Output: 90deg
console.log(angle.unitType); // Output: 2 (SVG_ANGLETYPE_DEG)
Specifications
Specification |
---|
Scalable Vector Graphics (SVG) 2 # __svg__SVGAngle__convertToSpecifiedUnits |
Browser compatibility
BCD tables only load in the browser