size

方法列表

方法详细说明

createAgeRenderer(params){Promise<AgeRendererResult>}

起始版本: GeoScene API for JavaScript 4.22

生成基于一个或多个字段表示要素年龄的连续大小 Renderer 。特征的年龄是根据给定的 startTime 和endTime, 计算的，其中一个必须是layer输入中的日期字段。此方法生成 Arcade 表达式，并计算表达式输出的统计信息以实现此目的。生成的渲染器包含一个连续大小可视变量，该变量将最佳大小映射到从汇总统计数据返回的数据值。

您需要提供 layer, view, startTime, 和endTime 并生成此渲染器。另外，您可以为可视化效果设置 unit 。为方便涉及更多内容的自定义可视化创作应用程序，还提供了其他选项。例如，如果已在另一个操作中生成了统计信息，则可以将统计信息对象传递给 statistics 参数，以避免对服务器进行额外的调用。

参数:

规范:

params Object 输入参数，用于为从开始和/或结束日期字段返回的时间数据生成连续大小的年龄可视化。有关每个参数的详细信息，请参阅下表。 规范: layer FeatureLayer|SceneLayer|CSVLayer|GeoJSONLayer|WFSLayer|OGCFeatureLayer 为其生成可视化效果的图层。 view View 渲染输入图层的视图。此方法检查视图的背景（即底图、web 地图背景或视图容器），以确定输出渲染器的最佳颜色。 startTime Date|String|Number 字段的名称，或表示年龄计算中开始时间的日期值。如果指定了日期值，则 endTime 参数必须引用图层中的 Date 字段。 endTime Date|String|Number 字段的名称，或表示年龄计算中结束时间的日期值。如果指定了日期值，则 startTime 参数必须引用图层中的 Date 字段。 unit String optional 用于计算 endTime 和startTime之间差值的时间单位。如果未指定单位，则根据数据的散布和分布确定建议的单位。 可选值:"years"|"months"|"days"|"hours"|"minutes"|"seconds" theme String optional 默认值: high-to-low 设置大小停止基于 有意义的数据值。 值 描述 high-to-low 最大数据值被分配最大大小。 最小数据值被分配最小大小。 所有其他值都被插值。 above 最大数据值被分配最大大小。 平均数据值被分配最小大小。 对最大数据值和平均值之间的所有其他值进行插值。 这对于映射变量随时间的增加非常有用，例如人口增加或两个日期之间的失业率。 below 最小数据值被分配最大大小。 平均数据值被分配最小大小。 对最小数据值和平均值之间的所有其他值进行插值。 这对于绘制变量随时间的下降情况很有用，例如人口减少或两个日期之间的失业率。 可选值:"high-to-low"|"above"|"below" maxValue Number optional 设置可视化效果的最长期限。即使存在高于此值的数据，也只会计算 minValue 和maxValue之间的值的统计信息。在版本 4.15 中添加。 minValue Number optional 设置可视化效果的最短期限。即使存在低于此值的数据，也只会计算 minValue 和maxValue之间的值的统计信息。在版本 4.15 中添加 outlineOptimizationEnabled Boolean optional 默认值: false 仅适用于面图层。表示多边形轮廓宽度是否应根据视图比例而变化。设置后，必须在参数 view 中提供有效的 MapView 实例。3D SceneViews不支持此选项。 sizeOptimizationEnabled Boolean optional 默认值: false 表示是否 符号大小应根据视图比例而有所不同。 设置后，一个有效的 MapView 必须在 view 参数中提供实例。 3D 不支持此选项 SceneViews. legendOptions Object optional 提供用于修改描述可视化效果的 Legend 属性的选项。 规范: title String optional 用于表示 Legend 中年龄大小斜坡的标题。 showLegend Boolean optional 表示是否在图例中包括年龄渲染器。 statistics SummaryStatisticsResult optional 从 summaryStatistics 函数生成的统计信息对象。createAgeRenderer() 方法生成 Arcade 表达式，并对图层执行表达式结果的统计查询。如果已生成表达式的统计信息，则在此处传递对象以避免进行第二次统计信息查询。 sizeScheme SizeScheme optional 在创作应用中，用户可以选择预定义的大小方案。将方案对象传递到此属性，以避免基于视图的背景获取方案对象。 symbolType String optional 默认值: 2d 要生成的符号的类型。这取决于您正在使用的视图和所需的可视化效果。不需要为具有 mesh 几何类型的图层指定此参数。可能的值如下所述。 值 描述 2d 使用 2D 符号生成可视化，例如 SimpleMarkerSymbol、SimpleLineSymbol , 或 SimpleFillSymbol。 如果为 MapView 中的数据生成可视化，请使用此选项。 3d-flat 使用具有平面符号层的 3D 符号生成可视化，例如 IconSymbol3DLayer、LineSymbol3DLayer 或 FillSymbol3DLayer。 如果为 SceneView 中的数据生成 2D 可视化，请使用此选项。 3d-volumetric 使用具有体积符号图层，例如 ObjectSymbol3DLayer、PathSymbol3DLayer 或 ExtrudeSymbol3DLayer 的3D 符号生成可视化效果。 如果为 SceneView 中的数据生成 3D 可视化效果，请使用此选项。如果使用此选项，则必须为 view 参数提供 SceneView 实例。 3d-volumetric-uniform 使用具有体积符号图层的统一大小的 3D 符号生成可视化。 如果为 SceneView 中的数据生成 3D 可视化，并且符号的大小应一致，例如球体，请使用此选项。 如果使用此选项，则必须为 view 参数提供 SceneView 实例。 可选值:"2d"|"3d-flat"|"3d-volumetric"|"3d-volumetric-uniform" defaultSymbolEnabled Boolean optional 默认值: true 在渲染器上启用 defaultSymbol，并将其分配给没有值的要素。 signal AbortSignal optional 允许可取消的请求。 如果取消，promise 将被拒绝，并出现名为 AbortError 的错误。 另请参阅 AbortController。

