AuthoringInfo

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

编写与使用 Smart Mapping 方法生成渲染器和视觉变量相关的信息。这包括来自 UI 元素的信息,例如滑块和选定的分类方法和主题。这允许编写客户端保存设置,以便可以记住他们的选择。

构造函数

new AuthoringInfo(properties)
参数
properties Object
optional

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

属性概述

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

指示如果使用 Smart Mapping 函数之一生成分类颜色或分类大小渲染器,则使用哪种分类方法。

更多详情
AuthoringInfo
ColorRamp

指示将色带用于为影像图层的唯一值或分类间隔渲染器创建符号。

更多详情
AuthoringInfo
String

类的名称。

更多详情
Accessor
Number

仅适用于使用热点图渲染创建器创建的 HeatmapRenderer

更多详情
AuthoringInfo
Object

用于生成关系渲染器以及 field2 的数值字段。

更多详情
AuthoringInfo
Object

用于生成关系渲染器以及 field1 的数值字段。

更多详情
AuthoringInfo
String[]

字符串值数组,表示用于创建优势渲染器的字段名称。

更多详情
AuthoringInfo
String

仅适用于流渲染器。

更多详情
AuthoringInfo
String

关系渲染器的焦点。

更多详情
AuthoringInfo
Boolean

指示渲染器是否由 JS API 的渲染引擎进行内部创建,以用于默认的 FeatureReductionCluster 可视化。

更多详情
AuthoringInfo
String

仅适用于 Web 场景中使用的渲染器。

更多详情
AuthoringInfo
Number

如果使用滑块为点密度渲染器生成点值,则指示上句柄的值。

更多详情
AuthoringInfo
Number

如果使用滑块为点密度渲染器生成点值,则指示下句柄的值。

更多详情
AuthoringInfo
Number

用于对关系渲染器的每个字段进行分类的类数。

更多详情
AuthoringInfo
Number

指示使用 standard-deviation 分类方法生成的分类颜色或分类大小渲染器中每个停靠点的标准差间隔。

更多详情
AuthoringInfo
Object

仅适用于 univariate-color-size 类型的渲染器,具有 above-and-belowunivariateTheme

更多详情
AuthoringInfo
String

指示从 Smart Mapping 函数之一生成的渲染器类型。

更多详情
AuthoringInfo
String

仅适用于具有 above-and-belowunivariateThemeunivariateColorSize 渲染器。

更多详情
AuthoringInfo
String

仅适用于 univariateColorSize 渲染器。

更多详情
AuthoringInfo
AuthoringInfoVisualVariable[]

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

更多详情
AuthoringInfo

属性详细信息

classificationMethod String

指示如果使用 Smart Mapping 函数之一生成分类颜色或分类大小渲染器,则使用哪种分类方法。

可能值"equal-interval"|"defined-interval"|"manual"|"natural-breaks"|"quantile"|"standard-deviation"

另请参阅
colorRamp ColorRamp

指示将色带用于为影像图层的唯一值或分类间隔渲染器创建符号。

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

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

fadeRatio Number
起始版本:GeoScene Maps SDK for JavaScript 4.25

仅适用于使用热点图渲染创建器创建的 HeatmapRenderer。指示用户选择将热点图边缘淡化为透明的程度。

field1 Object

用于生成关系渲染器以及 field2 的数值字段。在默认可视化中,此字段的值沿 Legend 的垂直轴进行呈现。

属性
field String

数值字段的名称。

normalizationField String
optional

数值字段的名称,用于规范化给定 field。在分级统计可视化中,最好的做法是对数据值进行归一化 (如果还未对其进行归一化)。

classBreakInfos Object[]
optional

描述为此字段生成的分类间隔。

规范
maxValue Number
optional

在给定字段中显示的值的最大界限。如果要素的值大于此值,则为其分配渲染器的默认符号。

minValue Number
optional

在给定字段中显示的值的最小界限。如果要素的值小于此值,则为其分配渲染器的默认符号。

label String
optional

用于描述图例中的字段或变量的标注。

field2 Object

用于生成关系渲染器以及 field1 的数值字段。在默认可视化中,此字段的值沿 Legend 的水平轴进行呈现。

