Topic(索引の項目)のコレクション
Ver. | プロパティ名 | R/O | 値 | 説明 |
---|---|---|---|---|
length | ○ | 数値 | オブジェクト数 |
Ver. | メソッドの書式 | 戻り値 | メソッドの説明 | ||
---|---|---|---|---|---|
パラメータ | 値 | パラメータの説明 | |||
add(name, [sortBy], [withProperties]) | Topic | 新しいオブジェクトを作成し、それを返す | |||
name | 文字列値 | 名前 | |||
[sortBy] | 文字列値 | ||||
[withProperties] | Object | プロパティを設定 | |||
anyItem() | Topic | どれかのオブジェクトを返す | |||
count() | 数値 | 要素数を返す | |||
everyItem() | Array( Topic ) | 全てのオブジェクトを返す | |||
firstItem() | Topic | 最初のオブジェクトを返す | |||
item(index) | Topic | インデックスまたは名前で指定したオブジェクトを返す | |||
index | 数値, 文字列値 | インデックスまたは名前 | |||
itemByName(name) | Topic | 名前で指定したオブジェクトを返す | |||
name | 文字列値 | ||||
itemByRange(from, to) | Array( Topic ) | 範囲で指定したオブジェクトを返す | |||
from | Topic, 数値, 文字列値 | 範囲の開始 | |||
to | Topic, 数値, 文字列値 | 範囲の終了 | |||
lastItem() | Topic | 最後のオブジェクトを返す | |||
middleItem() | Topic | 真ん中のオブジェクトを返す | |||
nextItem(obj) | Topic | 一つ後のオブジェクトを返す | |||
obj | Topic | 位置の基準になるオブジェクト | |||
previousItem(obj) | Topic | 一つ前のオブジェクトを返す | |||
obj | Topic | 位置の基準になるオブジェクト | |||
toSource() | 文字列値 | ソースコードを表す文字列を返す |
索引の項目
Ver. | プロパティ | R/O | 値 |
---|---|---|---|
parent | ○ | IndexSection, Topic, Index | |
crossReferences | ○ | CrossReferences | |
eventListeners | ○ | EventListeners | |
events | ○ | Events | |
pageReferences | ○ | PageReferences | |
topics | ○ | Topics |
Ver. | プロパティ名 | R/O | 値 | 説明 |
---|---|---|---|---|
index | ○ | 数値 | インデックス | |
isValid | ○ | 真偽値 | オブジェクトが有効かどうか | |
name | 文字列値 | オブジェクトの名前 | ||
properties | Object | |||
sortOrder | 文字列値 | 読み |
Ver. | メソッドの書式 | 戻り値 | メソッドの説明 | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ | 値 | パラメータの説明 | |||||||||||||||||||||||||||
addEventListener(eventType, handler, [captures]) | EventListener | EventListenerを作成 | |||||||||||||||||||||||||||
eventType | 文字列値 | ||||||||||||||||||||||||||||
handler | ファイル, JavaScript関数 | ||||||||||||||||||||||||||||
[captures] | 真偽値 | (廃止) | |||||||||||||||||||||||||||
capitalize([capitalizationOption]) | なし | 英単語の文字を大文字にする | |||||||||||||||||||||||||||
[capitalizationOption] |
IndexCapitalizationOptions
| (既定値=IndexCapitalizationOptions.ALL_ENTRIES) | |||||||||||||||||||||||||||
getElements() | Array( Topic ) | オブジェクト参照を返す | |||||||||||||||||||||||||||
remove() | なし | 削除 | |||||||||||||||||||||||||||
removeEventListener(eventType, handler, [captures]) | 真偽値 | EventListenerを削除 | |||||||||||||||||||||||||||
eventType | 文字列値 | ||||||||||||||||||||||||||||
handler | ファイル, JavaScript関数 | ||||||||||||||||||||||||||||
[captures] | 真偽値 | (廃止) | |||||||||||||||||||||||||||
toSource() | 文字列値 | ソースコードを表す文字列を返す | |||||||||||||||||||||||||||
toSpecifier() | 文字列値 | Retrieves the object specifier. |