返回值:

类型	描述
Promise<AgeRendererResult>	解析为 AgeRendererResult 的实例。

示例代码:

const layer = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/311_Service_Requests_from_2015_50k/FeatureServer/0"
});

// visualization based age of incidents closed passed their due date
// or the number of days an incident was overdue at the time of closure.

const ageParams = {
  layer: layer,
  view: view,
  startTime: "Due_Date",
  endTime: "Closed_Date",
  unit: "days"
};

// when the promise resolves, apply the renderer to the layer
sizeRendererCreator.createAgeRenderer(ageParams)
  .then(function(response){
    layer.renderer = response.renderer;
  });

const layer = new CSVLayer({
  url: "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/2.5_week.csv",
  copyright: "USGS Earthquakes"
});

// visualization based off current age of incident
const ageParams = {
  layer: layer,
  view: view,
  startTime: "time",
  endTime: Date.now(),
  legendOptions: {
    title: "Time since earthquake struck"
  }
};

// when the promise resolves, apply the renderer to the layer
sizeRendererCreator.createAgeRenderer(ageParams)
  .then(function(response){
    layer.renderer = response.renderer;
  });

createClassBreaksRenderer(params){Promise<ClassBreaksRendererResult>}

起始版本: GeoScene API for JavaScript 4.22

生成一个 ClassBreaksRenderer，该渲染器可以直接应用于用于调用此方法的层。生成的渲染器根据给定 field 的值定义每个要素的符号大小。默认大小方案是根据视图的背景确定的。根据  classificationMethod, 分类间隔（或数据范围）是根据数据的统计信息生成的。每个要素都根据分类间隔分配一个大小，其中 field 的值就在其中。

在大多数情况下，您将提供 layer, view, field, 和classificationMethod 来生成此渲染器。在这种情况下，数据的统计信息不是众所周知的，并且用户不知道要在可视化中使用什么大小。您还可以使用 valueExpression来替代 field 根据从运行时执行的脚本返回的值来可视化要素。

提供其他选项是为了方便更多涉及的自定义可视化创作应用程序。

参数:

规范:

