VisualVariable

AMD: require(["geoscene/renderers/visualVariables/VisualVariable"], (VisualVariable) => { /* code goes here */ });
ESM: import VisualVariable from "@geoscene/core/renderers/visualVariables/VisualVariable";
类: geoscene/renderers/visualVariables/VisualVariable
继承于:VisualVariable Accessor
起始版本:GeoScene Maps SDK for JavaScript 4.10

视觉变量基类。查看扩展此类的每个子类,以了解如何创建连续的数据驱动的专题可视化。

ColorVariable SizeVariable OpacityVariable RotationVariable
renderer-vv-color renderer-vv-extrusion renderer-vv-opacity renderer-vv-rotation
另请参阅

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
String

类的名称。

更多详情
Accessor
String

数字属性字段的名称,包含用于确定每个要素的颜色/不透明度/大小/旋转的数据值。

更多详情
VisualVariable
Object

对象,可提供用于在 Legend 中显示可视变量的选项。

更多详情
VisualVariable
String

视觉变量类型。

更多详情
VisualVariable
String

遵循 Arcade 可视化配置文件定义的规范的 Arcade 表达式 表达式。

更多详情
VisualVariable
String

标题,用于标识和描述 valueExpression 属性中定义的关联 Arcade 表达式 表达式。

更多详情
VisualVariable

属性详细信息

declaredClass Stringreadonly inherited

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

field String

数字属性字段的名称,包含用于确定每个要素的颜色/不透明度/大小/旋转的数据值。

legendOptions Object

对象,可提供用于在 Legend 中显示可视变量的选项。

属性
showLegend Boolean
optional

指定是否在图例中显示可视变量。

title String
optional

描述 Legend 中视觉变量可视化的标题。这优先于字段别名或 valueExpressionTitle

type Stringreadonly

视觉变量类型。

可能值"color"|"opacity"|"rotation"|"size"

valueExpression String

遵循 Arcade 可视化配置文件定义的规范的 Arcade 表达式 表达式。视觉变量中的表达式可能使用 $feature 配置变量来引用字段值,并且必须返回一个数字。

从该表达式返回的值是用于派生在 stops 中定义的可视化的数据。此表达式优先于字段。因此,该属性通常用作视觉变量中字段的替代视觉变量。

另请参阅
valueExpressionTitle String

标题,用于标识和描述 valueExpression 属性中定义的关联 Arcade 表达式 表达式。如果 legendOptions 属性中没有提供 title,则它将在 Legend 中显示为相应视觉变量的标题。

方法概述

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

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

更多详情
Accessor
*

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

更多详情
VisualVariable
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

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

更多详情
VisualVariable

方法详细说明

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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
参数
handleOrHandles WatchHandle|WatchHandle[]

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

groupKey *
optional

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

fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。有关何时以及如何使用该函数的详细信息和示例,请参阅指南中的使用 fromJSON() 主题。

参数
json Object

GeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例,请参阅 GeoScene REST API 文档

返回
类型 描述
* 返回该类的新实例。
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 表示。

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。请参阅浏览器弃用帖子以获取更多信息