流向

方法概述

方法详情

cloneScheme(scheme){FlowScheme}

克隆流程方案对象。

参数：

scheme FlowScheme 要克隆的流程方案对象。

返回：

类型	描述
FlowScheme	返回给定配色方案对象的克隆。

例子：

// clones the primary scheme returned from the getSchemes() method
let flowScheme = primaryScheme.clone();

getSchemeByName(params){FlowScheme}

返回具有给定名称的流向方案。

参数

规范:

params Object 有关可能传递给此函数的每个参数的详细信息，请参见下表。 详述： name String 所需方案的名称。 theme String optional 默认值： "flow-line" 确定流线将如何呈现。下面列出了可能的值。 值 描述 例子 flow-line UV 和幅度数据渲染为动画流线。 这是表示风和其他大气数据的理想选 wave-front 似波浪的动画中渲染 UV 和幅度数据。 这个主题适用于海洋数 可能值:"flow-line"|"wave-front" basemap String|Basemap optional 与可视化配对的 GeoScene 底图。 此值表示根据给定底图可视化流线的最佳颜色。 如果您有非 GeoScene 底图（例如具有自定义样式的 VectorTileLayer 底图）或根本没有底图，则使用 basemapTheme  参数而不是此参数。 basemapTheme String optional 如果您有非 GeoScene 底图（例如具有自定义样式的 VectorTileLayer 底图）或根本没有底图，请使用此参数来表示可视化的背景是 light 或 dark。 可能值:"light"|"dark"

返回：

类型	描述
FlowScheme	返回与给定名称匹配的方案。

例如：

// Constructs the scheme using the Perfect Pigtails color ramp.
const schemes = flowSchemes.getSchemeByName({
  name: "Perfect Pigtails",
  basemapTheme: "dark",
  theme: "wave-front"
});

getSchemes(params){FlowSchemes}

返回定义 ImageryTileLayer 和 ImageryLayer 中流向可视化属性的主要方案和次要方案。  basemap 参数确定用于可视化流线的适当颜色方案。

参数：

规范:

params Object 有关可能传递给此函数的每个参数的详细信息，请参见下表。 详述： theme String optional 默认值: "flow-line" 确定流线将如何呈现。下面列出了可能的值。 值 描述 例子 flow-line UV 和幅度数据渲染为动画流线。 这是表示风和其他大气数据的理想选 wave-front 似波浪的动画中渲染 UV 和幅度数据。 这个主题适用于海洋数 可能值:"flow-line"|"wave-front" basemap String|Basemap optional 与可视化配对的 GeoScene 底图。 此值表示根据给定底图可视化流线的最佳颜色。 如果您有非 GeoScene 底图（例如具有自定义样式的 VectorTileLayer 底图）或根本没有底图，则使用  basemapTheme  参数而不是此参数。 basemapTheme String optional 如果您有非 GeoScene 底图（例如具有自定义样式的 VectorTileLayer 底图）或根本没有底图，请使用此参数来表示可视化的背景是 light 或 dark。 可能值:"light"|"dark"

返回：

类型	描述
FlowSchemes	一个对象，其中包含用于给定底图的主要流程方案。 还提供了辅助方

例子：

// gets the primary scheme for the features of the given geometry type and basemap
const schemes = flowSchemes.getSchemes({
  basemapTheme: "dark",
  theme: "wave-front"
});

// the suggested default scheme for the layer, basemap, and theme
let primaryScheme = schemes.primaryScheme;

getSchemesByTag(params){FlowScheme[]}

返回由参数中包含和排除的标签过滤的流程方案。

参数：

规范:

