类型

AMD: require(["geoscene/smartMapping/symbology/type"], (typeSchemes) => { /* 代码 */ });
ESM: import * as typeSchemes from "@geoscene/core/smartMapping/symbology/type";
对象: geoscene/smartMapping/symbology/type
起始版本: GeoScene API for JavaScript 4.4

包含帮助方法的对象,用于获取用于创建唯一值或类型的数据驱动可视化的最佳符号主题。 getSchemes()  方法用于生成最适合给定底图的符号属性。

方法概述

名称 返回类型 总结 对象
TypeScheme更多信息

克隆一个 scheme 对象类型。

更多信息type
TypeScheme更多信息

返回具有所提供名称的一种方案。

更多信息type
TypeSchemes更多信息

返回定义图层中基于类型的数据驱动可视化的符号属性的主要方案和次要方案。

更多信息type
TypeScheme[]更多信息

使用提供的标记返回的数组类型计划。

更多信息type
Theme[]更多信息

返回可用主题的元数据。

更多信息type

方法详情

cloneScheme(scheme){TypeScheme}

克隆一个 scheme 对象类型。

参数:
scheme TypeScheme

计划要克隆的对象的类型。

返回:
类型 描述
TypeScheme 返回给定类型的克隆计划对象。
例子:
// clones the primary scheme returned from the getSchemes() method
let typeScheme = primaryScheme.clone();
getSchemeByName(params){TypeScheme}
起始版本: GeoScene API for JavaScript 4.12

返回具有所提供名称的一种方案。

参数:
规范:
params Object

有关可能传递给此函数的每个参数的详细信息,请参见下表。

详述:
name String

要检索的计划的名称。

basemap String|Basemap
optional

底图搭配可视化。 此值表示具有给定图的可视化功能的最佳象征颜色。

basemapTheme String
optional

如果您有非 GeoScene 底图(例如具有自定义样式的 VectorTileLayer 底图)或根本没有底图,请使用此参数表示可视化的背景是否为 lightdark

可能值:"light"|"dark"

geometryType String

几何要素可视化的类型。

可能值:"point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch"

theme String
optional
默认值: default

确定是否为点云类渲染器返回标准化的唯一值方案(即,当CLASS_CODE  字段驱动  PointCloudLayer 中的可视化时),或返回为非点云层生成的其他唯一值渲染器中使用的其他默认主方案 类型。

可能值:"point-cloud-class"|"default"

worldScale Boolean
optional

表示方案的大小单位是否以米为单位。 当该方案旨在用于 3D 体积符号系统时,这应是 true 。 如果此属性设置为 true ,则必须提供 view

view SceneView
optional

将在其中使用该方案的 SceneView 实例。 此属性仅适用于将方案与 3D 符号结合使用时。

返回:
类型 描述
TypeScheme 返回具有给定名称的类型计划。
例子:
// Returns the Pastel Dreams scheme
let galaxyBerriesScheme = typeSchemes.getSchemeByName({
  basemap: map.basemap,
  geometryType: featureLayer.geometryType,
  name: "Pastel Dreams"
});
getSchemes(params){TypeSchemes}

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

参数:
规范:
params Object

有关详细信息,请参阅下表的每个参数可以传递给此函数。

详述:
basemap String|Basemap
optional

与可视化配对的 GeoScene 底图。 此值表示用于根据给定底图可视化要素的最佳符号颜色。 如果您有非 GeoScene 底图(例如具有自定义样式的 VectorTileLayer 底图)或根本没有底图,则使用 basemapTheme 参数而不是此参数。

basemapTheme String
optional

如果您有非 GeoScene 底图(例如具有自定义样式的 VectorTileLayer 底图)或根本没有底图,请使用此参数表示可视化的背景是否为 lightdark

可能值:"light"|"dark"

geometryType String

要可视化的要素的几何类型。

可能值:"point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch"

theme String
optional
默认值: default

确定是否为点云类渲染器返回标准化的唯一值方案(即当 CLASS_CODE  字段驱动  PointCloudLayer 中的可视化时),或返回为非点云图层生成的其他唯一值渲染器中使用的其他默认主方案类型。

可能值:"point-cloud-class"|"default"

worldScale Boolean
optional

表示方案的大小单位是否以米为单位。 当该方案旨在用于 3D 体积符号系统时,这应该是 true 。 如果此属性设置为 true,则必须提供view

view SceneView
optional

