CrossReference(索引相互参照)のコレクション
| Ver. | プロパティ名 | R/O | 値 | 説明 |
|---|---|---|---|---|
| length | ○ | 数値 | オブジェクト数 |
| Ver. | メソッドの書式 | 戻り値 | メソッドの説明 | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| パラメータ | 値 | パラメータの説明 | |||||||||||||||||||||||||||||||||||||||||||
| add(referencedTopic, crossReferenceType, [customTypeString], [withProperties]) | CrossReference | 新しいオブジェクトを作成し、それを返す | |||||||||||||||||||||||||||||||||||||||||||
| referencedTopic | Topic | 位置の基準になるトピック | |||||||||||||||||||||||||||||||||||||||||||
| crossReferenceType |
CrossReferenceType
| ||||||||||||||||||||||||||||||||||||||||||||
| [customTypeString] | 文字列値 | The custom string to use in the cross reference. Valid only for custom cross reference types. | |||||||||||||||||||||||||||||||||||||||||||
| [withProperties] | Object | プロパティを設定 | |||||||||||||||||||||||||||||||||||||||||||
| anyItem() | CrossReference | どれかのオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||
| count() | 数値 | 要素数を返す | |||||||||||||||||||||||||||||||||||||||||||
| everyItem() | CrossReference (Array) | 全てのオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||
| firstItem() | CrossReference | 最初のオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||
| item(index) | CrossReference | インデックスまたは名前で指定したオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||
| index | 数値, 文字列値 | インデックスまたは名前 | |||||||||||||||||||||||||||||||||||||||||||
| itemByID(id) | CrossReference | IDで指定したオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||
| id | 数値 | ||||||||||||||||||||||||||||||||||||||||||||
| itemByName(name) | CrossReference | 名前で指定したオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||
| name | 文字列値 | ||||||||||||||||||||||||||||||||||||||||||||
| itemByRange(from, to) | CrossReference (Array) | 範囲で指定したオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||
| from | CrossReference, 数値, 文字列値 | 範囲の開始 | |||||||||||||||||||||||||||||||||||||||||||
| to | CrossReference, 数値, 文字列値 | 範囲の終了 | |||||||||||||||||||||||||||||||||||||||||||
| lastItem() | CrossReference | 最後のオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||
| middleItem() | CrossReference | 真ん中のオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||
| nextItem(obj) | CrossReference | 一つ後のオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||
| obj | CrossReference | 位置の基準になるオブジェクト | |||||||||||||||||||||||||||||||||||||||||||
| previousItem(obj) | CrossReference | 一つ前のオブジェクトを返す | |||||||||||||||||||||||||||||||||||||||||||
| obj | CrossReference | 位置の基準になるオブジェクト | |||||||||||||||||||||||||||||||||||||||||||
| toSource() | 文字列値 | ソースコードを表す文字列を返す | |||||||||||||||||||||||||||||||||||||||||||
索引相互参照
| Ver. | プロパティ | R/O | 値 |
|---|---|---|---|
| parent | ○ | Topic | |
| eventListeners | ○ | EventListeners | |
| events | ○ | Events | |
| Ver. | プロパティ名 | R/O | 値 | 説明 | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| crossReferenceType |
CrossReferenceType
| The text that precedes or follows the referenced topic. | ||||||||||||||||||||||||||||||||||||||||||
| customTypeString | 文字列値 | The text used for a custom cross reference type. Note: Valid only for custom cross reference types. | ||||||||||||||||||||||||||||||||||||||||||
| id | ○ | 数値 | オブジェクトのID | |||||||||||||||||||||||||||||||||||||||||
| index | ○ | 数値 | インデックス | |||||||||||||||||||||||||||||||||||||||||
| isValid | ○ | 真偽値 | オブジェクトが有効かどうか | |||||||||||||||||||||||||||||||||||||||||
| label | 文字列値 | スクリプトラベル | ||||||||||||||||||||||||||||||||||||||||||
| name | 文字列値 | オブジェクトの名前 - label のエイリアス | ||||||||||||||||||||||||||||||||||||||||||
| properties | Object | |||||||||||||||||||||||||||||||||||||||||||
| referencedTopic | Topic | The topic to which this CrossReference points. | ||||||||||||||||||||||||||||||||||||||||||
| Ver. | メソッドの書式 | 戻り値 | メソッドの説明 | ||
|---|---|---|---|---|---|
| パラメータ | 値 | パラメータの説明 | |||
| addEventListener(eventType, handler, [captures]) | EventListener | EventListenerを作成 | |||
| eventType | 文字列値 | ||||
| handler | ファイル, JavaScript関数 | ||||
| [captures] | 真偽値 | (廃止) | |||
| extractLabel(key) | 文字列値 | キーに関連づけられた値を取得 | |||
| key | 文字列値 | キー | |||
| getElements() | Array( CrossReference ) | オブジェクト参照を返す | |||
| insertLabel(key, value) | なし | キーに関連づけられた値を設定 | |||
| key | 文字列値 | キー | |||
| value | 文字列値 | 値 | |||
| remove() | なし | 削除 | |||
| removeEventListener(eventType, handler, [captures]) | 真偽値 | EventListenerを削除 | |||
| eventType | 文字列値 | ||||
| handler | ファイル, JavaScript関数 | ||||
| [captures] | 真偽値 | (廃止) | |||
| toSource() | 文字列値 | ソースコードを表す文字列を返す | |||
| toSpecifier() | 文字列値 | Retrieves the object specifier. | |||