params Object 用于根据从给定字段或表达式返回的数据生成分类大小可视化效果的输入参数。有关每个参数的详细信息，请参阅下表。 规范: layer FeatureLayer|SceneLayer|CSVLayer|GeoJSONLayer|WFSLayer|OGCFeatureLayer 为其生成可视化效果的图层。 view View optional 渲染输入图层的视图。此方法检查视图的背景（即底图、web 地图背景或视图容器），以确定输出渲染器的最佳颜色。在实践中应始终设置此参数，但如果未提供，则此方法将假定生成的渲染器将显示在浅色背景上。使用用于在 SceneView 中显示的渲染器或用于渲染器创建渲染器时， valueExpression 是必需的。 field String 将查询其数据以进行统计和分类的字段的名称。如果使用 valueExpression ，则忽略此属性。 normalizationField String optional 用于规范化给定值的字段名称 field。 提供规范化字段有助于最大限度地减少一些可视化错误并标准化数据 因此，由于面积差异或计数变化，所有特征都以最小的偏差可视化。 这个选项是 可视化密度时常用。 normalizationType String optional 表示数据的规范化方式。在与分类间隔进行比较之前，从 field 中获取的数据值将通过以下方式之一进行规范化。有关可能值的列表，请参阅下表。 可选值 描述 field 将 field 值除以 normalizationField的值。如果提供了 normalizationField ，则默认设置此值。 log 计算数据值的以 10 为底数的对数。对于某些数据分布，这可能是一种有用的方法，因为它可以减少非常大的数据值的影响。 percent-of-total 将数据值除以所有数据值的总和，然后乘以 100。 normalizationTotal 用于定义要通过它进行规范化的总值。如果提供了normalizationTotal ，则默认设置此值。 除了 log 规范化外，数据规范化通过除以两个值来创建比率。比较要素之间的属性值时，归一化可最大限度地减少不同地图区域和观测值数量的影响。例如，将 18 到 30 岁的人口除以面要素的面积可生成可与其他要素平均比较的密度值，而不管其大小如何。 可选值:"field"|"log"|"percent-of-total" normalizationTotal Number optional 当normalizationType 是percent-of-total 时，此属性包含所有数据值的总和。 classificationMethod String optional 默认值: equal-interval 用于生成中断的分类方法。有关可能值的列表，请参阅下表。 可选值 描述 equal-interval 将属性值的范围划分为大小相等的子范围。例如，如果为值范围为 0 到 300 的字段指定三个类，则此方法将创建三个范围分别为 0–100、101–200 和 201–300 的类。相等间隔最适合应用于熟悉的数据范围，例如百分比和温度。此方法强调属性值相对于其他值的数量。例如，它可以显示商店是否是构成所有销售额前三分之一的商店组的一部分。 natural-breaks 对相似的值进行分组，以最大化类之间的差异。要素被划分为多个类，这些类的边界设置在数据值存在较大差异的地方。自然间断是特定于数据的分类，对于比较根据不同基础信息构建的多个地图没有用处。 quantile 为每个类分配相同数量的数据值。这非常适合线性分布的数据。由于要素在每个类中以相等的数量进行分组，因此生成的地图通常具有误导性。相似的要素可以放置在相邻的类中，或者具有截然不同的值的要素可以放在同一个类中。您可以通过增加类的数量来最大程度地减少这种失真。 standard-deviation 创建具有等值范围的分类间隔，这些范围是标准差的一部分。这通常以与平均值相差一、一半、三分之一或四分之一的标准偏差的间隔完成。 可选值:"equal-interval"|"natural-breaks"|"quantile"|"standard-deviation" standardDeviationInterval Number optional 默认值: 1 如果使用 standard-deviation 分类方法，则表示生成分类间隔的时间间隔。 Possible Values: 1 | 0.5 | 0.33 | 0.25 numClasses Number optional 默认值: 5 要生成的分类间隔数。如果指定了 standard-deviation 分类方法，则会忽略此值。 sizeScheme SizeScheme optional 在创作应用程序时， 用户可以选择预定义的尺寸方案。 将方案对象传递给此属性以避免得到一个 基于视图的背景。 valueExpression String optional Arcade 表达式如下 Arcade Visualization Profile 定义的规范。 表达式可以使用 $feature 全局变量引用字段值，并且必须返回 一个号码。 此属性覆盖 field 属性，因此用于代替输入 field 值。 valueExpressionTitle String optional 描述从 valueExpression 返回的值的文本。 这由 Legend 微件使用。 sqlExpression String optional 计算结果为数字的 SQL 表达式。 sqlWhere String optional 用于过滤统计查询功能的 SQL where 子句。 例如， 这在您想要避免除以零的情况下很有用，就像创建优势的情况一样 可视化。 outlineOptimizationEnabled Boolean optional 默认值: false 仅适用于多边形图层。 表示是否 多边形轮廓宽度应根据视图比例而有所不同。 设置后，一个有效的 MapView 必须在 view 参数中提供实例。 3D 不支持此选项 SceneViews. legendOptions Object optional 提供用于设置标题以描述字段而不是使用字段名称的选项。此标题将表示 Legend 中的字段。 规范: title String optional 用于表示给定字段或表达式的标题 图例. minValue Number optional 用户设置的最小值。结合 maxValue 使用此选项可在下限和上限之间生成分类间隔。这将是最低分类间隔的下限。 maxValue Number optional 用户设置的最大值。结合 minValue 使用此选项可在下限和上限之间生成分类间隔。这将是最高等级突破的上限 defaultSymbolEnabled Boolean optional 默认值: true 在渲染器上启用 defaultSymbol 并将其分配给特征 没有不在配置数据范围内的值和特征。 symbolType String optional 默认值: 2d 要生成的符号类型。 这取决于视图中 您正在工作的位置和所需的可视化。 可能的值如下所述。 值 描述 2d 使用 2D 符号生成可视化，例如 SimpleMarkerSymbol、SimpleLineSymbol , 或 SimpleFillSymbol。 如果为 MapView 中的数据生成可视化，请使用此选项。 3d-flat 使用具有平面符号层的 3D 符号生成可视化，例如 IconSymbol3DLayer、LineSymbol3DLayer 或 FillSymbol3DLayer。 如果为 SceneView 中的数据生成 2D 可视化，请使用此选项。 3d-volumetric 使用具有体积符号层的 3D 符号生成可视化，例如 ObjectSymbol3DLayer、PathSymbol3DLayer 或 ExtrudeSymbol3DLayer。 如果为 SceneView 中的数据生成 3D 可视化，并且只有符号的高度应该是可变的，例如圆柱体，请使用此选项。 如果使用此选项，则必须为 view 参数提供 SceneView 实例。 3d-volumetric-uniform 使用具有体积符号图层的统一大小的 3D 符号生成可视化。 如果为 SceneView 中的数据生成 3D 可视化，并且符号的大小应统一，例如使用球体，请使用此选项。 如果使用此选项，则必须为 view 参数提供 SceneView 实例。 可选值:"2d"|"3d-flat"|"3d-volumetric"|"3d-volumetric-uniform" signal AbortSignal optional 允许可取消的请求。 如果取消，promise 将被拒绝，并出现名为 AbortError 的错误。 另请参阅 AbortController。

