aboutsummaryrefslogtreecommitdiff
path: root/files/ja/web/api/node/contains/index.md
blob: 6bcb67f897adebe24960557506326fbc0a94b0c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
---
title: Node.contains()
slug: Web/API/Node/contains
tags:
  - メソッド
  - リファレンス
browser-compat: api.Node.contains
translation_of: Web/API/Node/contains
---
{{APIRef("DOM")}}

**`contains()`** は {{domxref("Node")}} インターフェイスのメソッドで、あるノードが指定されたノードの子孫であるか、すなわち、このノード自体であるか、直接の子ノード ({{domxref("Node.childNodes", "childNodes")}}) の何れかであるか、直接の子ノードの子ノードの何れかであるか(以下同様)を示す論理値を返します。

> **Note:** ノードは自分自身に**含まれます**。

## 構文

```js
contains(otherNode);
```

### 引数

- `otherNode`
  - : 検査する {{domxref("Node")}} です。
    > **Note:** `otherNode` は省略できませんが、 `null` に設定することはできます。

### 返値

論理値で、 `true``otherNode` がそのノードに含まれていることを表します。
そうでなければ `false` になります。

`otherNode` 引数が `null` であれば、 `contains()` は常に `false` になります。

## 例

この関数は、ある要素がそのページの body 要素に含まれるかどうかを検査するものです。 `contains` は包括的かつ決定的であるため、 body がそれ自身を含むかどうかは `isInPage` の意図するところではないため、明示的に `false` を返します。

```js
function isInPage(node) {
  return (node === document.body) ? false : document.body.contains(node);
}
```

## 仕様書

{{Specifications}}

## ブラウザーの互換性

{{Compat}}

## 関連情報

- {{domxref("Node.compareDocumentPosition")}}
- {{domxref("Node.hasChildNodes")}}