univariateColorSize

方法概述

方法详细说明

createContinuousRenderer(params){Promise<ContinuousRendererResult>}

生成一个渲染器，可直接将其应用于图层。渲染器包含连续的颜色和大小视觉变量，这些变量根据视图的背景映射具有最佳颜色和大小的符号，以根据指示字段或表达式的汇总统计数据停止值。

在大多数情况下，您将提供 layer、basemap、field 和 theme 来生成此渲染器。在这种情况下，数据的统计信息不是众所周知的，并且用户不知道要在可视化中使用什么颜色和大小。您还可以使用 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 用于规范化给定 field 值的字段名称。提供规范化字段有助于最大限度地减少一些可视化错误并标准化数据，因此，由于面积的差异或计数变化，所有要素都以最小的偏差可视化。此选项通常在可视化密度时使用。 valueExpression String optional 遵循 Arcade 可视化配置文件定义的规范的 Arcade 表达式 表达式。表达式可以使用 $feature 配置变量来引用字段值，并且必须返回一个数字。此属性覆盖 field 属性，因此用于代替输入 field 值。 valueExpressionTitle String optional 描述从 valueExpression 返回的值的文本。这由 Legend 微件使用。 theme String optional 默认值：high-to-low 基于有意义的数据值，设置大小停止点和颜色。从 4.18 版开始。 值 描述 high-to-low 为最大数据值分配最大大小和颜色。为最小数据值分配最小大小和颜色。对所有其他值进行插值。 above 为最大数据值分配最大大小和颜色。为平均数据值或零值分配最小大小和颜色。对最大数据值和平均值之间的所有其他值进行插值。这对于绘制变量随时间而增加的情况非常有用，例如人口的增加或两个日期之间的失业率。 below 为最小数据值分配最大大小和颜色。为平均数据值或零值分配最小大小和颜色。对最小数据值和平均值之间的所有其他值进行插值。这对于绘制变量随时间而下降的情况非常有用，例如人口的减少或两个日期之间的失业率。 above-and-below 为最小和最大数据值分配最大大小和颜色。为平均数据值或零值分配最小大小和颜色。使用发散色带。最小和最大数据值与平均值之间的所有其他值都将被插值。这对于映射值随时间和速率的变化非常有用。 可能值："high-to-low"|"above"|"below"|"above-and-below" sqlExpression String optional 一个 SQL 表达式，其计算结果为数字。 sqlWhere String optional SQL where 子句，用于过滤统计查询的要素。例如，当您希望避免除以 0 的情况时 (像创建优势可视化的情况那样)，这很有用。 sizeOptimizationEnabled Boolean optional 默认值： false 指示符号大小是否应根据视图比例而变化。设置后，必须在 view 参数中提供有效的 MapView 实例。3D SceneViews 不支持此选项。 statistics SummaryStatisticsResult optional 从 summaryStatistics 函数生成的统计信息对象。如果已生成了字段的统计信息，则在此处传递对象以避免向服务器进行第二次统计信息查询。 minValue Number optional 用户设置的自定义最小值。将此参数与 maxValue 结合使用可在下限和上限之间生成统计信息。这将是返回的视觉变量中的最低停止点。 maxValue Number optional 用户设置的自定义最大值。将此参数与 minValue 结合使用可在下限和上限之间生成统计信息。这将是返回的视觉变量中的最高停止点。 defaultSymbolEnabled Boolean optional 在渲染器上启用 defaultSymbol，并将其分配给没有值的要素以及位于配置数据范围之外的要素。 colorOptions Object optional 用于配置可视化颜色部分的选项。 规范 colorScheme ColorScheme optional 在制作应用程序中，用户可以选择预定义的颜色方案。将方案对象传递到此属性，以避免基于 theme 和 basemap 获取方案对象。 isContinuous Boolean optional 默认值： false 仅适用于 above-and-below 主题。如果为 true，则向渲染器添加具有发散色带的 ColorVariable。从 4.18 版开始。 sizeOptions Object optional 用于配置可视化大小部分的选项。 规范 sizeScheme SizeScheme optional 在制作应用程序中，用户可以选择预定义的大小方案。将方案对象传递到此属性，以避免基于视图的背景获取方案对象。 symbolOptions Object optional 用于设置 above-and-below 主题的符号的选项。从 4.18 版开始。 参数 规范 symbolStyle String optional 根据预定义的命名符号对设置上方和下方符号。 可能值："caret"|"circle-caret"|"arrow"|"circle-arrow"|"plus-minus"|"circle-plus-minus"|"square"|"circle"|"triangle"|"happy-sad"|"thumb" symbols Object optional 允许您在 above-and-below 主题中指定自定义符号。 规范 above Symbol 用于 above-and-below 可视化的上部分的符号。 below Symbol 用于 above-and-below 可视化的下部分的符号。 legendOptions Object optional 提供用于配置 Legend 的选项，该图例表示从此方法生成的渲染器。从 4.18 版开始。 规范 title String optional 用于表示 Legend 中使用此方法生成的渲染器的标题。 showLegend Boolean optional 表示 Legend 微件是否应显示描述生成的渲染器的内容。 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" forBinning Boolean optional 指示生成的渲染器是否用于图格可视化。如果为 true，则此方法中的输入字段应引用该图层的 featureReduction 属性中定义的聚合字段。 signal AbortSignal optional 允许可取消的请求。如果取消，则承诺将被拒绝，并返回一个名为 AbortError 的错误。另请参见 AbortController。