返回值:

类型	描述
Promise<ClassBreaksRendererResult>	解析为 ClassBreaksRendererResult 的实例。

示例代码:

const layer = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/counties_politics_poverty/FeatureServer/0"
});

// visualization based on field and normalization field
const sizeParams = {
  layer: layer,
  view: view,
  field: "POP_POVERTY",
  normalizationField: "TOTPOP_CY",
  classificationMethod: "quantile",
  numClasses: 4
};

// when the promise resolves, apply the renderer to the layer
sizeRendererCreator.createClassBreaksRenderer(sizeParams)
  .then(function(response){
    layer.renderer = response.renderer;
  });

const layer = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/counties_politics_poverty/FeatureServer/0"
});

// visualization based off Arcade expression
const sizeParams = {
  layer: layer,
  classificationMethod: "equal-interval",
  valueExpression: "($feature.POP_POVERTY / $feature.TOTPOP_CY) * 100",
  view: view,
  legendOptions: {
    title: "% of people living in poverty"
  }
};

// when the promise resolves, apply the renderer to the layer
sizeRendererCreator.createClassBreaksRenderer(sizeParams)
  .then(function(response){
    layer.renderer = response.renderer;
  });

createContinuousRenderer(params){Promise<ContinuousRendererResult>}

生成可直接应用于用于调用此方法的图层的 Renderer 。渲染器包含一个连续大小可视变量，该变量根据指示字段或表达式中查询的统计信息将标记大小映射到特定的停止值。

在大多数情况下，您将提供 layer, view, 和field 来生成此渲染器。在这种情况下，数据的统计信息不是众所周知的，并且用户不知道要在可视化中使用什么大小。您还可以使用 valueExpression 替代 field ，根据从运行时执行的脚本返回的值来可视化要素。