将在其中使用该方案的 SceneView 实例。 此属性仅适用于将方案与 3D 符号结合使用时。

返回:
类型 描述
TypeSchemes 返回包含用于给定底图的最佳类型方案的对象; 它还包含辅助方案。
 例如
// gets the primary scheme for the features of the given geometry type and basemap
let schemes = typeSchemes.getSchemes({
  basemap: map.basemap,
  geometryType: featureLayer.geometryType
});

// the best default scheme for the layer and basemap
let primaryScheme = schemes.primaryScheme;
getSchemesByTag(params){TypeScheme[]}
起始版本: GeoScene API for JavaScript 4.12

返回带有提供的标签的类型方案数组。 这些方案为可使用  UniqueValueRenderer 渲染的任何图层中的数据驱动可视化定义符号属性。

参数:
规范:
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 底图)或根本没有底图,请使用此参数来表示可视化的背景是 lightdark

可能值:"light"|"dark"

geometryType String

几何要素可视化的类型。

可能值:"point"|"multipoint"|"polyline"|"polygon"|"mesh"|"multipatch"

theme String
optional
默认值: default

确定是否为点云类渲染器返回标准化的唯一值方案(即,当 CLASS_CODE  字段驱动 PointCloudLayer 中的可视化时),或返回为非点云图层生成的其他唯一值渲染器中使用的其他默认主方案类型。

可能值:"point-cloud-class"|"default"

worldScale Boolean
optional

表示方案的大小单位是否以米为单位。 当该方案旨在用于 3D 体积符号系统时,应是 true 。 如果此属性设置为 true ,则必须提供view

view SceneView
optional

将在其中使用该方案的 SceneView 实例。 此属性仅适用于将方案与 3D 符号结合使用时。

返回:
类型 描述
TypeScheme[] 返回一个类型方案数组,包括或不包括提供的标签。
例如:
// Returns all the red type schemes that are subdued
let schemes = typeSchemes.getSchemesByTag({
  basemap: map.basemap,
  geometryType: featureLayer.geometryType,
  includedTags: [ "types", "subdued" ]
});
getThemes(basemap){Theme[]}

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

参数:
basemap String|Basemap
optional

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

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

类型定义

定义用于可视化具有属性数据驱动类型的要素的符号系统方案的属性。

TypeSchemeForMesh

定义用于可视化由基于类型的属性数据驱动的网格要素的符号系统方案的属性。

属性:
name String

该计划的唯一名称。

tags String[]

与方案关联的标签。

colors Color[]

构成主题的符号的填充颜色。

noDataColor Color

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

opacity Number

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

TypeSchemeForPoint

定义用于可视化由基于类型的属性数据驱动的点要素的符号系统方案的属性。

属性:
name String

方案的唯一名称。

tags String[]

与方案关联的标签。

colors Color[]

构成主题的点符号的填充颜色。

noDataColor Color

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

outline Object

用于定义标记符号轮廓的属性。

详述:
color Color

标记符号的轮廓颜色。

width Number

标记符号的宽度(以像素或磅为单位)。

size Number

点符号的默认大小(以像素、点或实际单位为单位)。

opacity Number

点符号的不透明度。

TypeSchemeForPolygon

定义用于可视化由基于类型的属性数据驱动的面要素的符号系统方案的属性。

属性:
name String

方案的唯一名称。

tags String[]

与方案关联的标签。

colors Color[]

构成主题的符号的填充颜色。

noDataColor Color

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

outline Object

用于定义填充符号轮廓的属性。

详述:
color Color

填充符号的轮廓颜色。

width Number

填充符号轮廓的宽度(以像素或磅为单位)。

opacity Number

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

TypeSchemeForPolyline

定义用于可视化由基于类型的属性数据驱动的折线要素的符号系统方案的属性。

属性:
name String

该计划的唯一名称。

tags String[]

与计划相关联的标记。

colors Color[]

包括主题行符号的颜色。

noDataColor Color

线符号的颜色用于显示没有数据的特点和要素,它们超出范围。

width Number

以像素为单位或点线符号的默认宽度。

opacity Number

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

TypeSchemes

getSchemes() 方法返回对象。

属性:
primaryScheme TypeScheme

该计划类型最适合给定的底图和几何类型。

secondarySchemes TypeScheme[]

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

basemapId String

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

basemapTheme String

表示平均底图颜色是否为 lightdark

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.