关系

方法概述

方法详述

cloneScheme(scheme){RelationshipScheme}

克隆一个关系(双色)计划对象。

参数：

scheme RelationshipScheme 计划对象克隆的关系。

返回：

类型	描述
RelationshipScheme	返回给定关系的克隆计划对象。

例如：

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

getSchemeByName(params){RelationshipScheme}

起始版本: 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" theme String optional 默认值: default 确定要返回的主要和次要配色方案集。 其值总为 "default"。 worldScale Boolean optional 表示方案的大小单位是否以米为单位。 当该方案旨在用于 3D 体积符号系统时，应是 true 。 如果此属性设置为 true ，则必须提供view 。 view SceneView optional 该场景视图构件实例将使用该方案中。此属性仅适用于在该计划期间，将与 3D 结合使用符号。

返回：

类型	描述
RelationshipScheme	返回具有给定名称的关系计划。

例子：

// Returns the Blueberry Parfait scheme
let blueberryScheme = relationshipSchemes.getSchemeByName({
  basemap: map.basemap,
  geometryType: featureLayer.geometryType,
  name: "Blueberry Parfait"
});

getSchemes(params){RelationshipSchemes}

返回定义图层中基于关系（二元等值线）数据驱动可视化的符号属性的主要方案和次要方案。 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" theme String optional 默认值: default 确定要返回的主要和次要配色方案集。 其值总为 "default"。 worldScale Boolean optional 表示方案的大小单位是否以米为单位。 当该方案旨在用于 3D 体积符号系统时，应为 true 。 如果此属性设置为 true ，则必须提供view 。 view SceneView optional 将在其中使用该方案的 SceneView 实例。 此属性仅适用于将方案与 3D 符号结合使用时。

返回：

类型	描述
RelationshipSchemes	返回包含用于给定底图的最佳关系配色方案的对象； 它还包含辅助方案。

例如：

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

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

getSchemesByTag(params){RelationshipScheme[]}

起始版本: 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" theme String optional 默认值: default 确定要返回的主要和次要配色方案集。 其值总为 "default"。 worldScale Boolean optional 表示方案的大小单位是否以米为单位。 当该方案旨在用于 3D 体积符号系统时，这应是 true 。 如果此属性设置为 true ，则必须提供view 。 view SceneView optional 将在其中使用该方案的 SceneView 实例。 此属性仅适用于将方案与 3D 符号结合使用时。

返回：

类型	描述
RelationshipScheme[]	返回包括或不包括提供的标签的关系方案数组。

例如：

let schemes = relationshipSchemes.getSchemesByTag({
  basemap: map.basemap,
  geometryType: featureLayer.geometryType,
  includedTags: [ "tritanopia" ],
  excludedTags: [ "grayscale" ]
});

getThemes(basemap){Theme[]}

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

参数：

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

返回：

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

类型定义

RelationshipScheme RelationshipSchemeForPoint|RelationshipSchemeForPolyline|RelationshipSchemeForPolygon|RelationshipSchemeForMesh

根据图层的几何类型定义用于可视化关系渲染器（二元颜色）的符号系统方案。

RelationshipSchemeForMesh

定义用于可视化网格要素的关系渲染器（双变量颜色）的符号系统方案的属性。

属性：

name String 该计划的唯一名称。

tags String[] 与计划相关联的标记。

id String ID 唯一地标识配色方案。

colorsForClassBreaks Object[] 定义要使用的颜色在每个关系的可视化。 详述： colors Color[][] 填充用于每个关系中的可视化符号的颜色。 numClasses Number 关系可视化中每个变量的中断数（行/列）。

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

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

RelationshipSchemeForPoint

定义用于可视化点要素的关系渲染器（双变量颜色）的符号系统方案的属性。

属性：

name String 该计划的唯一名称。

tags String[] 与计划相关联的标记。

id String ID 唯一地标识配色方案。

colorsForClassBreaks Object[] 定义要使用的颜色在每个关系的可视化。 详述： colors Color[][] 用于关系可视化中每个 bin 的点符号的填充颜色。 numClasses Number 关系可视化中每个变量的中断数（行/列）。

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

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

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

size Number 点符号的大小（以磅为单位）。

RelationshipSchemeForPolygon

定义用于可视化多边形要素的关系渲染器（双变量颜色）的符号系统方案的属性。

属性：

name String 方案的唯一名称。

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

id String 唯一标识配色方案的 ID。

colorsForClassBreaks Object[] 定义要在关系可视化的每个 bin 中使用的颜色。 详述： colors Color[][] 用于关系可视化中每个 bin 的填充符号的颜色。 numClasses Number 关系可视化中每个变量的中断数（行/列）。

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

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

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

RelationshipSchemeForPolyline

定义用于可视化折线要素的关系渲染器（二元颜色）的符号系统方案的属性。

属性：

name String 方案的唯一名称。

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

id String 唯一标识配色方案的 ID。

colorsForClassBreaks Object[] 定义要在关系可视化的每个 bin 中使用的颜色。 详述： colors Color[][] 用于关系可视化中每个 bin 的线符号的颜色。 numClasses Number 关系可视化中每个变量的中断数（行/列）。

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

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

width Number 线符号的宽度（以磅为单位）。

RelationshipSchemes

getSchemes() 方法返回对象。

属性：

primaryScheme RelationshipScheme 最适合给定底图和几何类型的关系方案。

secondarySchemes RelationshipScheme[] 可用于可视化覆盖在给定底图上的给定几何类型的数据的附加关系方案。

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

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