params Object 有关可能传递给此函数的每个参数的详细信息，请参见下表。 详述： includedTags String[] optional 提供时，只会返回包含所有匹配标签的方案。 已知标签: light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays | bright | subdued | colorblind-friendly | diverging | sequential | 3d excludedTags String[] optional 提供时，仅返回不包括所有提供的标签的方案。 已知标签: light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays | bright | subdued | colorblind-friendly | diverging | sequential | 3d theme String optional 默认值: "flow-line" 确定流线的渲染方式。 下面列出了可能的值。 值 描述 例子 flow-line uv 和幅度数据渲染为动画流线。 这是表示风和其他大气数据的理想选 wave-front 似波浪的动画中渲染 UV 和幅度数据。 这个主题适用于海洋数 可能值:"flow-line"|"wave-front" basemap String|Basemap optional 与可视化配对的 GeoScene 底图。 此值表示根据给定底图可视化流线的最佳颜色。 如果您有非 GeoScene 底图（例如具有自定义样式的 VectorTileLayer 底图）或根本没有底图，则使用  basemapTheme  参数而不是此参数。 basemapTheme String optional 如果您有非 GeoScene 底图（例如具有自定义样式的 VectorTileLayer 底图）或根本没有底图，请使用此参数来表示可视化的背景是 浅色 或 深色。 默认值:"light"|"dark"

返回：

类型	描述
FlowScheme[]	一个流程方案数组，其中包含在搜索中的给定标签，但不包括从搜索中排除的给定标

例子：

// returns colorblind friendly red color schemes
const schemes = flowSchemes.getSchemesByTag({
  basemapTheme: "dark",
  theme: "wave-front",
  includedTags: [ "reds", "colorblind-friendly" ]
});

getThemes(basemap){Theme[]}

返回可用主题的元数据。 如果提供了底图，则返回最适合给定底图的主题。

参数：

basemap String|Basemap optional 将与返回的主题一起使用的 GeoScene 底图字符串 或底图对象。

返回：

类型	描述
Theme[]	一个对象，其中包含有关给定底图的可用主题的信

类型定义

FlowScheme

用于定义用于可视化流线的方案的建议属性值。

参数：

name String 方案的唯一名称。

tags String[] 与方案关联的标签。

id String  要在可视化中使用的配色方案的唯一 ID。 id 是根据以下模板分配的： <themeName>/<basemapName>/<schemeName>。

theme String 确定流线将如何呈现。下面列出了可能的值。 值 描述 例子 flow-line UV 和幅度数据渲染为动画流线。 这是表示风和其他大气数据的理想选 wave-front 似波浪的动画中渲染 UV 和幅度数据。 这个主题适用于海洋数 可能值:"flow-line"|"wave-front"

color Color 如果不需要颜色视觉变量，建议的流线颜色。

colors Color[] 如果在流渲染器上设置了  ColorVariable，建议使用的颜色。

density Number 流线的建议密度。

flowSpeed Number 流线的建议流速度。

trailLength Number 建议的流线长度。

trailWidth Number 建议的流线宽度。

layerEffect String 建议的效果应用到输入图层。

minWidth Number 如果在流向渲染器上设置了 SizeVariable，则建议的大小适用于小幅度值。

maxWidth Number 如果在流向渲染器上设置了  SizeVariable，则建议的大小应用于较大的量值。

minOpacity Number 如果在流向渲染器上设置了 OpacityVariable，则建议将不透明度应用于较小的值。

maxOpacity Number 如果在流向渲染器上设置了 OpacityVariable，则建议对较大的不透明度值应用。

FlowSchemes

getSchemes()  方法的返回对象。

属性：

primaryScheme FlowScheme 最适合给定底图的流程方案。

secondarySchemes FlowScheme[] 可用于可视化叠加在给定底图或底图主题上的流线的其他流程方案。

basemapId String 与给定方案关联的底图 ID。

basemapTheme String 表示平均底图颜色是否为 浅色 或 深色。

主题

描述与给定底图完美匹配的主题。 有关此对象中属性的更多详细信息，请参见下表。

属性：

name String 主题名称。

label String 在 UI 元素中标识主题的标签。

description String 在 UI 中描述主题的文本。

basemaps String[] GeoScene 基图与给定的主题很好地配对。