flow

方法概述

方法详细说明

createRenderer(params){Promise<FlowRendererResult>}

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

参数

规范

params Object 用于生成流可视化的输入参数。各参数的详细信息见下表。 规范 layer ImageryLayer|ImageryTileLayer 为其生成渲染器的输入图层。栅格的源类型必须是 Vector-UV 或 Vector-MagDir。 view MapView optional 渲染输入图层的视图。此方法可检查视图的背景 (即底图、web 地图背景或视图容器)，以确定输出渲染器的最佳颜色。在实践中应始终设置此参数，但如果未提供，此方法将假定生成的渲染器显示在浅色背景上。 theme String optional 默认值："flow-line" 确定如何呈现流线。下面列出了可能的值。 值 描述 示例 flow-line 将 uv 和量级数据渲染为动画流线。这是代表风和其他大气数据的理想方法。 wave-front 在类似波浪的动画中渲染 UV 和量级数据。此主题适用于海洋数据。 可能值："flow-line"|"wave-front" includeColorVariable Boolean optional 默认值： false 当为 true 时，流线的颜色将根据数据的量级大小而变化。具有较强量级值的流线将在深色背景上具有明亮的颜色，在浅色背景上具有深色，从而使它们更加突出。 includeSizeVariable Boolean optional 默认值： false 当为 true 时，流线的宽度将根据数据的量级大小而变化。具有较强量级值的流线将比具有较弱量级值的线更宽，从而使它们更加突出。 includeOpacityVariable Boolean optional 默认值： false 当为 true 时，流线的不透明度将根据数据的量级大小而变化。具有较强量级值的流线将比具有较弱量级值的线更不透明，从而使它们更加突出。 legendOptions Object optional 提供在 Legend 中设置渲染器标题的选项。 规范 title String optional 用于表示 Legend 中的数据的标题。 flowScheme FlowScheme optional 用于为流线设置颜色和大小的流方案。 renderingRule RasterFunction optional 指定应如何渲染请求影像的规则。当应用 renderingRule 时，服务器将返回更新的服务信息，该信息反映了渲染规则定义的自定义处理。如果未提供，则使用图层的 renderingRule 创建输出渲染器。 flowRepresentation String optional 定义数据的流向可对其进行修改以显示气象数据 (即从哪个方向流动) 或海洋数据 (即流向哪个方向)。有关详细信息，请参阅 FlowRenderer.flowRepresentation。 可能值："flow-from"|"flow-to" signal AbortSignal optional 允许可取消的请求。如果取消，则承诺将被拒绝，并返回一个名为 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;

类型定义

FlowRendererResult

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

属性

renderer FlowRenderer 应用于输入图层的 FlowRenderer 渲染器。

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

visualVariables VisualVariable[] 输出渲染器中包含的视觉变量。

statistics SummaryStatisticsResult 栅格图层的汇总统计信息。

basemapId String 用于确定流线的最佳颜色的底图 ID。

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

layerEffect String 建议的图层效果应用到输入图层。当 basemapTheme 为暗色时，建议向图层添加一个光晕。