JavaScript ArcGIS flow.createRenderer用法及代码示例

基本信息

以下是所在类或对象的基本信息。

AMD: require(["esri/smartMapping/raster/renderers/flow"], (flowRendererCreator) => { /* code goes here */ });

ESM: import * as flowRendererCreator from "@arcgis/core/smartMapping/raster/renderers/flow";

对象： esri/smartMapping/raster/renderers/flow

自从：用于 JavaScript 4.23 的 ArcGIS API

用法说明

flow.createRenderer函数(或属性)的定义如下：

createRenderer (params) {Promise<FlowRendererResult>}

生成 FlowRenderer 以显示带有流线的栅格数据。该渲染器通常用于可视化气象学和海洋学栅格数据中的流向和幅度信息。

参数：

规格：

类型说明

params Object

用于生成流可视化的输入参数。有关每个参数的详细信息，请参见下表。

规格：

layer

ImageryLayer|ImageryTileLayer

为其生成渲染器的输入层。栅格的 source type 必须是 Vector-UV 或 Vector-MagDir 。

view

MapView

可选的

渲染输入层的视图。此方法检查视图的背景(即底图、Web Map背景或视图容器)以确定输出渲染器的最佳颜色。在实践中应始终设置此参数，但如果未提供此参数，则此方法将假定生成的渲染器将显示在浅色背景上。

theme

String

可选的

默认值："flow-line"

确定流线的渲染方式。下面列出了可能的值。

值	说明	示例
flow-line	将 uv 和幅度数据渲染为动画流线。这是表示风和其他大气数据的理想选择。
wave-front	在wave-like 动画中渲染 UV 和幅度数据。这个主题适用于海洋数据。

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

includeColorVariable

Boolean

可选的

默认值：错误的

true 时，流线的颜色会根据数据的大小而变化。具有较强幅度值的流线将在深色背景上具有明亮的颜色，在浅色背景上具有深色，从而使它们更加突出。

includeSizeVariable

Boolean

可选的

默认值：错误的

当 true 时，流线的宽度会根据数据的大小而变化。具有较强幅度值的流线将比具有较弱幅度值的线更宽，从而使它们更加突出。

includeOpacityVariable

Boolean

可选的

默认值：错误的

true 时，流线的不透明度会根据数据的大小而变化。具有较强幅度值的流线将比具有较弱幅度值的线更不透明，从而使它们更加突出。

legendOptions

Object

可选的

提供用于在 Legend 中为渲染器设置标题的选项。

规格：

title

String

可选的

用于表示 Legend 中数据的标题。

flowScheme

FlowScheme

可选的

用于为流线设置颜色和大小的流方案。

renderingRule

RasterFunction

可选的

指定应如何呈现所请求图像的规则。应用renderingRule 时，服务器会返回反映呈现规则定义的自定义处理的更新服务信息。如果未提供，则使用图层的 renderingRule 创建输出渲染器。

flowRepresentation

String

可选的

定义数据的流向。可以对其进行修改以显示气象数据(流向)或海洋数据(流向)。有关详细信息，请参阅FlowRenderer.flowRepresentation。

可能的值："flow-from"|"flow-to"

signal

AbortSignal

可选的

允许可取消的请求。如果取消，promise 将被拒绝，并出现名为 AbortError 的错误。另见AbortController。

类型	说明
Promise<FlowRendererResult>	解析为包含可以在输入层上设置的FlowRenderer 的对象。

例子：

const { renderer } = await flowRendererCreator.createRenderer({
  layer,
  view,
  theme: "wave-front",
  flowRepresentation: "flow-to"
});

// renders animated wave-like lines on the raster
layer.renderer = renderer;

相关用法

注：本文由纯净天空筛选整理自arcgis.com大神的英文原创作品 flow.createRenderer。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。

基本信息

用法说明

参数：

返回：

例子：