返回

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

示例

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

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

// when the promise resolves, apply the renderer to the layer
colorAndSizeRendererCreator.createContinuousRenderer(params)
  .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"
});

// above-and-below visualization based off Arcade expression
const params = {
  layer: layer,
  valueExpression: "(($feature.votes_2016 - $feature.votes_2012) / $feature.votes_2016) * 100",
  valueExpressionTitle: "Change in votes from 2012-2016",
  view: view,
  theme: "above-and-below",
  colorOptions: {
    isContinuous: false
  },
  symbolOptions: {
    symbolStyle: "arrow"
  }
};

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

createVisualVariables(params){Promise<VisualVariablesResult>}

此方法基于相同的给定字段或表达式生成颜色和大小视觉变量。这些视觉变量是使用默认停靠点生成的，这些停止点是根据为指示的字段或表达式查询的统计数据以及基于视图背景的颜色而以最佳方式选择的。

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

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

视觉变量的结果数组将包含一个颜色视觉变量，以及一个或两个大小视觉变量，具体取决于 sizeOptions.axis 参数的值。

参数

规范

params Object 输入参数，用于根据从给定字段或表达式返回的数据生成颜色和大小视觉变量。各参数的详细信息见下表。 规范 layer FeatureLayer|SceneLayer|CSVLayer|GeoJSONLayer|WFSLayer|OGCFeatureLayer 为其生成视觉变量的图层。 view View optional 渲染输入图层的视图。此方法可检查视图的背景 (即底图、web 地图背景或视图容器)，以确定输出渲染器的最佳颜色。在实践中应始终设置此参数，但如果未提供，此方法将假定生成的渲染器显示在浅色背景上。使用 valueExpression 创建渲染器或用于在 SceneView 中显示的渲染器时，此参数是必需的。 field String optional 将查询其数据以进行统计并用作数据驱动可视化的基础的字段名称。如果使用 valueExpression，则忽略此属性。 normalizationField String optional 用于规范化给定 field 值的字段名称。提供规范化字段有助于最大限度地减少一些可视化错误并标准化数据，因此，由于面积的差异或计数变化，所有要素都以最小的偏差可视化。此选项通常在可视化密度时使用。 valueExpression String optional 遵循 Arcade 可视化配置文件定义的规范的 Arcade 表达式 表达式。表达式可以使用 $feature 配置变量来引用字段值，并且必须返回一个数字。此属性覆盖 field 属性，因此用于代替输入 field 值。 valueExpressionTitle String optional 描述从 valueExpression 返回的值的文本。这由 Legend 微件使用。 theme String optional 默认值：high-to-low 基于有意义的数据值，设置大小停止点和颜色。 值 描述 high-to-low 为最大数据值分配最大大小和颜色。为最小数据值分配最小大小和颜色。对所有其他值进行插值。 above 为最大数据值分配最大大小和颜色。为平均数据值或零值分配最小大小和颜色。对最大数据值和平均值之间的所有其他值进行插值。这对于绘制变量随时间而增加的情况非常有用，例如人口的增加或两个日期之间的失业率。 below 为最小数据值分配最大大小和颜色。为平均数据值或零值分配最小大小和颜色。对最小数据值和平均值之间的所有其他值进行插值。这对于绘制变量随时间而下降的情况非常有用，例如人口的减少或两个日期之间的失业率。 above-and-below 为最小和最大数据值分配最大大小和颜色。为平均数据值或零值分配最小大小和颜色。使用发散色带。最小和最大数据值与平均值之间的所有其他值都将被插值。这对于映射值随时间和速率的变化非常有用。 可能值："high-to-low"|"above"|"below"|"above-and-below" sqlExpression String optional 一个 SQL 表达式，其计算结果为数字。 sqlWhere String optional SQL where 子句，用于过滤统计查询的要素。例如，当您希望避免除以 0 的情况时 (像创建优势可视化的情况那样)，这很有用。 statistics SummaryStatisticsResult optional 从 summaryStatistics 函数生成的统计信息对象。如果已生成了字段的统计信息，则在此处传递对象以避免向服务器进行第二次统计信息查询。 minValue Number optional 用户设置的自定义最小值。将此参数与 maxValue 结合使用可在下限和上限之间生成统计信息。这将是返回的视觉变量中的最低停止点。 maxValue Number optional 用户设置的自定义最大值。将此参数与 minValue 结合使用可在下限和上限之间生成统计信息。这将是返回的视觉变量中的最高停止点。 colorOptions Object optional 用于配置可视化颜色部分的选项。 规范 theme String optional 默认值：high-to-low 确定将在连续色带和地图中强调哪些值。下面列出了可能的值。 值 描述 示例 high-to-low 使用深色强调高值。 above-and-below 以给定点为中心的值 (例如平均值) 使用浅色显示，而其他值使用深色强调。 centered-on 以给定点为中心的值 (例如平均值) 使用深色强调，而其他值使用浅色显示。 extremes 使用深色强调高值和低值。所有其他值均使用浅色显示。 可能值："high-to-low"|"above-and-below"|"centered-on"|"extremes" colorScheme ColorScheme optional 在制作应用程序中，用户可以选择预定义的颜色方案。将方案对象传递到此属性，以避免基于 theme 和 view 获取方案对象。 legendOptions Object optional 提供选项，用于在提供表达式而不是字段名称时设置字段的标题。此标题将表示 Legend 中的字段。 规范 title String 用于表示 Legend 中的给定字段或表达式的标题。 isContinuous Boolean optional 默认值：true 仅适用于 above-and-below 主题。如果为 true，则向渲染器添加具有发散色带的 ColorVariable。 sizeOptions Object optional 用于配置可视化大小部分的选项。 规范 axis String optional 默认值： all 当设置为 all 时，将生成一个在所有维度上进行统一缩放的单个大小变量。当设置为 height 时，结果将包含两个大小视觉变量：第一个根据字段统计设置高度，而第二个定义一个恒定大小宽度和深度。 可能值："all"|"height" sizeScheme SizeScheme optional 在制作应用程序中，用户可以选择预定义的大小方案。将方案对象传递到此属性，以避免基于视图的背景获取方案对象。 legendOptions Object optional 提供选项，用于在提供表达式而不是字段名称时设置字段的标题。此标题将表示 Legend 中的字段。 规范 title String 用于表示 Legend 中的给定字段或表达式的标题。 worldScale Boolean optional 表示符号的尺寸单位是否以米为单位。这在使用 3D 体积符号系统生成可视化时应该为 true。如果此属性设置为 true，则必须提供 view。 forBinning Boolean optional 指示生成的渲染器是否用于图格可视化。如果为 true，则此方法中的输入字段应引用该图层的 featureReduction 属性中定义的聚合字段。 signal AbortSignal optional 允许可取消的请求。如果取消，则承诺将被拒绝，并返回一个名为 AbortError 的错误。另请参见 AbortController。

