DimensionalDefinition

AMD: require(["geoscene/layers/support/DimensionalDefinition"], (DimensionalDefinition) => { /* code goes here */ });
ESM: import DimensionalDefinition from "@geoscene/core/layers/support/DimensionalDefinition.js";
类: geoscene/layers/support/DimensionalDefinition
继承于:DimensionalDefinition Accessor
起始版本:GeoScene Maps SDK for JavaScript 4.0

维度定义可基于变量和维度定义过滤器。您可使用一个或多个维度切片过滤多维数据。通过在 ImageryLayer 上设置 MosaicRule.multidimensionalDefinition 或在 ImageryTileLayer 上设置 multidimensionalDefinition,在基于一个或多个维度中的切片或范围过滤数据时,通常使用此类的实例。

例如,单个 ImageryLayer 可能具有 depth 维度,用于存储不同深度处相同像素位置的海水温度。另一维度可能是 time,其中同一像素基于时间窗存储多个值。

下图中的片段对一年中特定时间内的海水温度进行了渲染。

let multidimensionalDefinition = [];
multidimensionalDefinition.push(new DimensionalDefinition({
  variableName: "water_temp",
  dimensionName: "StdZ", // water depth
  values: [0], // sea surface or 0ft
  isSlice: true
}));

let mosaicRule = new MosaicRule();
mosaicRule.multidimensionalDefinition = multidimensionalDefinition;

相比之下,下图对同一时间窗内的海面以下 5000 米处的来自同一服务的海水温度数据进行了渲染。

let multidimensionalDefinition = [];
multidimensionalDefinition.push(new DimensionalDefinition({
  variableName: "water_temp",
  dimensionName: "StdZ", // water depth
  values: [-5000], // 5000 m below
  isSlice: true
}));

let mosaicRule = new MosaicRule();
mosaicRule.multidimensionalDefinition = multidimensionalDefinition;
另请参阅

构造函数

new DimensionalDefinition(properties)
参数
properties Object
optional

有关可能传递给构造函数的所有属性的列表,请参见属性

属性概述

所有属性都可以设置、获取和监听。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
String

类的名称。

更多详情
Accessor
String

与变量相关联的维度。

更多详情
DimensionalDefinition
Boolean

指示这些值是否指示切片 (而不是范围)。

更多详情
DimensionalDefinition
Array<(number|Array<number>)>

单个值的数组或元组 [min, max],每个值定义沿指定维度的有效值范围。

更多详情
DimensionalDefinition
String

用于过滤的必需变量名称。

更多详情
DimensionalDefinition

属性详细信息

declaredClass Stringreadonly inherited
起始版本:GeoScene Maps SDK for JavaScript 4.7

类的名称。声明的类名称格式化为 geoscene.folder.className

dimensionName String

与变量相关联的维度。

isSlice Boolean

指示这些值是否指示切片 (而不是范围)。

默认值:false

单个值的数组或元组 [min, max],每个值定义沿指定维度的有效值范围。

示例
// -10 is the minimum valid value and 10 is the maximum valid value
definition.values = [[-10, 10]];
variableName String

用于过滤的必需变量名称。

方法概述

显示继承的方法 隐藏继承的方法
名称 返回值类值 描述

添加一个或多个与对象生命周期相关联的句柄

更多详情
Accessor
DimensionalDefinition

创建 DimensionalDefinition 对象的克隆。

更多详情
DimensionalDefinition
*

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。

更多详情
DimensionalDefinition
Boolean

如果存在指定的句柄组,则返回 true。

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

将此类的实例转换为其 GeoScene Portal JSON 表示。

更多详情
DimensionalDefinition

方法详细说明

addHandles(handleOrHandles, groupKey)inherited
起始版本:GeoScene Maps SDK for JavaScript 4.25

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时,将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
参数
handleOrHandles WatchHandle|WatchHandle[]

对象销毁后,标记为要移除的句柄。

groupKey *
optional

标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键,则句柄将被添加到默认组。

创建 DimensionalDefinition 对象的克隆。

返回
类型 描述
DimensionalDefinition 调用此方法的对象的克隆。
示例
// Creates a clone of the DimensionalDefinition
let dimensionalDefinition1 = dimensionalDefinition.clone();
fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。

参数
json Object

GeoScene 格式实例的 JSON 表示。

返回
类型 描述
* 返回该类的新实例。
hasHandles(groupKey){Boolean}inherited
起始版本:GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组,则返回 true。

参数
groupKey *
optional

组键。

返回
类型 描述
Boolean 如果存在指定的句柄组,则返回 true
示例
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
起始版本:GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数
groupKey *
optional

要移除的组键或组键的数组或集合。

示例
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
toJSON(){Object}

将此类的实例转换为其 GeoScene Portal JSON 表示。有关详细信息,请参阅使用 fromJSON() 指南主题。

返回
类型 描述
Object 此类实例的 GeoScene Portal JSON 表示。

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。