AuthoringInfoVisualVariable

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

包含由智能制图方法或滑块生成的视觉变量的创作属性。

构造函数

new AuthoringInfoVisualVariable(properties)
参数
properties Object
optional

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

属性概述

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

类的名称。

更多详情
Accessor
String|Number

如果生成期限或时间线渲染器,则会指定可视化的结束时间。

更多详情
AuthoringInfoVisualVariable
String

指示用于生成数据驱动可视化的字段名称。

更多详情
AuthoringInfoVisualVariable
Number

如果使用滑块生成视觉变量,则指示上限值。

更多详情
AuthoringInfoVisualVariable
Number

如果使用滑块生成视觉变量,则指示下限值。

更多详情
AuthoringInfoVisualVariable
String|Number

如果生成期限或时间线渲染器,则会指定可视化的开始时间。

更多详情
AuthoringInfoVisualVariable
String

如果 UI 提供了基于比率或百分比显示值的选项,则这将表明选择的结果。

更多详情
AuthoringInfoVisualVariable
String

指示用户在使用智能制图函数之一生成渲染器或视觉变量时选择的主题。

更多详情
AuthoringInfoVisualVariable
String

生成的视觉变量的类型。

更多详情
AuthoringInfoVisualVariable
String

如果生成期限或时间线渲染器,则会指定所用的时间单位。

更多详情
AuthoringInfoVisualVariable

属性详细信息

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

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

endTime String|Number

如果生成期限或时间线渲染器,则会指定可视化的结束时间。

field String

指示用于生成数据驱动可视化的字段名称。

maxSliderValue Number

如果使用滑块生成视觉变量,则指示上限值。

minSliderValue Number

如果使用滑块生成视觉变量,则指示下限值。

startTime String|Number

如果生成期限或时间线渲染器,则会指定可视化的开始时间。

style String

如果 UI 提供了基于比率或百分比显示值的选项,则这将表明选择的结果。

可能值"percent"|"percent-of-total"|"ratio"

theme String

指示用户在使用智能制图函数之一生成渲染器或视觉变量时选择的主题。

可能值"above"|"below"|"above-and-below"|"centered-on"|"extremes"|"high-to-low"

type String

生成的视觉变量的类型。

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

units String

如果生成期限或时间线渲染器,则会指定所用的时间单位。

可能值"seconds"|"minutes"|"hours"|"days"|"months"|"years"

方法概述

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

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

更多详情
Accessor
AuthoringInfoVisualVariable

创建实例的深度克隆。

更多详情
AuthoringInfoVisualVariable
*

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

更多详情
AuthoringInfoVisualVariable
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

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

更多详情
AuthoringInfoVisualVariable

方法详细说明

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() 进行删除。如果未提供键,则句柄将被添加到默认组。

创建实例的深度克隆。

返回
类型 描述
AuthoringInfoVisualVariable 调用此方法的对象的深度克隆。
示例
// Creates a deep clone of the authoring info visual variable
let authInfoVV = layer.renderer.authoringInfo.visualVariables.find(function(vv){
  return vv.type === "color";
}).clone();
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 表示。

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