ColorVariable

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

颜色可视变量用于根据数值属性 字段 或 表达式 的值通过渐变颜色显示特征。颜色渐变沿一系列 断点 定义,其中颜色值映射到数据值。位于两个断点之间的数据值被分配为一个颜色,该颜色基于值相对于最近定义的断点的位置进行线性插值。

对于 CIMSymbols,颜色值仅应用于未锁定颜色的符号图层。

renderer-vv-color

示例:
示例代码:
// Population per square kilometer
const colorVisVar = {
  type: "color",
  field: "POPULATION",
  normalizationField: "SQ_KM",
  stops: [
    { value: 30, color: "#FFFCD4" },
    { value: 6000, color: "#0D2644" }
  ],
  legendOptions: {
    title: "Population per square kilometer"
  }
};
renderer.visualVariables = [ colorVisVar ];
// color visual variable with arcade expression
// voter turnout
const colorVisVar = {
  type: "color",
  valueExpression: "( $feature.TOT_VOTES / $feature.REG_VOTERS ) * 100",
  valueExpressionTitle: "Voter Turnout",
  stops: [
    { value: 30, color: "#FFFCD4" },
    { value: 70, color: "#0D2644" }
  ]
};
renderer.visualVariables = [ colorVisVar ];

构造函数

new ColorVariable(properties)
参数:
properties Object
optional

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

属性列表

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

类名。

更多信息Accessor
String更多信息

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

更多信息VisualVariable
Object更多信息

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

更多信息VisualVariable
String更多信息

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

更多信息ColorVariable
ColorStop[]更多信息

定义渐变颜色的一系列连续对象或断点。

更多信息ColorVariable
String更多信息

视觉变量类型。

更多信息ColorVariable
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

视觉变量类型。

对于 ColorVariable, 类型始终为 "color"

valueExpression String inherited

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

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

示例:
valueExpressionTitle String inherited

标识和描述 valueExpression 属性中定义的 Arcade 表达式的标题。如果 legendOptions 属性中没有提供标题,则它将在图例图例中显示为相应渲染器的 title

方法列表

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

创建视觉变量的深拷贝。

更多信息ColorVariable
*更多信息

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

更多信息ColorVariable
Object更多信息

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

更多信息ColorVariable

方法详细说明

clone(){ColorVariable}

创建视觉变量的深拷贝。

返回值:
类型 描述
ColorVariable

调用此方法的视觉变量的深拷贝。

示例代码:
// 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.