提供其他选项是为了方便更多涉及的自定义可视化创作应用程序。例如，如果已在另一个操作中生成了统计信息，则可以将统计信息对象传递给参数 statistics ，以避免对服务器进行额外的调用。

参数:

规范:

params Object 根据数据生成尺寸视觉变量的输入参数 从给定的字段或表达式返回。 每个参数的详细信息见下表。 规范: layer FeatureLayer|SceneLayer|CSVLayer|GeoJSONLayer|WFSLayer|OGCFeatureLayer 为其生成渲染器的图层。 view View optional 渲染输入图层的视图。此方法检查视图的背景（即底图、web 地图背景或视图容器），以确定输出渲染器的最佳颜色。在实践中应始终设置此参数，但如果未提供，则此方法将假定生成的渲染器将显示在浅色背景上。使用 valueExpression 用于在 SceneView 中显示的渲染器或用于渲染器创建渲染器时，此参数是必需的。 field String optional 将查询其数据以进行统计并用作数据驱动可视化的基础的字段的名称。如果使用 valueExpression ，则忽略此属性。 normalizationField String optional 用于规范化给定值的字段名称 字段。 提供规范化字段有助于最大限度地减少一些可视化错误并标准化数据 因此，由于面积差异或计数变化，所有特征都以最小的偏差可视化。 这个选项是 可视化密度时常用。 sizeScheme SizeScheme optional 在创作应用程序时， 用户可以选择预定义的尺寸方案。 将方案对象传递给此属性以避免得到一个 基于视图的背景。 valueExpression String optional Arcade 表达式如下 Arcade Visualization Profile 定义的规范。 表达式可以使用 $feature 全局变量引用字段值，并且必须返回 一个号码。 此属性覆盖 field 属性，因此用于代替输入 field 值。 valueExpressionTitle String optional 描述从 valueExpression 返回的值的文本。 这由 Legend 微件使用。 theme String optional 默认值: high-to-low 设置大小停止基于 有意义的数据值。 值 描述 high-to-low 最大数据值被分配最大大小。 最小数据值被分配最小大小。 所有其他值都被插值。 above 最大数据值被分配最大大小。 平均数据值被分配最小大小。 对最大数据值和平均值之间的所有其他值进行插值。 这对于映射变量随时间的增加非常有用，例如人口增加或两个日期之间的失业率。 below 最小数据值被分配最大大小。 平均数据值被分配最小大小。 对最小数据值和平均值之间的所有其他值进行插值。 这对于绘制变量随时间的下降情况很有用，例如人口减少或两个日期之间的失业率。 可选值:"high-to-low"|"above"|"below" sqlExpression String optional 计算结果为数字的 SQL 表达式。 sqlWhere String optional 用于过滤统计查询功能的 SQL where 子句。 例如， 这在您想要避免除以零的情况下很有用，就像创建优势的情况一样 可视化。 outlineOptimizationEnabled Boolean optional 默认值: false 仅适用于多边形图层。 表示是否 多边形轮廓宽度应根据视图比例而有所不同。 设置后，一个有效的 MapView 必须在 view 参数中提供实例。 3D 不支持此选项 SceneViews. sizeOptimizationEnabled Boolean optional 默认值: false 表示是否 符号大小应根据视图比例而有所不同。 设置后，一个有效的 MapView 必须在 view 参数中提供实例。 3D 不支持此选项 SceneViews. legendOptions Object optional 提供在提供表达式时为字段设置标题的选项 而不是字段名称。 此标题将代表 Legend 中的字段。 规范: title String optional 用于表示给定字段或表达式的标题 图例. showLegend Boolean optional 表示是否在图例中描述渲染器。 statistics SummaryStatisticsResult optional 从 summaryStatistics 函数生成的统计对象。 如果已经生成了字段的统计信息，则在此处传递对象以避免进行第二次统计 向服务器查询。 minValue Number optional 用户设置的自定义最小值。结合 maxValue 使用此选项可在下限和上限之间生成统计信息。这将是返回的大小可视变量中的最低止损。 maxValue Number optional 用户设置的自定义最大值。结合 minValue 使用此选项可在下限和上限之间生成统计信息。这将是返回的大小视觉变量中最上面的停止。 defaultSymbolEnabled Boolean optional 默认值: true 在渲染器上启用 defaultSymbol 并将其分配给特征 没有不在配置数据范围内的值和特征。 symbolType String optional 默认值: 2d 要生成的符号类型。 这取决于视图中 您正在工作的位置和所需的可视化。 可能的值如下所述。 值 描述 2d 使用 2D 符号生成可视化，例如 SimpleMarkerSymbol、SimpleLineSymbol , 或 SimpleFillSymbol。 如果为 MapView 中的数据生成可视化，请使用此选项。 3d-flat 使用具有平面符号层的 3D 符号生成可视化，例如 IconSymbol3DLayer、LineSymbol3DLayer 或 FillSymbol3DLayer。 如果为 SceneView 中的数据生成 2D 可视化，请使用此选项。 3d-volumetric 使用具有体积符号层的 3D 符号生成可视化，例如 ObjectSymbol3DLayer、PathSymbol3DLayer 或 ExtrudeSymbol3DLayer。 如果为 SceneView 中的数据生成 3D 可视化，并且只有符号的高度应该是可变的，例如圆柱体，请使用此选项。 如果使用此选项，则必须为 view 参数提供 SceneView 实例。 3d-volumetric-uniform 使用具有体积符号图层的统一大小的 3D 符号生成可视化。 如果为 SceneView 中的数据生成 3D 可视化，并且符号的大小应统一，例如使用球体，请使用此选项。 如果使用此选项，则必须为 view 参数提供 SceneView 实例。 可选值:"2d"|"3d-flat"|"3d-volumetric"|"3d-volumetric-uniform" signal AbortSignal optional 允许可取消的请求。 如果取消，promise 将被拒绝，并出现名为 AbortError 的错误。 另请参阅 AbortController。