属性
field String

数值字段的名称。

normalizationField String
optional

数值字段的名称,用于规范化给定 field。在分级统计可视化中,最好的做法是对数据值进行归一化 (如果还未对其进行归一化)。

classBreakInfos Object[]
optional

描述为此字段生成的分类间隔。

规范
maxValue Number
optional

在给定字段中显示的值的最大界限。如果要素的值大于此值,则为其分配渲染器的默认符号。

minValue Number
optional

在给定字段中显示的值的最小界限。如果要素的值小于此值,则为其分配渲染器的默认符号。

label String
optional

用于描述图例中的字段或变量的标注。

fields String[]

字符串值数组,表示用于创建优势渲染器的字段名称。

flowTheme String
起始版本:GeoScene Maps SDK for JavaScript 4.23

仅适用于流渲染器。指示生成的渲染器的用户选择的主题。

可能值"flow-line"|"wave-front"

focus String

关系渲染器的焦点。这决定了图例的方向。

isAutoGenerated Boolean

指示渲染器是否由 JS API 的渲染引擎进行内部创建,以用于默认的 FeatureReductionCluster 可视化。应避免设置或更改此值。

默认值:false
lengthUnit String

仅适用于 Web 场景中使用的渲染器。指示实际大小中使用的单位。

可能值"inches"|"feet"|"yards"|"miles"|"nautical-miles"|"millimeters"|"centimeters"|"decimeters"|"meters"|"kilometers"|"decimal-degrees"

maxSliderValue Number

如果使用滑块为点密度渲染器生成点值,则指示上句柄的值。

minSliderValue Number

如果使用滑块为点密度渲染器生成点值,则指示下句柄的值。

numClasses Number

用于对关系渲染器的每个字段进行分类的类数。这决定了图例中的类别数。

standardDeviationInterval Number

指示使用 standard-deviation 分类方法生成的分类颜色或分类大小渲染器中每个停靠点的标准差间隔。

可能值:0.25 | 0.33 | 0.5 | 1

statistics Object
起始版本:GeoScene Maps SDK for JavaScript 4.18

仅适用于 univariate-color-size 类型的渲染器,具有 above-and-below univariateTheme。包含有关渲染器所表示的数据的汇总统计信息。Legend 可以使用此信息避免显示超出图层 minmax 数据值的值。

属性
max Number

渲染器表示的属性的最大数据值。显示 above-and-below 主题数据的图例不会显示大于此数字的值。

min Number

渲染器表示的属性的最小数据值。显示 above-and-below 主题数据的图例不会显示小于此数字的值。

type String

指示从 Smart Mapping 函数之一生成的渲染器类型。

可能值"class-breaks-size"|"class-breaks-color"|"classed-color"|"classed-size"|"flow"|"predominance"|"relationship"|"univariate-color-size"

univariateSymbolStyle String
起始版本:GeoScene Maps SDK for JavaScript 4.18

仅适用于具有 above-and-below univariateThemeunivariateColorSize 渲染器。指示上述和下方的渲染器是否使用 API 提供的预定义符号对。

custom 样式指示渲染器是使用未在渲染器创建器中作为预定义符号对提供的自定义符号编写的。

可能值"caret"|"circle-caret"|"arrow"|"circle-arrow"|"plus-minus"|"circle-plus-minus"|"square"|"circle"|"triangle"|"happy-sad"|"thumb"|"custom"

univariateTheme String
起始版本:GeoScene Maps SDK for JavaScript 4.18

仅适用于 univariateColorSize 渲染器。指示单变量颜色和大小渲染器的主题。

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

自动转换自 Object[]

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

方法概述

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

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

更多详情
Accessor
AuthoringInfo

创建实例的深度克隆。

更多详情
AuthoringInfo
*

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

更多详情
AuthoringInfo
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

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

更多详情
AuthoringInfo

方法详细说明

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

clone(){AuthoringInfo}

创建实例的深度克隆。

返回
类型 描述
AuthoringInfo 调用此方法的对象的深度克隆。
示例
// Creates a deep clone of the layer's authoring info
let authInfo = layer.renderer.authoringInfo.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 表示。

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