优势

方法概述

方法详述

cloneScheme(scheme){PredominanceScheme}

克隆一个优势方案对象。

参数：

scheme PredominanceScheme 要克隆的优势方案对象。

返回：

类型	描述
PredominanceScheme	返回给定优势方案对象的克隆。

例子：

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

getSchemeByName(params){PredominanceScheme}

起始版本: GeoScene API for JavaScript 4.12

返回具有提供的名称的优势方案。

参数：

规范:

params Object 关于可能传递给该函数的每个参数的详细信息，请参见下表。 详述： name String 要检索的方案的名称。 basemap String|Basemap optional 与可视化配对的底图。 此值指示使用给定底图可视化要素的最佳符号颜色。 basemapTheme String optional 如果您有非 GeoScene 底图（例如具有自定义样式的 VectorTileLayer 底图）或根本没有底图，请使用此参数来指示可视化的背景是 light 或 dark。 可能值:"light"|"dark" geometryType String 将要素的几何类型可视化。 可能值:"point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch" numColors Number 在优势可视化中包含的唯一值的数量。 theme String optional 默认值: default 确定要返回的主要和次要配色方案集。 值通常为 "default"。 worldScale Boolean optional 表示方案的大小单位是否以米为单位。 当该方案旨在用于 3D 体积符号系统时，这应该是 true 。 如果此属性设置为 true ，则必须提供view 。 view SceneView optional 将在其中使用该方案的 SceneView 实例。 此属性仅适用于将方案与 3D 符号结合使用时。

返回：

类型	描述
PredominanceScheme	返回具有给定名称的优势方案。

例子：

// Returns the Flower Field scheme
let flowerFieldScheme = colorSchemes.getSchemeByName({
  name: "Flower Field",
  basemap: map.basemap,
  geometryType: featureLayer.geometryType
});

getSchemes(params){PredominanceSchemes}

返回定义图层中基于优势的数据驱动可视化的符号属性的主要方案和次要方案。 basemap 参数确定用于可视化每个要素的符号颜色。 geometryType 确定要返回的符号类型。

参数：

规范:

params Object 关于可能传递给该函数的每个参数的详细信息，请参见下表。 详述： basemap String|Basemap optional 与可视化配对的 GeoScene 底图。 此值指示用于根据给定底图可视化要素的最佳符号颜色。 如果您有非 GeoScene 底图（例如具有自定义样式的 VectorTileLayer 底图）或根本没有底图，则使用 basemapTheme  参数而不是此参数。 basemapTheme String optional 如果您有非 GeoScene 底图（例如具有自定义样式的 VectorTileLayer 底图）或根本没有底图，请使用此参数来指示可视化的背景是 light 或 dark。 可能值:"light"|"dark" geometryType String 将要素的几何类型可视化。 可能值:"point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch" numColors Number 要包含在优势可视化中的唯一值的数量。 theme String optional 默认值: default 确定要返回的主要和次要配色方案集。 其值总为 "default"。 worldScale Boolean optional 表示方案的大小单位是否以米为单位。 当该方案旨在用于 3D 体积符号系统时，这应该是 true 。 如果此属性设置为 true ，则必须提供 view 。 view SceneView optional 将在其中使用该方案的 SceneView 实例。 此属性仅适用于将方案与 3D 符号结合使用时。

返回：

类型	描述
PredominanceSchemes	包含用于给定底图的最佳类型方案的对象； 它还包含辅助方案。

例如

// gets the primary scheme for the features of the given geometry type and basemap
const schemes = predominanceSchemes.getSchemes({
  basemap: map.basemap,
  geometryType: featureLayer.geometryType
});

// the best default scheme for the layer and basemap
const primaryScheme = schemes.primaryScheme;

getSchemesByTag(params){PredominanceScheme[]}

起始版本: GeoScene API for JavaScript 4.12

返回具有提供的标签的优势方案数组。 这些方案为可以使用渲染器渲染的任何图层中的优势可视化定义符号属性。

参数：

规范:

params Object 有关可能传递给此函数的每个参数的详细信息，请参见下表。 详述： includedTags String[] optional 当提供时，只返回包含所有匹配标记的方案。 已知标签: light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays | bright | subdued | deuteranopia | protanopia | tritanopia | grayscale | types | dot-density excludedTags String[] optional 当提供时，只会返回缺少所有提供的标记的方案。 已知标签: light | dark | reds | yellows | oranges | greens | blues | purples | pinks | browns | grays | bright | subdued | deuteranopia | protanopia | tritanopia | grayscale | types | dot-density basemap String|Basemap optional 与可视化配对的底图。 此值表示使用给定底图可视化要素的最佳符号颜色。 basemapTheme String optional 如果您有非 GeoScene 底图（例如具有自定义样式的 VectorTileLayer 底图）或根本没有底图，请使用此参数来指示可视化的背景是 light 或 dark。 可能值:"light"|"dark" geometryType String 将要素的几何类型可视化。 可能值:"point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch" numColors Number 在显性可视化中包含的唯一值的数量。 theme String optional 默认值: default 确定要返回的主要和次要配色方案集。 其值总为 "default"。 worldScale Boolean optional 表示方案的大小单位是否以米为单位。 当该方案旨在用于 3D 体积符号系统时，这应该是 true 。 如果此属性设置为 true ，则必须提供view 。 view SceneView optional 将在其中使用该方案的 SceneView 实例。 此属性仅适用于将方案与 3D 符号结合使用时。

返回：

类型	描述
PredominanceScheme[]	返回优势方案的数组，包括或不包括所提供的标记。

例子：

let schemes = predominanceSchemes.getSchemesByTag({
  includedTags: [ "types" ],
  basemap: map.basemap,
  geometryType: featureLayer.geometryType
});

getThemes(basemap){Theme[]}

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

详述：

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

返回：

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

类型定义

PredominanceScheme PredominanceSchemeForPoint|PredominanceSchemeForPolyline|PredominanceSchemeForPolygon|PredominanceSchemeForMesh

根据图层的几何类型定义用于可视化优势的符号系统方案。

PredominanceSchemeForMesh

定义用于可视化网格要素优势的符号系统方案的属性。

属性：

name String 方案的唯一名称。

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

colors Color[] 用于每个类别的网格符号的填充颜色。

noDataColor Color 用于表示没有数据的要素的填充符号的颜色。

opacity Number 符号的不透明度 (0 - 1)。

PredominanceSchemeForPoint

定义用于可视化点要素优势的符号系统方案的属性。

属性：

name String 方案的唯一名称。

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

colors Color[] 用于每个类别的点符号的填充颜色。

noDataColor Color 用于表示没有数据的要素的点符号的颜色。

outline Object 用于定义标记符号轮廓的属性。 详述： color Color 标记符号的轮廓颜色。 width Number 标记符号的宽度（以磅为单位）。

opacity Number 点符号的不透明度 (0 - 1)。

sizeScheme SizeSchemeForPoint 如果包含在优势可视化中，则定义大小视觉变量的方案。

PredominanceSchemeForPolygon

定义用于可视化多边形要素优势的符号系统方案的属性。

属性：

name String 方案的唯一名称。

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

colors Color[] 用于每个类别的多边形符号的填充颜色。

noDataColor Color 用于表示没有数据的要素的填充符号的颜色。

outline Object 用于定义填充符号轮廓的属性。 详述： color Color 填充符号的轮廓颜色。 width Number 填充符号轮廓的宽度（以像素或磅为单位）。

opacity Number 符号的不透明度 (0 - 1)。

sizeScheme SizeSchemeForPolygon 如果包含在优势可视化中，则定义大小视觉变量的方案。

PredominanceSchemeForPolyline

定义用于可视化折线要素优势的符号系统方案的属性。

属性:

name String 方案的唯一名称。

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

colors Color[] 用于每个类别的线符号的颜色。

noDataColor Color 用于表示没有数据的要素和超出范围的要素的线符号颜色。

width Number 线符号的默认宽度（以像素或磅为单位）。

opacity Number 线符号的不透明度 (0 - 1)。

sizeScheme SizeSchemeForPolyline 如果包含在优势可视化中，则定义大小视觉变量的方案。

PredominanceSchemes

getSchemes() 方法返回对象。

属性：

primaryScheme PredominanceScheme 最适合给定底图和几何类型的优势方案。

secondarySchemes PredominanceScheme[] 可用于可视化覆盖在给定底图上的给定几何类型的数据的其他优势方案。

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

basemapTheme String 表示平均底图颜色是 light 或 dark。