flow

方法概述

方法详细说明

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 底图 (例如，具有自定义样式的 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}

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

参数

规范

params Object 有关可能传递给此函数的每个参数的详细信息，请参阅下表。 规范 theme String optional 默认值："flow-line" 确定如何呈现流线。下面列出了可能的值。 值 描述 示例 flow-line 将 uv 和量级数据渲染为动画流线。这是代表风和其他大气数据的理想方法。 wave-front 在类似波浪的动画中渲染 UV 和量级数据。此主题适用于海洋数据。 可能值："flow-line"|"wave-front" basemap String|Basemap optional 与可视化配对的底图。此值表示针对给定底图进行可视化流线的最佳颜色。如果您具有非 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 底图 (例如，具有自定义样式的 VectorTileLayer 底图) 或根本没有底图，则可使用 basemapTheme 参数而不是此参数。 basemapTheme String optional 如果您具有非 GeoScene 底图 (例如，具有自定义样式的 VectorTileLayer 底图) 或根本没有底图，则可使用此参数来表示可视化的背景是 light 还是 dark。 可能值："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 流线的建议 flowSpeed。

trailLength Number 流线的建议长度。

trailWidth Number 流线的建议宽度。

trailCap Number 流线的建议 cap 样式。

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 表示平均底图颜色是 light 还是 dark。

Theme

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

属性

name String 主题的名称。

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

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

basemaps String[] 与给定主题完美匹配的 GeoScene 底图。