Get

Script 関数または別の Get 関数のいずれかによって出力された配列および/またはオブジェクトのプロパティを返します。

Get概要

Get 関数を使用して、Script 関数によって返されるオブジェクトのプロパティにアクセスします。最低でも 2 つの引数が必要です。Script 関数、またはオブジェクトや配列を返す別の Get 関数への参照と、オブジェクトのプロパティを示す文字列、またはサブオブジェクトのプロパティへのドットで区切られたパスのいずれかです。オプションで、配列を参照するときに、3 つめの引数がゼロベースの配列インデックスにアクセスするように指定することができます。

Get 関数の戻り値はプロパティ (つまり、インデックスで指定された配列要素) の値であり、次のタイプのいずれかとなります。

• 数値
• true (1) または false (0)
• 文字列
• バイナリデータ構造体
• ブロブ、エッジ、ヒスト、IDMax、またはパターンデータ構造体
• 形状オブジェクト
• オブジェクト、またはアレイデータ構造体

Get 関数の例

この例では、セル B3 内の Script 関数に、オブジェクトを返す実行メソッドがあります。

Tool.prototype.run = function(n) {
  this.updateStats(n);
  return {
    total: this._total;
	stats: {
	  avg: this._avg,
	  range: {
	    max: this._max,
	    min: this._min
	  },
	  values: this._valueArray
	}
   };
}; 

次の Get 関数は、単純な数値を返します (戻り値が数値であることを前提とします)。

• Get(B3, "total")
• Get(B3, "stats.avg")
• Get(B3, "stats.range.max")
• Get(B3, "stats.range.min")

次の Get 関数は「range」サブオブジェクトを返します。この戻り値は、別の Script または Get 関数に渡すことができます。

• Get(B3, "stats.range")

次の Get 関数は値配列から要素 37 を返します。

• Get(B3, "stats.values", 37)

Getの入力パラメータ

Syntax:Get(Script/Get,オブジェクトプロパティと配列の両方またはいずれか,[配列インデックス])

Script/Get	オブジェクトまたはアレイデータ構造体を返す Script 関数または別の Get 関数への参照を指定します。
オブジェクトプロパティと配列の両方またはいずれか	オブジェクトデータ構造体のプロパティへの参照を、文字列 (プロパティの名前) やサブオブジェクトへのドットで区切られたパス、またはアレイデータ構造体のいずれかとして指定します。
[配列インデックス]	アレイデータ構造体が参照されるときに、配列のインデックスにオプションの引数を指定します。

Getの出力

戻り値	この関数の戻り値はプロパティ (つまり、インデックスで指定された配列要素) の値であり、次のタイプのいずれかを返します。 数値 true (1) または false (0) 文字列 バイナリデータ構造体 ブロブ、エッジ、ヒスト、IDMax、またはパターンデータ構造体 形状オブジェクト オブジェクトまたはアレイデータ構造体