SVGLength: convertToSpecifiedUnits() メソッド
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
convertToSpecifiedUnits() は SVGLength インターフェイスのメソッドで、長さの値を指定した単位型に変換することができます。
この関数は次のことを行います。
- 指定された単位型で
unitTypeプロパティを更新する valueInSpecifiedUnitsおよびvalueAsStringプロパティを更新し、長さの値が指定された単位型で表現されるようにする
構文
js
convertToSpecifiedUnits(unitType)
引数
unitType-
長さの値を変換する単位型を表す定数です。 これは、
unitTypeプロパティに対して定義された定数値のいずれかでなければならず、SVG_LENGTHTYPE_UNKNOWNは例外となります。SVGLength.SVG_LENGTHTYPE_NUMBER: 単位なしの値に変換SVGLength.SVG_LENGTHTYPE_PERCENTAGE: パーセント値に変換SVGLength.SVG_LENGTHTYPE_EMS: em 単位に変換SVGLength.SVG_LENGTHTYPE_EXS: ex 単位に変換SVGLength.SVG_LENGTHTYPE_PX: ピクセルに変換SVGLength.SVG_LENGTHTYPE_CM: センチメートルに変換SVGLength.SVG_LENGTHTYPE_MM: ミリメートルに変換SVGLength.SVG_LENGTHTYPE_IN: インチに変換SVGLength.SVG_LENGTHTYPE_PT: ポイントに変換SVGLength.SVG_LENGTHTYPE_PC: パイカに変換
返値
なし (undefined)。
例
長さを mm に変換
js
// SVGLength オブジェクトを取得
const svg = document.querySelector("svg");
const length = svg.createSVGLength();
// 長さの値をセンチメートルに設定
length.valueAsString = "0.5cm";
// 長さをミリメートルに変換
length.convertToSpecifiedUnits(SVGLength.SVG_LENGTHTYPE_MM);
console.log(length.unitType); // 出力: 7 (SVG_LENGTHTYPE_MM)
console.log(length.valueInSpecifiedUnits); // 出力: 5
console.log(length.valueAsString); // 出力: "5mm"
仕様書
| Specification |
|---|
| Scalable Vector Graphics (SVG) 2 # __svg__SVGLength__convertToSpecifiedUnits |