Get

返回由 Script 函数或另一个 Get 函数输出的数组和/或对象的属性。

Get 概述

Get 函数用于访问由 Script 函数返回的对象的属性。它至少需要两个参数：对 Script 函数的引用，或另一个返回对象或数组的 Get 函数；以及表示对象属性的字符串，或指向子对象属性的点分隔路径。（可选）当引用数组时，可以指定第三个参数来访问从零开始的数组索引。

Get 函数的返回值是属性（或索引数组元素）的值，可以是以下任何类型：

  • 数字
  • true (1) 或 false (0)
  • 字符串
  • Binary 数据结构
  • 斑点、边缘、直方图、 或 Patterns 数据结构
  • 形状对象
  • 对象
  • 图像
  • null、undefined（未定义）或无返回语句（被视为与空对象相同）。
注意:Get 函数不支持返回 null 或 undefined（未定义）。

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”子对象，它可以被传递到另一个脚本或 Get 函数中：

  • Get(B3, "stats.range")

下面的 Get 函数将从值数组返回元素 37：

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

Get 输入

Script/Get

指定对返回 Object 或 Array 数据结构的 Script 函数或另一个 Get 函数的引用。

对象属性和/或数组

指定对 Object 数据结构的属性的引用，可以是字符串（属性的名称）或子对象属性的点分隔路径；也可以是 Array 数据结构。

[Array Index]

当引用 Array 数据结构时，指定数组索引的可选参数。

Get 输出

返回

该函数将返回属性（或索引数组元素）的值，并且可能返回以下任何类型：

  • 数字
  • true (1) 或 false (0)
  • 字符串
  • Binary 数据结构
  • Blob、Edge、Histogram、 或 Patterns 数据结构
  • 形状对象
  • 对象
  • 图像
  • null、undefined（未定义）或无返回语句（被视为与空对象相同）。
注意:该函数不会从 Script 函数返回以下内容：null、undefined（未定义）或无返回语句（被视为与空对象相同）。