Range: compareBoundaryPoints() メソッド

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2017.

Range.compareBoundaryPoints() メソッドは、 Range の境界点を別の範囲のものと比較します。

構文

js
compareBoundaryPoints(how, sourceRange)

引数

how

定数で、比較メソッドを説明します。

  • Range.END_TO_ENDsourceRange の終わりの境界点と Range の終わりの境界点を比較します。
  • Range.END_TO_STARTsourceRange の終わりの境界点と Range の始まりの境界点を比較します。
  • Range.START_TO_ENDsourceRange の始まりの境界点と Range の終わりの境界点を比較します。
  • Range.START_TO_STARTsourceRange の始まりの境界点と Range の始まりの境界点を比較します。
sourceRange

範囲との境界点を比較するための Range です。

返値

-1, 0, 1 のいずれかの数値で、 Range の対応する境界点が sourceRange の対応する境界点より前か、等しいか、後かを示します。

例外

NotSupportedError DOMException

how 引数の値が無効な場合に発生します。

js
const range = document.createRange();
range.selectNode(document.querySelector("div"));
const sourceRange = document.createRange();
sourceRange.selectNode(document.getElementsByTagName("div")[1]);
const compare = range.compareBoundaryPoints(Range.START_TO_END, sourceRange);

仕様書

Specification
DOM Standard
# dom-range-compareboundarypoints

ブラウザーの互換性

BCD tables only load in the browser

関連情報