OpacityVariable

AMD: require(["geoscene/renderers/visualVariables/OpacityVariable"], (OpacityVariable) => { /* 代码 */ });
ESM: import OpacityVariable from "@geoscene/core/renderers/visualVariables/OpacityVariable";
类: geoscene/renderers/visualVariables/OpacityVariable
继承于: OpacityVariable VisualVariable Accessor
起始版本: GeoScene API for JavaScript 4.22

不透明度可视变量根据表达式返回的数值字段值或数字定义每个要素符号的不透明度。必须指定停靠点才能构造不透明度坡度。

renderer-vv-opacity

示例:
示例代码:
const opacityVisualVariable = {
  type: "opacity",
  field: "PERCENTAGE",
  // maps data values to opacity values
  stops: [
    { value: 0, opacity: 0.1 },
    { value: 100, opacity: 1 }
  ]
};
renderer.visualVariables = [ opacVisVar ];
// opacity visual variable with arcade
const opacityVisualVariable = {
  type: "opacity",
  // calculate a value to visualize with opacity
  valueExpression: "( $feature.TOT_VOTES / $feature.REG_VOTERS ) * 100",
  stops: [
    { value: 30, opacity: 0.15 },
    { value: 70, opacity: 0.15 }
  ]
};
renderer.visualVariables = [ opacityVisVar ];

构造函数

new OpacityVariable(properties)
参数:
properties Object
optional

所有可传入构造函数的属性,请参见属性列表

属性列表

可以设置、检索或监听的属性。参见使用属性主题。
展示继承属性 隐藏继承属性
属性 类型 描述
String更多信息

类名。

更多信息Accessor
String更多信息

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

更多信息VisualVariable
Object更多信息

一个对象,提供用于在图例中显示可视变量的选项。

更多信息VisualVariable
String更多信息

标准化数据所依据的数字属性字段名。

更多信息OpacityVariable
OpacityStop[]更多信息

用于定义在一系列断点中应用于图层中的要素的不透明度的一组对象。

更多信息OpacityVariable
String更多信息

视觉变量类型。

更多信息OpacityVariable
String更多信息

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

更多信息VisualVariable
String更多信息

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

更多信息VisualVariable

属性详细说明

declaredClass Stringreadonly inherited

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

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

legendOptions Object inherited

一个对象,提供用于在图例中显示可视变量的选项。

属性:
showLegend Boolean
optional

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

title String
optional

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

normalizationField String

标准化数据所依据的数字属性字段的名称。如果使用此字段,则断点的值应标准化为百分比或比率。

自动转换自 Object[]

一个用于定义以一系列断点应用于图层中特征的不透明度的数组。必须指定2-8个站点。在大多数情况下,不需要超过五个。数据值位于给定断点之间的要素将被指定为不透明度值,该值将根据断点值沿渐变线性插值。必须根据每个断点中 value 属性的值按升序列出断点。

type Stringreadonly

视觉变量类型。

对于 OpacityVariable,类型始终为 "opacity"

valueExpression String inherited

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

从该表达式返回的值是用于驱动在断点中定义的可视化的数据。这优先于字段。因此,此属性通常用作视觉变量中字段的替代方法。

示例:
valueExpressionTitle String inherited

标识和描述 在 valueExpression 属性中定义的关联 Arcade表达式的标题。在 legendOptions 属性中没有提供的情况下,这将显示为图例中相应可视变量的title

方法列表

属性 返回值类型 描述
OpacityVariable更多信息

创建透明度视觉变量的深拷贝。

更多信息OpacityVariable
*更多信息

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

更多信息OpacityVariable
Object更多信息

将此类的实例转换为其 GeoScene portal JSON 格式。

更多信息OpacityVariable

方法详细说明

clone(){OpacityVariable}

创建透明度视觉变量的深拷贝。

返回值:
类型 描述
OpacityVariable 调用此方法的透明度视觉变量的深拷贝。
示例代码:
// Creates a deep clone of the visual variable
let renderer = renderer.visualVariables[0].clone();
fromJSON(json){*}static

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

参数:
json Object

实例的 json 表达式,以geoscene 格式显示。

返回值:
类型 描述
* 返回一个该类的新实例。
toJSON(){Object}

将此类的实例转换为 GeoScene portal JSON 格式。 有关更多信息,请参阅使用 fromJSON() 指南。

返回值:
类型 描述
Object 此类实例的 GeoScene portal JSON 格式。

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.