返回值:

类型	描述
Promise<ContinuousRendererResult>	解析为 ContinuousRendererResult 的实例。

示例代码:

const layer = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/counties_politics_poverty/FeatureServer/0"
});

// visualization based on field and normalization field
const sizeParams = {
  layer: layer,
  view: view,
  field: "POP_POVERTY",
  normalizationField: "TOTPOP_CY"
};

// when the promise resolves, apply the renderer to the layer
sizeRendererCreator.createContinuousRenderer(sizeParams)
  .then(function(response){
    layer.renderer = response.renderer;
  });

const layer = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/counties_politics_poverty/FeatureServer/0"
});

// visualization based off Arcade expression
const sizeParams = {
  layer: layer,
  valueExpression: "($feature.POP_POVERTY / $feature.TOTPOP_CY) * 100",
  view: view,
  legendOptions: {
    title: "% of people living in poverty"
  },
  theme: "above"
};

// when the promise resolves, apply the renderer to the layer
sizeRendererCreator.createContinuousRenderer(sizeParams)
  .then(function(response){
    layer.renderer = response.renderer;
  });

createVisualVariables(params){Promise<VisualVariableResult>}

此方法生成一个大小可视变量数组，其中包含默认停靠点，这些停靠点是根据为指示的字段或表达式查询的统计信息以最佳方式选择的，并映射到适当的大小。

有两种不同的调用此方法。最常见的情况是提供 layer, view, 和field。在这种情况下，数据的统计信息不是众所周知的，用户不知道要使用什么大小。您可以选择使用 valueExpression 代替字段，根据从运行时执行的脚本返回的数值来可视化要素。

提供其他选项是为了方便更多涉及的自定义可视化创作应用程序。例如，如果已在另一个操作中生成了统计信息，则可以在 statistics 参数中传递对象以避免对服务器进行额外调用。如果您不想为您挑选一个，也可以提供 sizeScheme 。在这种情况下， theme 选项将被忽略。

生成的可视变量数组将只包含一个大小的可视变量，除非 axis 参数设置为 "height"。

参数:

规范:

params Object 根据数据生成尺寸视觉变量的输入参数 从给定的字段或表达式返回。 每个参数的详细信息见下表。 规范: layer FeatureLayer|SceneLayer|CSVLayer|GeoJSONLayer|WFSLayer|OGCFeatureLayer 为其生成可视变量的图层。 view View optional 渲染输入层的视图。 这种方法 检查视图的背景（即底图、网络地图背景或视图容器）以确定最佳的 输出渲染器的颜色。 该参数在实践中应始终设置，但如果未提供此方法 将假定生成的渲染器将显示在浅色背景上。 创建时需要这个参数 使用 valueExpression 的渲染器或用于在 SceneView 中显示的渲染器。 field String 将查询其数据进行统计并用于 数据驱动可视化的基础。 如果使用 valueExpression，则忽略此属性。 normalizationField String optional 用于规范化给定值的字段名称 字段。 提供规范化字段有助于最大限度地减少一些可视化错误并标准化数据 因此，由于面积差异或计数变化，所有特征都以最小的偏差可视化。 这个选项是 可视化密度时常用。 sizeScheme SizeScheme optional 在创作应用程序时， 用户可以选择预定义的尺寸方案。 将方案对象传递给此属性以避免得到一个 基于视图的背景。 valueExpression String optional Arcade 表达式如下 Arcade Visualization Profile 定义的规范。 表达式可以使用 $feature 全局变量引用字段值，并且必须返回 一个号码。 此属性覆盖 field 属性，因此用于代替输入 field 值。 valueExpressionTitle String optional 描述从 valueExpression 返回的值的文本。 这由 Legend 微件使用。 theme String optional 默认值: high-to-low 设置大小停止基于 有意义的数据值。 值 描述 high-to-low 最大数据值被分配最大大小。 最小数据值被分配最小大小。 所有其他值都被插值。 above 最大数据值被分配最大大小。 平均数据值被分配最小大小。 对最大数据值和平均值之间的所有其他值进行插值。 这对于映射变量随时间的增加非常有用，例如人口增加或两个日期之间的失业率。 below 最小数据值被分配最大大小。 平均数据值被分配最小大小。 对最小数据值和平均值之间的所有其他值进行插值。 这对于绘制变量随时间的下降情况很有用，例如人口减少或两个日期之间的失业率。 可选值:"high-to-low"|"above"|"below" sqlExpression String optional 计算结果为数字的 SQL 表达式。 sqlWhere String optional 用于过滤统计查询功能的 SQL where 子句。 例如， 这在您想要避免除以零的情况下很有用，就像创建优势的情况一样 可视化。 sizeOptimizationEnabled Boolean optional 默认值: false 表示是否 符号大小应根据视图比例而有所不同。 设置后，一个有效的 MapView 必须在 view 参数中提供实例。 3D 不支持此选项 SceneViews. legendOptions Object optional 提供在提供表达式时为字段设置标题的选项 而不是字段名称。 此标题将代表 Legend 中的字段。 规范: title String optional 用于表示给定字段或表达式的标题 图例. showLegend Boolean optional 表示是否在图例中描述渲染器。 statistics SummaryStatisticsResult optional 从 summaryStatistics 函数生成的统计对象。 如果已经生成了字段的统计信息，则在此处传递对象以避免进行第二次统计 向服务器查询。 minValue Number optional 用户设置的自定义最小值。 将此与 maxValue 结合使用以 生成上下限之间的统计信息。 这将是返回的尺寸视觉变量中的最低点。 maxValue Number optional 用户设置的自定义最大值。 将此与 minValue 结合使用以 生成上下限之间的统计信息。 这将是返回的大小可视变量中的最高点。 worldScale Boolean optional 表示符号的大小单位是否以米为单位。 这在使用 3D 体积符号系统生成可视化时应该为 true 。 axis String optional 默认值: all 当设置为 all 时，一个单一的大小变量，在所有范围内统一缩放 生成维度。 当设置为 height 时，结果包含两个尺寸视觉变量： 第一个根据字段统计设置高度，而第二个定义一个恒定大小 宽度和深度。 可选值:"all"|"height" signal AbortSignal optional 允许可取消的请求。 如果取消，promise 将被拒绝，并出现名为 AbortError 的错误。 另请参阅 AbortController。

返回值:

类型	描述
Promise<VisualVariableResult>	返回 VisualVariableResult的实例

示例代码:

const layer = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/counties_politics_poverty/FeatureServer/0"
});

// visualization based on field and normalization field
const sizeParams = {
  layer: layer,
  view: view,
  field: "POP_POVERTY",
  normalizationField: "TOTPOP_CY",
  theme: "below"
};

// when the promise resolves, apply the visual variables to the renderer
sizeRendererCreator.createVisualVariables(sizeParams)
  .then(function(response){
    const renderer = layer.renderer.clone();
    renderer.visualVariables = response.visualVariables;
    layer.renderer = renderer;
  });

