HTML
 Computer >> コンピューター >  >> プログラミング >> HTML

HTML DOMのembedsコレクションとは？プロパティ・メソッドと使い方を徹底解説

HTML DOMのembedsコレクションは、HTMLドキュメント内に存在する<embed>要素をまとめて管理するためのコレクションです。このコレクションを利用することで、ドキュメント内の埋め込み要素の数を取得したり、特定の要素へアクセスしたりできます。なお、コレクション内の要素は、HTMLドキュメントに出現する順序と同じ順序で格納されます。

embedsコレクションのプロパティ

embedsコレクションには、以下のプロパティが用意されています。

プロパティ説明
lengthコレクション内に存在する<embed>要素の数を返します。このプロパティは読み取り専用のため、値を変更することはできません。

embedsコレクションのメソッド

embedsコレクションには、以下の3つのメソッドが用意されています。

メソッド説明
[index]指定したインデックス番号に対応する<embed>要素をコレクションから返します。インデックスは0から始まり、範囲外の番号を指定した場合はnullが返されます。
item(index)[index]と同様に、指定したインデックス番号に対応する<embed>要素をコレクションから返します。インデックスは0から始まり、範囲外の場合はnullが返されます。
namedItem(id)指定したidに関連付けられた<embed>要素をコレクションから返します。該当するidが存在しない場合はnullが返されます。

構文

embedsコレクションの基本的な構文は以下の通りです。

document.embeds

サンプルコード

それでは、HTML DOMのembedsコレクションを使った具体的な例を見ていきましょう。次のコードでは、ボタンをクリックするとドキュメント内の<embed>要素の数が表示されます。

<!DOCTYPE html>
<html>
<head>
<style>
    .EMB{
        width:200px;
        height:200px;
        border:4px solid blue;
    }
</style>
</head>
<body>
<h1>Embeds collection example</h1>
<p>Get the number of embeds element in this document by clicking the below button.</p>
<embed class="EMB" src="Text-collection.pdf">
<embed class="EMB" src="Text-collection.pdf">
<br><br>
<button onclick="embedsNo()">GET COUNT</button>
<p id="Sample"></p>
<script>
    function embedsNo() {
        var e = document.embeds.length;
        document.getElementById("Sample").innerHTML ="The number of embed elements in this document are " + e;
    }
</script>
</body>
</html>

実行結果

上記のコードを実行すると、次のような画面が表示されます。

HTML DOMのembedsコレクションとは？プロパティ・メソッドと使い方を徹底解説

「GET COUNT」ボタンをクリックすると、以下のように要素の数が出力されます。

HTML DOMのembedsコレクションとは？プロパティ・メソッドと使い方を徹底解説

コードの解説

このサンプルコードの仕組みを順番に見ていきましょう。

1. embed要素の作成とスタイル適用

まず、共通のclass属性値を持つ2つの<embed>要素を作成し、CSSでスタイルを適用しています。

.EMB{
    width:200px;
    height:200px;
    border:4px solid blue;
}
<embed class="EMB" src="Text-collection.pdf">
<embed class="EMB" src="Text-collection.pdf">

2. ボタンの設置

次に、ユーザーがクリックするとembedsNo()関数を実行する「GET COUNT」ボタンを作成しています。

<button onclick="embedsNo()">GET COUNT</button>

3. 要素数の取得と表示

embedsNo()関数では、document.embeds.lengthの値を取得して変数eに代入しています。このドキュメントには<embed>要素が2つしか存在しないため、embeds.lengthは「2」を返します。

その後、idが「Sample」である段落要素のinnerHTMLプロパティにテキストを設定することで、取得した値を画面に表示しています。

function embedsNo() {
    var e = document.embeds.length;
    document.getElementById("Sample").innerHTML ="The number of embed elements in this document are " + e;
}

このように、embedsコレクションを使えば、ドキュメント内の埋め込み要素を簡単に操作できます。特にlengthプロパティは要素数の確認に便利なので、ぜひ活用してみてください。

  1. HTML DOM HRオブジェクトとは？作成方法と使い方を解説

    HTML DOM の HR オブジェクトは、HTML 文書内の <hr> 要素を表すオブジェクトです。<hr> 要素は、コンテンツの話題やテーマの区切りを視覚的に示す水平線（罫線）として表示されます。JavaScript を使えば、この水平線を動的に生成してページに挿入することも可能です。ここでは、HR オブジェクトの基本的な作成方法と実践的な使用例を紹介します。HRオブジェクトの作成方法（構文）hr オブジェクトを新しく作成するには、document.createElement() メソッドを使用します。構文は以下のとおりです。document.createEleme

  2. HTML DOM Ulオブジェクトとは？<ul>要素の操作方法とサンプルコードを解説

    HTML DOM の Ul オブジェクトは、HTML の <ul>（順序なしリスト）要素を表すオブジェクトです。JavaScript を使うことで、リストの動的な生成や操作が可能になります。 <ul> 要素の作成方法 新しい <ul> 要素を作成するには、document.createElement() メソッドを使用します。 var ulObject = document.createElement(UL) HTML5で非推奨となったプロパティ ulObject には以下のプロパティが存在しますが、これらは HTML5 ではサポートされていないため注