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 API for JavaScript 4.6

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

另请参阅:

构造函数

new AuthoringInfo(properties)
参数:
properties Object
optional

有关可能传递到构造函数中的所有属性的列表,请参阅属性

属性概览

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

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

更多详情AuthoringInfo
ColorRamp更多详情

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

更多详情AuthoringInfo
String更多详情

类的名称。

更多详情Accessor
Object更多详情

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

更多详情AuthoringInfo
Object更多详情

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

更多详情AuthoringInfo
String[]更多详情

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

更多详情AuthoringInfo
String更多详情

仅适用于流渲染器。

更多详情AuthoringInfo
String更多详情

关系渲染器的焦点。

更多详情AuthoringInfo
String更多详情

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

更多详情AuthoringInfo
Number更多详情

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

更多详情AuthoringInfo
Number更多详情

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

更多详情AuthoringInfo
Number更多详情

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

更多详情AuthoringInfo
Number更多详情

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

更多详情AuthoringInfo
Object更多详情

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

更多详情AuthoringInfo
String更多详情

指示从智能制图函数之一生成的渲染器类型。

更多详情AuthoringInfo
String更多详情

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

更多详情AuthoringInfo
String更多详情

仅适用于 univariateColorSize 渲染器。

更多详情AuthoringInfo
AuthoringInfoVisualVariable[]更多详情

包含从智能制图方法或滑块之一生成的可视化变量的编写属性。

更多详情AuthoringInfo

属性详细信息

classificationMethod String

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

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

另请参阅:
colorRamp ColorRamp

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

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

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

field1 Object

用于生成关系渲染器以及 field2 的数值字段。在默认可视化效果中,此字段的值沿图例的垂直轴渲染。

属性:
field String

数值字段的名称。

normalizationField String
optional

用于规范化给定 field 的数字字段的名称。在分区统计可视化中,如果尚未对数据值进行规范化,则最佳做法是对其进行规范化。

classBreakInfos Object[]
optional

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

规范:
maxValue Number
optional

要在给定字段中可视化的值的最大边界。如果要素的值大于此值,则将为该要素分配渲染器的默认符号。

minValue Number
optional

要在给定字段中可视化的值的最小边界。如果要素的值小于此值,则将为其分配渲染器的默认符号。

label String
optional

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

field2 Object

用于生成关系渲染器以及 field1 的数值字段。在默认可视化效果中,此字段的值沿图例的水平轴渲染。

属性:
field String

数值字段的名称。

normalizationField String
optional

用于规范化给定 field 的数字字段的名称。在分区统计可视化中,如果尚未对数据值进行规范化,则最佳做法是对其进行规范化。

classBreakInfos Object[]
optional

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

规范:
maxValue Number
optional

要在给定字段中可视化的值的最大边界。如果要素的值大于此值,则将为该要素分配渲染器的默认符号。

minValue Number
optional

要在给定字段中可视化的值的最小边界。如果要素的值小于此值,则将为其分配渲染器的默认符号。

label String
optional

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

fields String[]

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

flowTheme String
起始版本:GeoScene API for JavaScript 4.23

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

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

focus String

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

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 API for JavaScript 4.18

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

属性:
max Number

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

min Number

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

type String

指示从智能制图函数之一生成的渲染器类型。

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

univariateSymbolStyle String
起始版本:GeoScene API 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 API for JavaScript 4.18

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

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

Autocasts from Object[]

包含从智能制图方法或滑块之一生成的可视化变量的编写属性。

方法概述

名称 返回类型 描述 类:
AuthoringInfo更多详情

创建实例的深度克隆。

更多详情AuthoringInfo
*更多详情

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

更多详情AuthoringInfo
Object更多详情

将此类的实例转换为其 GeoScene portal JSON 表示形式。

更多详情AuthoringInfo

方法详细信息

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 文档

返回:
类型 说明
* 返回此类的新实例。
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.