返回

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

示例

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

// color/size univariate visualization based on field and normalization field
const params = {
  layer: layer,
  view: view,
  field: "POP_POVERTY",
  normalizationField: "TOTPOP_CY",
  theme: "above"
};

// when the promise resolves, apply the visual variables to the renderer
colorAndSizeRendererCreator.createVisualVariables(params)
  .then(function(response){
    const renderer = layer.renderer.clone();
    renderer.visualVariables = [ response.color.visualVariable, ...response.size.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 an Arcade expression
const params = {
  layer: layer,
  view: view,
  valueExpression: "($feature.POP_POVERTY / $feature.TOTPOP_CY) * 100",
  sqlExpression: "( POP_POVERTY / TOTPOP_CY ) * 100"
};

// when the promise resolves, apply the visual variables to the renderer
colorAndSizeRendererCreator.createVisualVariables(params)
  .then(function(response){
    const renderer = layer.renderer.clone();
    renderer.visualVariables = [ response.color.visualVariable, ...response.size.visualVariables ];
    layer.renderer = renderer;
  });

类型定义

ContinuousRendererResult

createContinuousRenderer() 方法的结果对象。各属性的详细信息见下表。

属性

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

color Object 包含可视化颜色部分的视觉变量和方案信息的对象。 规范 visualVariable ColorVariable 根据数据的统计信息和颜色方案配置的颜色视觉变量。 colorScheme ColorScheme 视觉变量使用的配色方案。

size Object 包含可视化大小部分的视觉变量和方案信息的对象。 规范 visualVariables SizeVariable[] 基于数据的统计信息和视图比例配置的大小视觉变量。 sizeScheme SizeScheme 视觉变量使用的大小方案。

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

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

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

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

VisualVariablesResult

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

属性

color Object 包含可视化颜色部分的视觉变量和方案信息的对象。 规范 visualVariable ColorVariable 根据数据的统计信息和颜色方案配置的颜色视觉变量。 colorScheme ColorScheme 视觉变量使用的配色方案。

size Object 包含可视化大小部分的视觉变量和方案信息的对象。 规范 visualVariables SizeVariable[] 基于数据的统计信息和视图比例配置的大小视觉变量。 sizeScheme SizeScheme 视觉变量使用的大小方案。

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

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

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

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

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