const layer = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/counties_politics_poverty/FeatureServer/0"
});

// visualization based off Arcade expression
const sizeParams = {
  layer: layer,
  valueExpression: "($feature.POP_POVERTY / $feature.TOTPOP_CY) * 100",
  view: view,
  legendOptions: {
    title: "% of people living in poverty"
  }
};

// when the promise resolves, apply the visual variables to the renderer
sizeRendererCreator.createVisualVariables(sizeParams)
  .then(function(response){
    const renderer = layer.renderer.clone();
    renderer.visualVariables = response.visualVariables;
    layer.renderer = renderer;
  });

类型定义

AgeRendererResult

起始版本: GeoScene API for JavaScript 4.22

createAgeRenderer() 方法的结果对象。有关每个属性的详细信息，请参阅下表。

属性:

renderer ClassBreaksRenderer 渲染器对象配置为与视图的背景和数据的分布最佳匹配。 在图层的 renderer 属性上设置它以更新其可视化。

visualVariables SizeVariable[] 根据数据的统计信息和大小方案配置的大小可视变量。

unit String 用于在输出 renderer中表示年龄的时间单位

sizeScheme SizeScheme 视觉变量使用的大小方案。

defaultValuesUsed Boolean 表示在图层中没有足够的数据和/或统计数据时是否使用默认值。当所有要素都具有相同的字段值或根本没有值时，通常使用默认值。

statistics SummaryStatisticsResult 从生成的表达式的查询返回的基本统计信息。

basemapId String 用于确定要素最佳填充颜色的底图 ID。

basemapTheme String 表示输入视图底图的平均颜色是light还是dark。

ClassBreaksRendererResult

起始版本: GeoScene API for JavaScript 4.22

createClassBreaksRenderer() 方法的结果对象。有关每个属性的详细信息，请参阅下表。

属性:

renderer ClassBreaksRenderer 渲染器对象配置为最佳 匹配视图的背景和数据的分布。 在图层的 renderer 属性上将此设置为 更新其可视化。

classBreaksResult ClassBreaksResult 此对象描述使用指定分类方法从给定字段的图层中的数据生成的分类间隔。

sizeScheme SizeScheme 视觉变量使用的大小方案。

defaultValuesUsed Boolean 视觉变量使用的大小方案。

basemapId String 用于确定要素最佳填充颜色的底图 ID。

basemapTheme String 表示输入视图底图的平均颜色是light还是dark。

ContinuousRendererResult

createContinuousRenderer() 方法的结果对象。有关每个属性的详细信息，请参阅下表。

属性:

renderer ClassBreaksRenderer 配置为最匹配视图背景和数据展开的呈现器对象。在图层的 renderer 属性上设置此项以更新其可视化效果。

visualVariables SizeVariable[] 根据数据的统计信息配置的可视变量的大小。

sizeScheme SizeScheme 视觉变量使用的大小方案。

defaultValuesUsed Boolean 表示在缺少足够的数据和/或来自图层的统计信息时是否使用默认值。 当所有要素具有相同的字段值或根本没有值时，通常使用默认值。

statistics SummaryStatisticsResult 从查询返回给服务的基本统计信息，用于给定字段名称或表达式中的数据。

basemapId String 用于确定要素最佳填充颜色的底图 ID。

basemapTheme String 表示输入视图底图的平均颜色是light还是dark。

VisualVariableResult

createVisualVariables() 方法的结果对象。 见表 下面是每个属性的详细信息。

属性:

visualVariables SizeVariable[] 基于数据统计信息和视图比例配置的大小可视变量数组。

sizeScheme SizeScheme 主视觉变量使用的大小方案。

defaultValuesUsed Boolean 表示在图层中没有足够的数据和/或统计数据时是否使用了默认值。当所有要素都具有相同的字段值或根本没有值时，通常使用默认值。

statistics SummaryStatisticsResult 从查询返回给给定字段或表达式的服务的基本统计信息。

basemapId String 用于确定要素最佳填充颜色的底图 ID。

basemapTheme String 表示输入视图底图的平均颜色是light还是dark。

authoringInfo AuthoringInfo 与创建可视变量相关的创作信息。这包括与来自滑块和所选主题的 UI 输入相关的信息。